Skip to content
Currency Exchange

Get Exchangeable Balances

Returns the amount available for currency exchange in each currency of the current account. The currency exchange page shows it as the “cash available” or “maximum available” amount for each source currency in the currency picker, and uses it as the upper limit of the source amount. list may contain multiple currencies; the Broker App selects the entry by currency.

Each currency has two figures: available_amount covers cash only; available_amount_with_mmf also includes the money market fund (MMF) portion that can be redeemed automatically. Use the latter only when the Broker enables automatic MMF redemption for currency exchange (submissions then use POST /v1/forex/reserve/convert); fall back to available_amount when it is missing. The difference between the two is the amount that MMF redemption can cover.

GEThttps://api.lbkrs.com/v1/forex/conver/available

Parameters

account_channelstringqueryRequired

Broker channel

currencystringqueryRequired

Source currency, such as HKD

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get Exchangeable Balances” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>

Exchangeable amounts by currency

Child attributes
currencystring

Currency

available_amountstring

Exchangeable cash amount, excluding the MMF

available_amount_with_mmfstring

Maximum exchangeable amount, including cash and the MMF portion that can be redeemed automatically

Whale Docs