Skip to main content
DELETE
Cancel a payout

Headers

x-api-key
string
required
Example:

"your-x-api-key"

x-api-token
string
required
Example:

"your-x-api-token"

Body

application/json
uuid
string<uuid>
required

Payout's UUID to be canceled

Maximum string length: 36
Example:

"83abc908-9233-4b66-b455-2339809886b1"

reason
string

Cancel reason (optional)

Maximum string length: 255
Example:

"Customer requested cancellation"

Response

Payout successfully canceled

status
number

Response status code

Example:

0

message
string

Response status message

Example:

"success"