Bulk

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

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 amount is expressed.
accountNumber*	String	Mandatory. Account number from
amount*	String	Mandatory. Amount to charge to your end user
credited*	OBJECT	Mandatory. Information related to credited account number
accountNumber*	String	Mandatory. Account number to.

200: OK OK

{
    "transactionType": "CurrencyExchange",
    "externalId": "",
    "internalId": "X11111XX-11X1-111X-X11X-111111X1X1XX",
    "country": "ARG",
    "currency": "ARS",
    "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

Request

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

Status Ok

{
  "transactionType": "CurrencyExchange",
  "externalId": "11112222",
  "internalId": "e60d4fee-d75f-4bbe-a3b3-06e07a975c3b",
  "country": "ARG",
  "currency": "EUR",
  "exchangeRateToken": "",
  "clientCode": "0001",
  "creationDate": "2023-03-22T13:30:54.892+00:00",
  "errors": [],
  "status": {
    "code": "200",
    "description": "COMPLETED",
    "detail": "CURRENCY EXCHANGE"
  },
  "account": {
    "debited": {
      "currency": "EUR",
      "accountNumber": "111.1111.11111111",
      "amount": 10
    },
    "credited": {
      "currency": "USD",
      "accountNumber": "000.000.00000000",
      "amount": 8.62
    },
    "appliedFx": 0.86
  }
}

Bad request

{
  "externalId": "11112222",
  "internalId": "6fc7e955-7704-4558-8a05-6f4a2c3d9b45",
  "errors": [
    {
      "code": "705",
      "detail": "Credited account currency not match"
    }
  ],
  "status": {
    "code": "705",
    "description": "REJECTED",
    "detail": "Credited account currency not match"
  }
}

Example: Including the token obtained in a previous quote

Request

curl --location '{{api_environment_url}}/api/currency-exchange' \
--header 'Authorization: Bearer {{token}}' \
--header 'Content-Type: application/json' \
--data '{
  "country": "ARG",
  "currency": "EUR",
  "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"
    }
  }
}'

Status Ok

{
  "transactionType": "CurrencyExchange",
  "externalId": "111111",
  "internalId": "12bb1070-dfec-45bf-89b1-c45fbfa3b141",
  "country": "ARG",
  "currency": "ARS",
  "exchangeRateToken": "af5606b0-1ce7-48f8-ad8a-734934c601ec",
  "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.000.00000000",
      "amount": 0.18
    },
    "appliedFx": 224.54
  }
}

Bad request

{
  "externalId": "111111",
  "internalId": "12bb1070-dfec-45bf-89b1-c45fbfa3b141",
  "errors": [
    {
      "code": "703",
      "detail": "Accounts countries must be match"
    }
  ],
  "status": {
    "code": "703",
    "description": "REJECTED",
    "detail": "Accounts countries must be match"
  }
}