Skip to main content
POST
Request Payout

Authorizations

Authorization
string
header
required

Authenticate with a customer token, minted server-to-server with POST /v1/shops/{shopId}/customers/{customerId}/token and sent as a Bearer token. Reseller API keys are rejected with a 403 here.

Body

application/json
amount
number
required

Amount in USD. Must be at least the shop's minimum payout amount and no more than the affiliate balance.

Example:

25

payout_details
string
required

How the seller should pay out, for example a PayPal address or wallet address. Max 2000 characters.

Example:

"PayPal: affiliate@example.com"

Response

success
boolean
Example:

true

message
string
Example:

"Payout requested. The seller has been notified."