Retrieve commission

curl --request GET \
  --url https://staging.api.rye.com/api/v1/commissions/{id} \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://staging.api.rye.com/api/v1/commissions/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://staging.api.rye.com/api/v1/commissions/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://staging.api.rye.com/api/v1/commissions/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://staging.api.rye.com/api/v1/commissions/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "updatedAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "ryeFee": {
    "currencyCode": "USD",
    "amountSubunits": 1500
  },
  "developerCommission": {
    "currencyCode": "USD",
    "amountSubunits": 1500
  },
  "settlementDirection": "rye_owes_developer",
  "status": "pending",
  "type": "surcharge",
  "checkoutIntentId": "<string>",
  "id": "<string>",
  "finalizedAt": "2023-11-07T05:31:56Z"
}

{
  "name": "<string>",
  "message": "<string>",
  "stack": "<string>"
}

{
  "name": "<string>",
  "message": "<string>",
  "stack": "<string>"
}

GET

api

commissions

{id}

Retrieve commission

curl --request GET \
  --url https://staging.api.rye.com/api/v1/commissions/{id} \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://staging.api.rye.com/api/v1/commissions/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://staging.api.rye.com/api/v1/commissions/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://staging.api.rye.com/api/v1/commissions/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://staging.api.rye.com/api/v1/commissions/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "updatedAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "ryeFee": {
    "currencyCode": "USD",
    "amountSubunits": 1500
  },
  "developerCommission": {
    "currencyCode": "USD",
    "amountSubunits": 1500
  },
  "settlementDirection": "rye_owes_developer",
  "status": "pending",
  "type": "surcharge",
  "checkoutIntentId": "<string>",
  "id": "<string>",
  "finalizedAt": "2023-11-07T05:31:56Z"
}

{
  "name": "<string>",
  "message": "<string>",
  "stack": "<string>"
}

{
  "name": "<string>",
  "message": "<string>",
  "stack": "<string>"
}

Authorizations

Authorization

string

header

required

Rye API key

Path Parameters

string

required

The id of the commission to look up

Response

Commission details

A commission earned (or owed) on a completed checkout intent.

updatedAt

string<date-time>

required

Time the commission last changed (e.g. status transition).

createdAt

string<date-time>

required

Time the commission was first recorded.

ryeFee

object

required

Fee retained by Rye.

Show child attributes

developerCommission

object

required

Commission amount paid to the developer.

Show child attributes

settlementDirection

enum<string>

required

Whether Rye owes the developer or vice versa once settled.

Available options:

rye_owes_developer,

developer_owes_rye

status

enum<string>

required

Lifecycle status, e.g. pending, finalized, refunded.

Available options:

pending,

confirmed,

updated,

finalized,

refunded,

expired

type

enum<string>

required

Kind of commission, e.g. surcharge, discount_code, affiliate.

Available options:

surcharge,

promo_arbitrage,

discount_code,

affiliate,

out_of_band

checkoutIntentId

string

required

The checkout intent this commission was generated from.

string

required

Unique identifier for this commission.

finalizedAt

string<date-time>

Time the commission moved to a terminal status. Unset until finalized.

Universal Checkout API

Tools

Testing

Webhooks

API Reference

Help

Retrieve commission

Authorizations

Path Parameters

Response