Transfer Balance

This guide quickly demonstrates how to transfer balance from your settlement to your payouts 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. Transfer balance using the /ws/transfer/create end-point

   To transfer balance, you will use the /ws/transfer/create endpoint.

   The following fields are required:

   Field	Description
   external_reference	The unique identifier you provide to the transfer
   amount	Amount you wish to transfer
   source	Source of the amount. This value must be payment_balance
   currency_code	Three-letter code of the country currency, ex: BRL (Brazil)

   The following example shows how to create a transfer using the payment balance from your settlement:

   curl -X POST 'https://sandbox.ebanxpay.com/ws/transfer/create' \
       -d 'integration_key=your_test_integration_key' \
       -d 'external_reference=PAYOUT_TRANSFER_02' \
       -d 'amount=150' \
       -d 'source=payment_balance',
       -d 'currency_code=BRL'

   And a successful creation will return a JSON Object with type "success" and a payout object with all the details of the newly created Transfer.

   {
      "type": "success",
       "transfer": {
           "uid": "1b76c24acc3f09806abf072dc0a3b37f1d69fa829",
           "external_reference": "T1_BRL_424239784",
           "status": "OP",
           "request_date": "2022-11-29 12:44:35",
           "confirm_date": null,
           "cancel_date": null,
           "requested_amount": "150.00",
           "amount": "150.00",
           "currency_code": "BRL",
           "settlement_code": null,
           "source": "payment_balance"
       }
   }

Transferring Balance via Dashboard

You can also transfer to your available balance through your Dashboard in the Overview section of the Payout tab. Click on the Add Balance option and choose the amount you want to transfer from the amount available from your settlement.

Transfer Balance via Deposits

If you want to add funds to your EBANX Payout Balance via bank transfer, please, contact us via this email address: merchants@ebanx.com

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.