APIPay Out endpointsPayouts

Cancel payout

Cancel a payout transaction by ID.

Authentication

requestTokenstring
API Key authentication via header

Path parameters

referenceIdstringRequired
The ID for the payout transaction.

Response

Success
responseTextstring

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

isSuccessboolean or null

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

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