Endpoints

https://api.ebanx.com/ws/payout/simulate

https://sandbox.ebanx.com/ws/payout/simulate

HTTP Method

POST

Response

JSON

This method allows you to simulate a payout.

Request parameters

integration_key

string, length 100, required

Your unique and secret integration key.

country

string, length 2, required

The two-letter country code for the customer country. The available codes are:

  • br: Brazil.
  • cl: Chile.
  • co: Colombia.
  • mx: Mexico.
  • pe: Peru.

amount

float, required

The amount in the specified currency (currency_code). E.g.: 100.50

currency_code

string, length 3, ISO 4217, required

Three-letter code of the payout currency. Supported currencies:

  • Brazil: BRL, EUR, USD, GBP.
  • Chile: CLP, EUR, USD, GBP.
  • Colombia: COP, EUR, USD, GBP.
  • Mexico: MXN, EUR, USD, GBP.
  • Peru: PEN, EUR, USD, GBP.

This method call will return a JSON object with the payout amounts data.

Response parameters

type

string

The type of the response (success, api_error, authentication_error, invalid_request_error, or request_error).

payout

JSON

A JSON object with the payout amounts data.

payout.request_amount

float

The amount in the original request currency.

payout.request_currency

string, length 3, ISO 4217 three letter code

Three-letter code of the original request currency.

payout.request_exchange_rate

float

The exchange rate used in the payout to calculate the debited amount.

payout.debit_amount

float

The amount that would be debited in your account referring this payout.

payout.debit_fee

float

The fee amount of the payout.

payout.debit_amount_total

float

The total amount that would be debited in your account referring the payout and fee.

payout.debit_currency

string, length 3, ISO 4217 three letter code

Three-letter code of the debit amount currency.