Skip to main content
POST
cURL

Authorizations

X-API-KEY
string
header
required

Query Parameters

promoter_email
string<email>
required

required if promoter_id is null

Email of the promoter

promoter_id
string

required if promoter_email is null

Id of the promoter to assign the payout

status
enum<string>

The payout status

Available options:
pending,
processing,
completed
campaign_id
string

For what campaign to create the payout. If it is null, we'll take the promoter's default

Response

Success response

id
integer
Example:

2710287

status
string
Example:

"pending"

amount
integer
Example:

3000

date_paid
string<date-time> | null
Example:

null

due_date
string<date-time>
Example:

"2024-10-11T00:00:00.000Z"

unit
string
Example:

"cash"

created_at
string<date-time>
Example:

"2024-09-12T14:02:53.135Z"

has_issues
boolean
Example:

false

reward
object | null
Example:

null

promoter
object
campaign
object