Quote

Allows to get an exchange quote and a token that can be used for a subsequent transaction of the same type.

The FX rate is updated every 60 seconds by default. If you need a different configuration, please request a custom frecuency to our team.

The exchange rate token can be configured to have a lifetime of between 1 minute and up to 1 day. The expiration is to request a transaction within that time range, once the transaction has been created with the exchange rate token, the quoted FX will appear in the payment and also the payments will have their own, unrelated expiration time with the expiration of the exchange rate token.

FX transactions are only available between the local currency and a hard currency, or vice versa. For example, USD to BRL or BRL to AUS.

The hard currencies available for realizing an FX are listed below:

• AUD - Australian dollar

• CAD - Canadian dollar

• CHF - Swiss franc

• EUR - Euro

• GBP - Pound Sterling

• NZD - New Zealand dollar

• USD - United States dollar

If you need a hard currency that isn't on the list or want to verify if there is foreign exchange between two hard currencies available in a country, please contact your account manager or our support team.

Bulk Currency Exchange Quote

GET {{api_environment_url}/api/fx/currency-exchange/:type

This endpoint allows you to get FX quotes.

Path Parameters

Name	Type	Description
type*	string	Mandatory. Add the transaction type: currencyExchange

Query Parameters

Name	Type	Description
sourceCurrency*	string	Mandatory. The currency that you use to fund a currency conversion
quoteCurrency*	string	Mandatory. The quote currency which is the second currency appearing in a currency pair quotation
accountNumber*	string	Mandatory. The Localpayment account which you are working with
quoteAccountNumber*	string	Mandatory. The Localpayment account which you are working with

Headers

Name	Type	Description
Authorization*	string	Mandatory. Bearer JWT token in format Bearer eyJ0... . For more information about authentication, please refer to Authentication

200 Ok

{
  "exchangeRateToken": "af5606b0-1ce7-48f8-ad8a-734934c601ec",
  "transactionType": "CurrencyExchange",
  "accountNumber": "111.111.11111111",
  "sourceCurrency": "EUR",
  "creationDate": "2023-03-22T13:40:09.9995054+00:00",
  "expirationDate": "2023-03-22T13:41:09.9995054+00:00",
  "quotes": [
    {
      "paymentMethodCode": null,
      "rate": 0.862450,
      "quoteCurrency": "USD"
    }
  ]
}

404: Not Found Error

{
    "Status": 404,
    "Message": "This account doesn't have a PayOut configuration for this",
    "TraceId": "4fc5b601-9902-4c9e-8b73-bdaa8aa76838"
}

401 Error

{
    "detail": "Given token not valid for any token type",
    "code": "token_not_valid",
    "messages": [
        {
            "token_class": "AccessToken",
            "token_type": "access",
            "message": "Token is invalid or expired"
        }
    ]
}

Example

Request

curl --location '{{api_environment_url}/api/fx/currency-exchange/currencyExchange?sourceCurrency=EUR&quoteCurrency=USD&accountNumber=111.111.11111111&quoteAccountNumber=000.000.00000000' \
--header 'Authorization: Bearer {{token}}'

Status Ok

{
  "exchangeRateToken": "af5606b0-1ce7-48f8-ad8a-734934c601ec",
  "transactionType": "CurrencyExchange",
  "accountNumber": "111.111.11111111",
  "sourceCurrency": "EUR",
  "creationDate": "2023-03-22T13:40:09.9995054+00:00",
  "expirationDate": "2023-03-22T13:41:09.9995054+00:00",
  "quotes": [
    {
      "paymentMethodCode": null,
      "rate": 0.862450,
      "quoteCurrency": "USD"
    }
  ]
}

Bad request

{
    "Status": 404,
    "Message": "This account doesn't have a PayOut configuration for this",
    "TraceId": "4fc5b601-9902-4c9e-8b73-bdaa8aa76838"
}