Consult Balance

About this guide

This guide quickly demonstrates how to consult your balance available for payouts in EBANX. We will walk you through the basic steps to achieve this goal using your already existing Direct API integration.

How it works

1. Consult a payout using the /ws/payout/balance end-point

   To consult your available balance, you will use the /ws/payout/balance endpoint.

   Your integration key is the only required parameter.

   curl -X POST 'https://sandbox.ebanxpay.com/ws/payout/balance' \

   -d 'integration_key=your_test_integration_key'

   And a successful call will return a JSON Object with type "success" and your available balance.

   {

   "type": "success",

   "currency_code": "USD",

   "balance": 150

   }

   It is possible to query whether there is a balance for a different currency_code:

   curl -X POST 'https://sandbox.ebanxpay.com/ws/payout/balance' \

   -d 'integration_key=your_test_integration_key' \

   -d 'currency_code=BRL'
   {

   "type": "success",

   "currency_code": "BRL",

   "balance": 490

   }

   And, also, look up the consolidated balance of the previous days (only CrossBorder environment, actually):

   curl -X POST 'https://sandbox.ebanxpay.com/ws/payout/balance' \

   -d 'integration_key=your_test_integration_key' \

   -d 'date=2020-01-02'
   {

   "type": "success",

   "currency_code": "USD",

   "date": "2020-01-02",

   "balance": 291

   }

   look up the consolidated balance of the previous days by currency_code:

   curl -X POST 'https://sandbox.ebanxpay.com/ws/payout/balance' \

   -d 'integration_key=your_test_integration_key' \

   -d 'currency_code=ARS' \

   -d 'date=2020-01-02'
   {

   "type": "success",

   "currency_code": "ARS",

   "date": "2020-01-02",

   "balance": 2000

   }

Balance Error Codes

This page contains the codes of errors that may occur when you create a payout.

How it works

When an API call fails, EBANX will return a JSON object containing the error details as the example below:

{

"type":"invalid_request_error",

"message":"Invalid currency code",

"status_code":"HP-BA-01",

"code":"HP-BA-01"

}

Observe the following table and verify the codes and error messages that EBANX uses.

Code	Message
HP-BA-01	Invalid currency code
HP-BA-02	Invalid date

Consulting Balance via Dashboard

You can also consult your available balance through your Dashboard in the Overview section of the Payout tab.

Getting help

We hope this article was enlightening, but in case we’ve failed to take out your doubts you have the following options to keep on seeking for answers:

• If you’re not our partner yet and would like to know more about our prices and conditions please fill our this form and our commercial team will get in touch with you.
• In case you’re already our partner please get in touch with our support team at integration@ebanx.com.