Skip to main content
POST
/
v1
/
payouts
Create
curl --request POST \
  --url https://{defaultHost}/v1/payouts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "payout": {
    "affiliation": "88798435-e3c2-4734-a610-2c736589e246",
    "end_date": "2026-01-07 22:02:10 UTC"
  }
}
'
{
  "id": "98978e95-e98c-4326-a12e-ca66f625c15f",
  "object": "payout",
  "currency": "usd",
  "description": null,
  "end_date": 1767744000,
  "live_mode": true,
  "manual": false,
  "payout_email": null,
  "status": "processing",
  "total_commission_amount": 9900,
  "affiliation": "88798435-e3c2-4734-a610-2c736589e246",
  "payout_group": null,
  "created_at": 1767909730,
  "updated_at": 1767909730
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
payout
object

Response

200 - application/json

Success

​
id
string | null

The UUID of the specific object.

​
object
string

A string describing the object type returned.

​
description
string | null

An optional brief description of what this payout is for.

​
end_date
integer

All approved referrals through this day will be included in the payout.

​
live_mode
boolean

Set to true if this payout is in live mode, and set to false if it is in test mode.

​
manual
boolean

Whether or not this payout was created manually or automatically from approved referrals.

​
total_commission_amount
integer

The amount in cents that will be paid out to the affiliate. For manual payouts, this is set directly. For automatic payouts, this is calculated from the sum of approved referrals.

​
currency
string

Three-letter ISO currency code, in lowercase. If not set, this value will fallback to the default Account currency.

​
status
string

The status of the payout – one of completed or processing.

​
affiliation

Expandable – The associated affiliation ID.

​
payout_group

Expandable – The associated payout group ID.

​
payout_email
string | null

The affiliate's payout email address.

​
referrals

Expandable – Property not returned unless expanded.

​
created_at
integer | null

Time at which the object was created. Measured in seconds since the Unix epoch.

​
updated_at
integer | null

Time at which the object was last updated. Measured in seconds since the Unix epoch.