Skip to main content
POST
Cancel Payout Request

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.

Path Parameters

payoutRequestId
integer
required

The payout request ID.

Response

success
boolean
Example:

true

message
string
Example:

"Payout request cancelled. The amount has been returned to your affiliate balance."