This page's content:

Endpoints

https://api.ebanxpay.com/ws/fxtoken/get

https://sandbox.ebanxpay.com/ws/fxtoken/get

HTTP Method

POST

Response

JSON

This is a server-to-server operation that retrieves a token to be used in fixed exchange rate operations.

The integration team should be contacted to enable it upon request to use this feature.

Method parameters

integration_key string, max. 100, required

Your unique and secret integration key.

country string, Length: 2, required

The two-letter code for the country where the operation is being processed. The available codes are:

  • br: Brazil.
  • pe: Peru.
  • mx: Mexico.
  • co: Colombia.
  • cl: Chile.
  • ar: Argentina.
  • bo: Bolivia.
currency_from string, lenght 3, Format: ISO 4217 three letter code, required

The three-letter currency code from which the amount will be converted. Supported currencies:

  • EUR
  • USD
currency_to string, lenght 3, Format: ISO 4217 three letter code, required

The three-letter currency code to which the amount will be converted. Supported currencies:

  • BRL
  • MXN
  • PEN
  • CLP
  • COP
  • ARS
  • BOB

This method call will return a JSON object with the token data:

Response parameters

fx_token string, Max: 100

The token identifier that must be used in operations with the fixed exchange rate.

currency_rate float

The fixed exchange rate that will be used in operations where this token is provided.

currency_from string, lenght 3, Format: ISO 4217 three letter code

The same three-letter code provided in the request

currency_to string, lenght 3, Format: ISO 4217 three letter code

The same three-letter code provided in the request

expire_date string, length 25, UTC Date

The date in which the token will become invalid.

new_currency_rate_available_at string, length 25, UTC Date

The date on which the next token will become available. A new token will always be available at least one hour before the expire_date of the previous token. During this period both new and old tokens will be valid.