Bulk

Transaction of money of two different currencies between accounts of the same customer in the same country.

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.

Exchange - Bulk

POST https://api.stage.localpayment.com/currency-exchange

Transaction of money of two different currencies between accounts of the same customer in the same country

Headers

Name
Type
Description

Atorization*

String

Mandatory. JWT token in format Bearer eyJ0... . For more information about authentication, please refer to Authentication

Request Body

Name
Type
Description

country*

String

Mandatory. Your from user's country (i.e. country in which the payment will be processed), in ISO format. Please refer to Country Codes for a full list of supported countries

externalId*

String

Mandatory. An ID that is meaningful to you and your system. Must be unique

exchangeRateToken*

String

Mandatory. Token provided by the Foreign Exchange service in order to use an upfront agreed exchange rate

account*

OBJECT

Mandatory. Information related to account numbers to transfer

debited*

OBJECT

Mandatory. Information related to debited account number.

currency*

String

Mandatory. The currency in which the debited amount is expressed.

accountNumber*

String

Mandatory. Account number from.

amount*

String

Mandatory. Amount to be charged to you. This parameter must be set to 0 if the account.credited.amount field is greater than 0.

credited*

OBJECT

Mandatory. Information related to the credited account number.

currency*

String

Mandatory. The currency in which the credited amount is expressed.

accountNumber*

String

Mandatory. Account number to.

amount

String

Optional. Amount to credit to your end user.

Important

  • The fields account.debited.amount and account.credited.amount are mutually exclusive. Only one of them needs to be reported, and it's value must be greater than 0.

  • If you send account.credited.amount the account.debited.amount will default to zero ("amount":0).

  • Conversely, if you send account.debited.amount, the account.credited.amount may not be included in the request.

{
    "transactionType": "CurrencyExchange",
    "externalId": "",
    "internalId": "X11111XX-11X1-111X-X11X-111111X1X1XX",
    "country": "ARG",
    "exchangeRateToken": "",
    "clientCode": "0005",
    "creationDate": "2023-03-21T21:25:14.533+00:00",
    "errors": [],
    "status": {
        "code": "200",
        "description": "COMPLETED",
        "detail": "CURRENCY EXCHANGE"
    },
    "account": {
        "debited": {
            "currency": "ARS",
            "accountNumber": "111.111.11111111",
            "amount": 40
        },
        "credited": {
            "currency": "EUR",
            "accountNumber": "000.111.11111111",
            "amount": 0.18
        },
        "appliedFx": 224.54
    }
}

Example: Without requesting a quote

curl --location '{{api_environment_url}}/api/currency-exchange' \
--header 'Authorization: Bearer {{token}}' \
--header 'Content-Type: application/json' \
--data '{
  "country": "ARG",
  "externalId": "11112222",
  "exchangeRateToken": "",
  "account": {
    "debited": {
      "currency": "EUR",
      "accountNumber": "111.1111.11111111",
      "amount": 10
    },
    "credited": {
      "currency": "USD",
      "accountNumber": "000.000.00000000"
    }
  }
}'

Example: Including the token obtained in a previous quote 

curl --location '{{api_environment_url}}/api/currency-exchange' \
--header 'Authorization: Bearer {{token}}' \
--header 'Content-Type: application/json' \
--data '{
  "country": "ARG",
  "externalId": "11112222",
  "exchangeRateToken": "af5606b0-1ce7-48f8-ad8a-734934c601ec",
  "account": {
    "debited": {
      "currency": "EUR",
      "accountNumber": "111.111.11111111",
      "amount": 10
    },
    "credited": {
      "currency": "USD",
      "accountNumber": "000.000.00000000"
    }
  }
}'

Example: Providing the credited amount

curl --location '{{api_environment_url}}/api/currency-exchange' \
--header 'Authorization: Bearer {{token}}' \
--header 'Content-Type: application/json' \
--data '{
{
    "country": "ARG",
    "externalId": "{{externalId}}",
    "exchangeRateToken": "",
    "account": {
        "debited": {
            "currency": "ARS",
            "accountNumber": "111.111.1111111",
            "amount": 0
        },
        "credited": {
            "currency": "USD",
            "accountNumber": "000.000.00000000",
            "amount": 10
        }
    }
  }
}'
PreviousQuoteNextCurrency exchange - Front end

Last updated

Was this helpful?