API referencePay Out endpointsPayouts

Cancel list of payouts

Cancels an array of payout transactions.

Authentication

requestTokenstring
API Key authentication via header

Request

Array of identifiers of payout transactions to cancel.

Response

Success
isSuccessbooleanOptional

Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.

pageIdentifierstringOptional
Auxiliary validation used internally by payment pages and components.
responseCodeintegerOptional

Code for the response. Learn more in API Response Codes.

responseDatalist of objectsOptional
Array of objects describing the transactions.
responseTextstringOptional

Response text for operation: ‘Success’ or ‘Declined’.

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error
503
Service Unavailable Error