Endpoints

https://api.ebanx.com/ws/documentbalance

https://sandbox.ebanx.com/ws/documentbalance

HTTP Method

GET

Response

JSON

This is a server-to-server HTTP GET used by the merchant to check the customer’s balance in USD. According to Brazil’s Federal law, brazilian customers can spend up to 3000 USD per month in internacional transactions. This operation retrieves the amount available that the customer still has, and the amount used within the current month.

Method parameters

integration_key

string, length 100, required

Your unique and secret integration key.

document

string, length 11, required

The customer’s CPF document or the company’s CNPJ.

currency_code

string, length 3, ISO 4217

The code of the currency (ISO 4217 3 letter code).

Response parameters

status

string

The status of the the request (SUCCESS or ERROR).

document_balance.document

string, length 14

The customer’s CPF or the company’s CNPJ.

document_balance.balance

float

The customer’s spent amount in the current month.

document_balance.available

float

The customer’s available amount the can still be spent in the current month.

document_balance.currency_code

string, length 3, ISO 4217

The code of the currency (ISO 4217 3 letter code).