Skip to main content
POST
PHP

Authorizations

Authorization
string
header
required

Default authentication mechanism

Body

application/json
type
enum<string>
required
Available options:
custom
partnerId
string
required

The ID of the partner to create the commission for.

amount
number
required

The commission earnings amount in cents. Use a negative amount to create a clawback.

date
string | null

If not provided, the current date will be used.

description
string | null

The description of the commission. Required for clawbacks (negative amount). May be a known clawback reason (order_canceled, fraud, terms_violation, tracking_error, payment_failed, ineligible_partner, duplicate_commission) or an arbitrary string (max 190 characters).

Maximum string length: 190

Response

The request was accepted and commission creation was queued.

success
boolean
required
message
string
required