APIPay Out endpointsPayouts

Cancel payout (deprecated)

Deprecated
View as MarkdownOpen in Claude
Cancel a payout transaction by ID.

Authentication

requestTokenstring

Long-lived API token sent in the requestToken header. See API token authentication.

OR
AuthorizationBearer

OAuth2 Bearer access token from the client-credentials flow. See OAuth authentication.

Path parameters

referenceIdstringRequired
The ID for the payout transaction.

Response

Success
responseTextstring

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

isSuccessboolean

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

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

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

responseDataobject

Response data for canceling a single payout transaction. Mirrors the general response data, with VendorId added alongside CustomerId.

Errors

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