API referencePay 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
isSuccessboolean

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

responseTextstring

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

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

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

responseDataobject

Errors

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