Commissions

Create One-off Commission

Creates a one-off commission for a partner that is not tied to a referral or a campaign. Use this for bonuses, manual corrections or any commission you want to award outside of the automatic tracking. The amount is in cents and in your account’s preferred currency; it is converted to the partner’s preferred currency for payout. The partner must have an accepted partnership with your program. The commission is created as pending unless you pass state: paid, in which case it is recorded as already paid out. The optional one_off_reason is shown to your team in the Reditus dashboard and returned in the one_off_reason attribute.

POST

commissions

curl --request POST \
  --url https://api.getreditus.com/api/v1/commissions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "partner_id": "5f4b1c2e-9b7a-4e3d-8c1a-2b3c4d5e6f70",
  "amount": 1400,
  "state": "pending",
  "one_off_reason": "Q3 bonus"
}
'

import requests

url = "https://api.getreditus.com/api/v1/commissions"

payload = {
    "partner_id": "5f4b1c2e-9b7a-4e3d-8c1a-2b3c4d5e6f70",
    "amount": 1400,
    "state": "pending",
    "one_off_reason": "Q3 bonus"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    partner_id: '5f4b1c2e-9b7a-4e3d-8c1a-2b3c4d5e6f70',
    amount: 1400,
    state: 'pending',
    one_off_reason: 'Q3 bonus'
  })
};

fetch('https://api.getreditus.com/api/v1/commissions', 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://api.getreditus.com/api/v1/commissions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'partner_id' => '5f4b1c2e-9b7a-4e3d-8c1a-2b3c4d5e6f70',
    'amount' => 1400,
    'state' => 'pending',
    'one_off_reason' => 'Q3 bonus'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.getreditus.com/api/v1/commissions"

	payload := strings.NewReader("{\n  \"partner_id\": \"5f4b1c2e-9b7a-4e3d-8c1a-2b3c4d5e6f70\",\n  \"amount\": 1400,\n  \"state\": \"pending\",\n  \"one_off_reason\": \"Q3 bonus\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.getreditus.com/api/v1/commissions")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"partner_id\": \"5f4b1c2e-9b7a-4e3d-8c1a-2b3c4d5e6f70\",\n  \"amount\": 1400,\n  \"state\": \"pending\",\n  \"one_off_reason\": \"Q3 bonus\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getreditus.com/api/v1/commissions")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"partner_id\": \"5f4b1c2e-9b7a-4e3d-8c1a-2b3c4d5e6f70\",\n  \"amount\": 1400,\n  \"state\": \"pending\",\n  \"one_off_reason\": \"Q3 bonus\"\n}"

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

{
  "data": {
    "id": "<string>",
    "type": "<string>",
    "attributes": {
      "state": "<string>",
      "amount": 123,
      "currency": "<string>",
      "partner_id": "<string>",
      "referral_id": "<string>",
      "reject_reason": "<string>",
      "one_off_reason": "<string>",
      "state_set_at": 123,
      "paid_at": 123,
      "created_at": 123,
      "updated_at": 123
    }
  }
}

{
  "errors": [
    {
      "title": "Bad Request",
      "details": "Validation failed: Amount must be greater than 0"
    }
  ]
}

{
  "errors": [
    {
      "title": "Not Found",
      "details": "Commission not found, or partner not found or partnership is not accepted"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

partner_id

string

required

required - Reditus id of the partner receiving the commission. The partner must have an accepted partnership with your program.

Example:

"5f4b1c2e-9b7a-4e3d-8c1a-2b3c4d5e6f70"

amount

integer

required

required - Commission amount in cents, in your account's preferred currency (e.g. 1400 = $14.00). Must be a positive integer.

Example:

1400

state

enum<string>

default:pending

State to create the commission in. Use paid when the commission was already paid out to the partner outside of Reditus.

Available options:

pending,

paid

one_off_reason

string

Optional free-text reason for the one-off commission, e.g. a bonus or a manual correction.

Example:

"Q3 bonus"

Response

Commission was created

data

object

Show child attributes

Create One-off Commission

curl --request POST \
  --url https://api.getreditus.com/api/v1/commissions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "partner_id": "5f4b1c2e-9b7a-4e3d-8c1a-2b3c4d5e6f70",
  "amount": 1400,
  "state": "pending",
  "one_off_reason": "Q3 bonus"
}
'

import requests

url = "https://api.getreditus.com/api/v1/commissions"

payload = {
    "partner_id": "5f4b1c2e-9b7a-4e3d-8c1a-2b3c4d5e6f70",
    "amount": 1400,
    "state": "pending",
    "one_off_reason": "Q3 bonus"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    partner_id: '5f4b1c2e-9b7a-4e3d-8c1a-2b3c4d5e6f70',
    amount: 1400,
    state: 'pending',
    one_off_reason: 'Q3 bonus'
  })
};

fetch('https://api.getreditus.com/api/v1/commissions', 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://api.getreditus.com/api/v1/commissions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'partner_id' => '5f4b1c2e-9b7a-4e3d-8c1a-2b3c4d5e6f70',
    'amount' => 1400,
    'state' => 'pending',
    'one_off_reason' => 'Q3 bonus'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.getreditus.com/api/v1/commissions"

	payload := strings.NewReader("{\n  \"partner_id\": \"5f4b1c2e-9b7a-4e3d-8c1a-2b3c4d5e6f70\",\n  \"amount\": 1400,\n  \"state\": \"pending\",\n  \"one_off_reason\": \"Q3 bonus\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.getreditus.com/api/v1/commissions")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"partner_id\": \"5f4b1c2e-9b7a-4e3d-8c1a-2b3c4d5e6f70\",\n  \"amount\": 1400,\n  \"state\": \"pending\",\n  \"one_off_reason\": \"Q3 bonus\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getreditus.com/api/v1/commissions")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"partner_id\": \"5f4b1c2e-9b7a-4e3d-8c1a-2b3c4d5e6f70\",\n  \"amount\": 1400,\n  \"state\": \"pending\",\n  \"one_off_reason\": \"Q3 bonus\"\n}"

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

{
  "data": {
    "id": "<string>",
    "type": "<string>",
    "attributes": {
      "state": "<string>",
      "amount": 123,
      "currency": "<string>",
      "partner_id": "<string>",
      "referral_id": "<string>",
      "reject_reason": "<string>",
      "one_off_reason": "<string>",
      "state_set_at": 123,
      "paid_at": 123,
      "created_at": 123,
      "updated_at": 123
    }
  }
}

{
  "errors": [
    {
      "title": "Bad Request",
      "details": "Validation failed: Amount must be greater than 0"
    }
  ]
}

{
  "errors": [
    {
      "title": "Not Found",
      "details": "Commission not found, or partner not found or partnership is not accepted"
    }
  ]
}

Affiliate Program API

Affiliates

Partnerships

Referrals

Commissions

Payments

Tracking V2

Refunds

Subscriptions

Tracking V1 (Deprecating)

Create One-off Commission

Authorizations

Body

Response