Skip to main content
POST
Transfer Affiliate Balance

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 not exceed the affiliate balance.

Example:

25

Response

success
boolean
Example:

true

message
string
Example:

"Balance transferred."