simulate operation
This page's content:
Endpoints
https://api.ebanxpay.com/ws/payout/simulate
https://sandbox.ebanxpay.com/ws/payout/simulate
HTTP Method
POST
Response
JSON
This method allows you to simulate a payout.
Request parameters
Your unique and secret integration key.
The two-letter country code for the customer country. The available codes are:
- br: Brazil.
- cl: Chile.
- co: Colombia.
- mx: Mexico.
- pe: Peru.
The amount in the specified currency (currency_code
). E.g.,: 100.50
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
The type of the response (success
, api_error
, authentication_error
, invalid_request_error
, or request_error
).
A JSON object with the payout amounts data.
The amount in the original request currency.
Three-letter code of the original request currency.
The exchange rate used in the payout to calculate the debited amount.
The amount that would be debited to your account referring this payout.
The fee amount of the payout.
The total amount that would be debited to your account referring the payout and fee.
Three-letter code for the debit amount currency.