Skip to main content

Cancel a Payout

This guide quickly demonstrates how to cancel an open payout in EBANX. We will walk you through the basic steps to achieve this goal using your already existing Direct API integration.

Instructions​

Follow the steps below:

  1. Confirm the payout status is OP

    You can only cancel a payout if its status is OP (Open). To verify the status, use the /ws/payout/retrieve endpoint. For full details on how to use this endpoint, see the Payout Retrieval Documentation.

  2. Cancel the payment

    To cancel a Payout, you will use the /ws/payout/cancel endpoint.

    There are two options you can use to cancel a Payout, the EBANX unique identifier (uid), which is generated during the creation of the payout, or the unique identifier provided by the Merchant (external_reference).

    Here are a couple of examples using each parameter:

    curl -X POST 'https://sandbox.ebanxpay.com/ws/payout/cancel' \
        -d 'integration_key=your_test_integration_key' \
        -d 'uid=0f28f5b2bf60536d78b2dbf003c13886dd452d926'

    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 Payout!"
    }

Canceling a Payout via Dashboard​

You can cancel a Payout, up to 6 hours after being submitted, through your Dashboard in the Payouts section of the Payout tab. Select the specific payout you want to cancel and click on Cancel Payout.

Still need help?

Help Image

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