Internal Transfers & FX - API
How to move funds between accounts of the same currency and execute currency exchanges via the Lorum API.
Internal transfers move funds between two accounts of the same currency within Lorum. Currency exchanges convert funds between two accounts holding different currencies.
Internal Transfers
Creating an Internal Transfer
Move funds between two accounts of the same currency via Create Internal Transfer
POST /v1/accounts/{account_id}/transfers.
All
POSTrequests to create transfers must include anIdempotency-Keyheader. See Understanding Idempotency for details.
| Field | Type | Required | Description |
|---|---|---|---|
to_account_id | uuid | ✅ | The destination account |
amount | integer | ✅ | Amount in minor currency units (e.g. 100 = 1.00) |
reference | string | ✅ | Your reference for the transfer |
external_id | string | ❌ | Your own unique ID for the transfer |
Webhooks are sent as the transfer progresses. See Webhook Catalogue for the full list of transfer events.
Currency Exchange (FX)
Getting an Exchange Quote
Get a real-time quote for a currency exchange via Get Exchange Quote
GET /v1/exchange/quote.
| Field | Type | Required | Description |
|---|---|---|---|
sell_currency | string | ✅ | ISO currency code of the currency to sell |
buy_currency | string | ✅ | ISO currency code of the currency to buy |
sell_amount | integer | ❌ | Amount to sell in minor currency units. Required if buy_amount is not provided |
buy_amount | integer | ❌ | Amount to buy in minor currency units. Required if sell_amount is not provided |
The quote response includes a quote_id that must be passed when creating the exchange.
Creating a Currency Exchange
Execute a currency exchange between two accounts via Create Exchange
POST /v1/exchange.
All
POSTrequests to create exchanges must include anIdempotency-Keyheader. See Understanding Idempotency for details.
| Field | Type | Required | Description |
|---|---|---|---|
from_account_id | uuid | ✅ | The account to sell from |
to_account_id | uuid | ✅ | The account to buy into |
quote_id | uuid | ✅ | The quote ID returned from the Get Exchange Quote endpoint |
external_id | string | ❌ | Your own unique ID for the exchange |
Webhooks are sent as the exchange progresses. See Webhook Catalogue for the full list of exchange events.
Updated 4 days ago
What’s Next
Track your transfers and exchanges as they move through their lifecycle.