Cancel a Transfer

To cancel a Transfer, you will use the /ws/transfer/cancel endpoint.

There are 4 options you can use to consult single a Transferyout, the EBANX unique identifier (uid), which is generated during the creation of the payout, the unique identifier provided by the Merchant (external_reference), the transfer code from the Wire Transfer method (transfer_code) or the Settlement Code from Payment Balance method (settlement_code).

Here are a few of examples using each parameter:

uid

curl -X POST 'https://sandbox.ebanx.com/ws/transfer/cancel' \
--header 'Content-Type: application/json' \
--data '{
  "integration_key": "your_ebanx_integration_key",
  "uid": "11ce3097af9ccf601b11038767962d3feded348ed"
}'

external_reference

curl -X POST 'https://sandbox.ebanx.com/ws/transfer/cancel' \
--header 'Content-Type: application/json' \
--data '{
  "integration_key": "your_ebanx_integration_key",
  "external_reference": "PAYOUT_TRANSFER_01"
}'

transfer_code

curl -X POST 'https://sandbox.ebanx.com/ws/transfer/cancel' \
--header 'Content-Type: application/json' \
--data '{
  "integration_key": "your_ebanx_integration_key",
  "transfer_code": "14-2000"
}'

settlement_code

curl -X POST 'https://sandbox.ebanx.com/ws/transfer/cancel' \
--header 'Content-Type: application/json' \
--data '{
  "integration_key": "your_ebanx_integration_key",
  "settlement_code": "14-2001"
}'

And a successful cancellation will return a JSON Object with type "success" and a message saying "You've successfully cancelled your Payout!".

{
  "type": "success",
  "message": "You've successfully cancelled your Transfer!"
}

Still need help?

We hope this article was helpful. If you still have questions, you can explore the following options:

• Merchant support: Contact our support team at sales.engineering@ebanx.com for assistance.
• Not a partner yet? Please complete the Merchant Signup Form, and our commercial team will reach out to you.