Commissions

Embed
Preview of the card
<a href="https://referalli.com/docs/ref-commissions"><img src="https://referalli.com/docs/_api/public/orgs/07f432f4-34b9-46a7-aaad-c0e395d2e4f9/spaces/2bf4f614-3630-4fbf-85f9-5ecafa6b7d97/pages/92911317-cb51-4edb-87bb-7f0f9a129893/social-card.svg?v=3e7ae33eec8b" alt="Commissions" width="600" height="315"></a>
GEThttps://referally.15.204.158.166.sslip.io/v1/commission-rules
GET /v1/commission-rules
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/commission-rules"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/commission-rules', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/commission-rules",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/commission-rules", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/commission-rules');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/commission-rules')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/commission-rules"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 A page of the list. Under referally-version 2026-10-21 the body is the plain array instead.
Example
{
  "object": "string",
  "data": [
    {
      "id": "string",
      "programId": "string",
      "version": 0,
      "config": {},
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}
Schema
objectstringrequired
dataCommissionRule[]required
Show child parameters
idstringrequired
programIdstringrequired
versionintegerrequired
configobjectrequired
createdAtstringrequired
has_morebooleanrequired
Whether another page follows; pass next_cursor as starting_after to get it.
next_cursorstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/v1/commission-rules
Publish a new commission rule version
Request body application/json
programIdstringrequired
configobjectrequired
Show child parameters
baseobjectrequired
appliesTostring
gross | net_of_tax | net_of_fees = gross
recurringobject
= {"type":"lifetime"}
holdDaysinteger
= 30
roundingstring
half_even | floor = half_even
conditionsobject
Show child parameters
countriesstring[]
excludeCountriesstring[]
metadataobject[]
overridesobject[]
= []
Show child parameters
matchobjectrequired
baseobjectrequired
tiersobject[]
Show child parameters
minCustomersintegerrequired
bpsintegerrequired
bountiesobject[]
Show child parameters
eventstringrequired
amountMinorintegerrequired
currencystringrequired
subAffiliateobject
Show child parameters
levelsintegerrequired
ratesBpsinteger[]required
newVsExpansionobject
Show child parameters
newBpsintegerrequired
expansionBpsintegerrequired
{
  "programId": "string",
  "config": {
    "base": {
      "kind": "string",
      "bps": 0
    },
    "appliesTo": "gross",
    "recurring": {
      "type": "lifetime"
    },
    "holdDays": 30,
    "rounding": "half_even",
    "conditions": {
      "countries": [
        "string"
      ],
      "excludeCountries": [
        "string"
      ],
      "metadata": [
        {
          "key": null,
          "equals": null,
          "in": null
        }
      ]
    },
    "overrides": [],
    "tiers": [
      {
        "minCustomers": 0,
        "bps": 0
      }
    ],
    "bounties": [
      {
        "event": "string",
        "amountMinor": 0,
        "currency": "string"
      }
    ],
    "subAffiliate": {
      "levels": 0,
      "ratesBps": [
        0
      ]
    },
    "newVsExpansion": {
      "newBps": 0,
      "expansionBps": 0
    }
  }
}
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/commission-rules" \
  -H "Content-Type: application/json" \
  -d '{"programId":"string","config":{"base":{"kind":"string","bps":0},"appliesTo":"gross","recurring":{"type":"lifetime"},"holdDays":30,"rounding":"half_even","conditions":{"countries":["string"],"excludeCountries":["string"],"metadata":[{"key":null,"equals":null,"in":null}]},"overrides":[],"tiers":[{"minCustomers":0,"bps":0}],"bounties":[{"event":"string","amountMinor":0,"currency":"string"}],"subAffiliate":{"levels":0,"ratesBps":[0]},"newVsExpansion":{"newBps":0,"expansionBps":0}}}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/commission-rules', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"programId":"string","config":{"base":{"kind":"string","bps":0},"appliesTo":"gross","recurring":{"type":"lifetime"},"holdDays":30,"rounding":"half_even","conditions":{"countries":["string"],"excludeCountries":["string"],"metadata":[{"key":null,"equals":null,"in":null}]},"overrides":[],"tiers":[{"minCustomers":0,"bps":0}],"bounties":[{"event":"string","amountMinor":0,"currency":"string"}],"subAffiliate":{"levels":0,"ratesBps":[0]},"newVsExpansion":{"newBps":0,"expansionBps":0}}}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/commission-rules",
    headers={
    "Content-Type": "application/json",
    },
    json={"programId": "string", "config": {"base": {"kind": "string", "bps": 0}, "appliesTo": "gross", "recurring": {"type": "lifetime"}, "holdDays": 30, "rounding": "half_even", "conditions": {"countries": ["string"], "excludeCountries": ["string"], "metadata": [{"key": None, "equals": None, "in": None}]}, "overrides": [], "tiers": [{"minCustomers": 0, "bps": 0}], "bounties": [{"event": "string", "amountMinor": 0, "currency": "string"}], "subAffiliate": {"levels": 0, "ratesBps": [0]}, "newVsExpansion": {"newBps": 0, "expansionBps": 0}}},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/commission-rules", strings.NewReader(`{"programId":"string","config":{"base":{"kind":"string","bps":0},"appliesTo":"gross","recurring":{"type":"lifetime"},"holdDays":30,"rounding":"half_even","conditions":{"countries":["string"],"excludeCountries":["string"],"metadata":[{"key":null,"equals":null,"in":null}]},"overrides":[],"tiers":[{"minCustomers":0,"bps":0}],"bounties":[{"event":"string","amountMinor":0,"currency":"string"}],"subAffiliate":{"levels":0,"ratesBps":[0]},"newVsExpansion":{"newBps":0,"expansionBps":0}}}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/commission-rules');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"programId":"string","config":{"base":{"kind":"string","bps":0},"appliesTo":"gross","recurring":{"type":"lifetime"},"holdDays":30,"rounding":"half_even","conditions":{"countries":["string"],"excludeCountries":["string"],"metadata":[{"key":null,"equals":null,"in":null}]},"overrides":[],"tiers":[{"minCustomers":0,"bps":0}],"bounties":[{"event":"string","amountMinor":0,"currency":"string"}],"subAffiliate":{"levels":0,"ratesBps":[0]},"newVsExpansion":{"newBps":0,"expansionBps":0}}}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/commission-rules')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"programId":"string","config":{"base":{"kind":"string","bps":0},"appliesTo":"gross","recurring":{"type":"lifetime"},"holdDays":30,"rounding":"half_even","conditions":{"countries":["string"],"excludeCountries":["string"],"metadata":[{"key":null,"equals":null,"in":null}]},"overrides":[],"tiers":[{"minCustomers":0,"bps":0}],"bounties":[{"event":"string","amountMinor":0,"currency":"string"}],"subAffiliate":{"levels":0,"ratesBps":[0]},"newVsExpansion":{"newBps":0,"expansionBps":0}}}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/commission-rules"))
    .header("Content-Type", "application/json")
    .method("POST", BodyPublishers.ofString("{\"programId\":\"string\",\"config\":{\"base\":{\"kind\":\"string\",\"bps\":0},\"appliesTo\":\"gross\",\"recurring\":{\"type\":\"lifetime\"},\"holdDays\":30,\"rounding\":\"half_even\",\"conditions\":{\"countries\":[\"string\"],\"excludeCountries\":[\"string\"],\"metadata\":[{\"key\":null,\"equals\":null,\"in\":null}]},\"overrides\":[],\"tiers\":[{\"minCustomers\":0,\"bps\":0}],\"bounties\":[{\"event\":\"string\",\"amountMinor\":0,\"currency\":\"string\"}],\"subAffiliate\":{\"levels\":0,\"ratesBps\":[0]},\"newVsExpansion\":{\"newBps\":0,\"expansionBps\":0}}}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "id": "string",
  "programId": "string",
  "version": 0,
  "config": {}
}
Schema
idstringrequired
programIdstringrequired
versionintegerrequired
configobjectrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/commissions
Commission ledger events
Parameters
partnerIdstringquery
programIdstringquery
typestringquery
earned | adjusted | reversed | approved | paid
referralIdstringquery
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/commissions?partnerId=&programId=&type=&referralId="
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/commissions?partnerId=&programId=&type=&referralId=', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/commissions?partnerId=&programId=&type=&referralId=",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/commissions?partnerId=&programId=&type=&referralId=", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/commissions?partnerId=&programId=&type=&referralId=');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/commissions?partnerId=&programId=&type=&referralId=')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/commissions?partnerId=&programId=&type=&referralId="))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 A page of the list. Under referally-version 2026-10-21 the body is the plain array instead.
Example
{
  "object": "string",
  "data": [
    {
      "id": "string",
      "programId": "string",
      "partnerId": "string",
      "referralId": "string",
      "type": "earned",
      "amountMinor": 0,
      "currency": "string",
      "relatedCommissionId": "string",
      "holdUntil": "2024-01-01T00:00:00Z",
      "level": 0,
      "memo": "string",
      "settlementMethod": "string",
      "settlementReference": "string",
      "ts": "2024-01-01T00:00:00Z"
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}
Schema
objectstringrequired
dataCommissionEvent[]required
Show child parameters
idstringrequired
programIdstringrequired
partnerIdstringrequired
referralIdstringrequired
typestringrequired
earned | approved | paid | reversed | adjusted
amountMinorintegerrequired
Integer minor units (cents).
currencystringrequired
relatedCommissionIdstringrequired
holdUntilstringrequired
levelintegerrequired
memostringrequired
settlementMethodstring
Set on paid events the merchant settled itself (store_credit).
settlementReferencestring
tsstringrequired
has_morebooleanrequired
Whether another page follows; pass next_cursor as starting_after to get it.
next_cursorstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/commissions/{id}
GET /v1/commissions/{id}
Parameters
idstringpathrequired
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/commissions/{id}"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/commissions/{id}', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/commissions/{id}",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/commissions/{id}", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/commissions/{id}');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/commissions/{id}')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/commissions/{id}"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "id": "string",
  "programId": "string",
  "partnerId": "string",
  "referralId": "string",
  "type": "earned",
  "amountMinor": 0,
  "currency": "string",
  "relatedCommissionId": "string",
  "holdUntil": "2024-01-01T00:00:00Z",
  "level": 0,
  "memo": "string",
  "settlementMethod": "string",
  "settlementReference": "string",
  "ts": "2024-01-01T00:00:00Z",
  "billingEventId": "string",
  "netMinor": 0,
  "state": "pending",
  "events": [
    {
      "id": "string",
      "programId": "string",
      "partnerId": "string",
      "referralId": "string",
      "type": "earned",
      "amountMinor": 0,
      "currency": "string",
      "relatedCommissionId": "string",
      "holdUntil": "2024-01-01T00:00:00Z",
      "level": 0,
      "memo": "string",
      "settlementMethod": "string",
      "settlementReference": "string",
      "ts": "2024-01-01T00:00:00Z"
    }
  ]
}
Schema
idstringrequired
programIdstringrequired
partnerIdstringrequired
referralIdstringrequired
typestringrequired
earned | approved | paid | reversed | adjusted
amountMinorintegerrequired
Integer minor units (cents).
currencystringrequired
relatedCommissionIdstringrequired
holdUntilstringrequired
levelintegerrequired
memostringrequired
settlementMethodstring
Set on paid events the merchant settled itself (store_credit).
settlementReferencestring
tsstringrequired
billingEventIdstring
netMinorinteger
Integer minor units (cents).
statestring
pending | approved | paid
eventsCommissionEvent[]
Show child parameters
idstringrequired
programIdstringrequired
partnerIdstringrequired
referralIdstringrequired
typestringrequired
earned | approved | paid | reversed | adjusted
amountMinorintegerrequired
Integer minor units (cents).
currencystringrequired
relatedCommissionIdstringrequired
holdUntilstringrequired
levelintegerrequired
memostringrequired
settlementMethodstring
Set on paid events the merchant settled itself (store_credit).
settlementReferencestring
tsstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/partners/{id}/balances
Partner balances (pending/approved/paid)
Parameters
idstringpathrequired
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/partners/{id}/balances"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/partners/{id}/balances', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/partners/{id}/balances",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/partners/{id}/balances", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/partners/{id}/balances');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/partners/{id}/balances')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/partners/{id}/balances"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 A page of the list. Under referally-version 2026-10-21 the body is the plain array instead.
Example
{
  "object": "string",
  "data": [
    {
      "currency": "string",
      "pending": 0,
      "approved": 0,
      "paid": 0,
      "reversed": 0
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}
Schema
objectstringrequired
dataBalance[]required
Show child parameters
currencystringrequired
pendingintegerrequired
Integer minor units (cents).
approvedintegerrequired
Integer minor units (cents).
paidintegerrequired
Integer minor units (cents).
reversedintegerrequired
Integer minor units (cents).
has_morebooleanrequired
Whether another page follows; pass next_cursor as starting_after to get it.
next_cursorstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/v1/commissions/approve-due
Approve lines whose hold elapsed
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/commissions/approve-due"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/commissions/approve-due', {
  method: 'POST',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/commissions/approve-due",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/commissions/approve-due", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/commissions/approve-due');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/commissions/approve-due')
req = Net::HTTP::Post.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/commissions/approve-due"))
    .method("POST", BodyPublishers.noBody())
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "approved": 0
}
Schema
approvedintegerrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/v1/commissions/{id}/adjust
Correct a commission line (refuses to go below zero unless allowNegative)
Parameters
idstringpathrequired
Request body application/json
amountMinorintegerrequired
memostringrequired
allowNegativeboolean
= false
{
  "amountMinor": 0,
  "memo": "string",
  "allowNegative": false
}
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/commissions/{id}/adjust" \
  -H "Content-Type: application/json" \
  -d '{"amountMinor":0,"memo":"string","allowNegative":false}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/commissions/{id}/adjust', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"amountMinor":0,"memo":"string","allowNegative":false}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/commissions/{id}/adjust",
    headers={
    "Content-Type": "application/json",
    },
    json={"amountMinor": 0, "memo": "string", "allowNegative": False},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/commissions/{id}/adjust", strings.NewReader(`{"amountMinor":0,"memo":"string","allowNegative":false}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/commissions/{id}/adjust');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"amountMinor":0,"memo":"string","allowNegative":false}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/commissions/{id}/adjust')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"amountMinor":0,"memo":"string","allowNegative":false}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/commissions/{id}/adjust"))
    .header("Content-Type", "application/json")
    .method("POST", BodyPublishers.ofString("{\"amountMinor\":0,\"memo\":\"string\",\"allowNegative\":false}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "id": "string"
}
Schema
idstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/v1/commissions/{id}/settle
Settle a line the merchant paid itself (store credit)
Parameters
idstringpathrequired
Request body application/json
methodstring
= store_credit
referencestringrequired
memostring
{
  "method": "store_credit",
  "reference": "string",
  "memo": "string"
}
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/commissions/{id}/settle" \
  -H "Content-Type: application/json" \
  -d '{"method":"store_credit","reference":"string","memo":"string"}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/commissions/{id}/settle', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"method":"store_credit","reference":"string","memo":"string"}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/commissions/{id}/settle",
    headers={
    "Content-Type": "application/json",
    },
    json={"method": "store_credit", "reference": "string", "memo": "string"},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/commissions/{id}/settle", strings.NewReader(`{"method":"store_credit","reference":"string","memo":"string"}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/commissions/{id}/settle');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"method":"store_credit","reference":"string","memo":"string"}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/commissions/{id}/settle')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"method":"store_credit","reference":"string","memo":"string"}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/commissions/{id}/settle"))
    .header("Content-Type", "application/json")
    .method("POST", BodyPublishers.ofString("{\"method\":\"store_credit\",\"reference\":\"string\",\"memo\":\"string\"}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "commissionId": "string",
  "paidEventId": "string",
  "partnerId": "string",
  "programId": "string",
  "amountMinor": 0,
  "currency": "string",
  "method": "store_credit",
  "reference": "string",
  "status": "string"
}
Schema
commissionIdstringrequired
paidEventIdstringrequired
partnerIdstringrequired
programIdstringrequired
amountMinorintegerrequired
Integer minor units (cents).
currencystringrequired
methodstringrequired
store_credit | merchant_credit
referencestringrequired
statusstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
Updated