cancel operation
This page's content:
Endpoints
https://api.ebanxpay.com/ws/payout/cancel
https://sandbox.ebanxpay.com/ws/payout/cancel
HTTP Method
POST
Response
JSON
This method allows you to cancel a payout. The payout has to be in a status equal to OP
and within the cancellation time.
Request parameters
integration_key
string, length 100, required
Your unique and secret integration key.
external_reference
string, length 6-40, optional*
The unique payout ID provided by you.
uid
string, 50 length, optional*
The payout uid (EBANX unique identifier).
* You have to send either the external_reference or the uid
This method call will return a JSON object with the cancel operation result.
Response parameters
type
string
The type of the response (success
, api_error
, authentication_error
, invalid_request_error
, or request_error
).
message
string
The response message.