API referencePay Out endpointsPayouts

Cancel payout

Cancel a payout transaction by ID.

Path parameters

referenceIdstringRequired
The ID for the payout transaction.

Headers

requestTokenstringRequired

Response

Success
isSuccessboolean or null

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

responseTextstring or null

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

pageIdentifierstring or null
Auxiliary validation used internally by payment pages and components.
responseCodeinteger or null

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

responseDataobject or null

Errors