API Reference
GuidesAPI ReferenceRoadmapGo to DashboardSite >

Create Bulk FX Conversion

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

Use the Bulk Currency Exchange API to efficiently convert funds between your own multi-currency accounts within the same country. This is ideal for businesses managing international operations to optimize their internal treasury.

Important

  • account.debited.amount: The amount to be deducted from the source account.
  • account.credited.amount: The amount to be added to the target account.
    The value of the provided field must be greater than 0.
💡

Want to lock an exchange rate before executing the transaction?

Use the Currency Exchange Quote API to generate a rate quote for the currency pair. The response includes an exchangeRateToken pass it in your FX conversion request to lock in that rate. The quoted rate is guaranteed until the token's expirationDate, protecting both you and your user from market fluctuations.

Body Params
string
required

The country where the payment will be processed.

string
required

A unique identifier generated by your system to track the transaction (alphanumeric and hyphens). We recommend using UUID4 to ensure uniqueness.

string
required

Token provided by the Foreign Exchange service to use an upfront agreed exchange rate

account
object
required

Object containing account details for the transaction.

Responses

Updated 3 months ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago