Skip to content
Client Notification

Exchange V2

Exchanges V2.

Request parameters

  • Required: aaid (Account ID), exchange_books (Exchange Books), exchange_books.from_currency (From Currency), exchange_books.to_currency (To Currency)
  • Optional: exchange_books.from_amount (From Amount), exchange_books.to_amount (To Amount)
  • See each field for its format, allowed values, and business meaning.

Result

On success, the endpoint completes the operation. See the 200 response schema for returned data and subsequent state information.

POSThttps://b-api.lbkrs.com/v1/risk_monitoring/exchange_v2

Production: https://b-api.lbkrs.com · Test: https://b-api.longbridge.xyz

Authorization

AuthorizationstringheaderRequired

Send the Broker ACCESS_TOKEN as Authorization: Bearer <token>.

Permission

margin_call.risk_debt_info

The Broker ACCESS_TOKEN must be granted the permission below, or the call will be rejected.

Request body application/json

aaidnumberrequired

Account ID. Programmatically derived by the client from the selected record's record.aaid_val; not a form-editable field.

exchange_booksarray<string>required

Exchange Books. Array of dynamic FX rows; multiple exchange records can be added. See the sub-fields of exchange_books (from_currency, etc.) for each row's structure.

exchange_books.from_currencystringrequired

From Currency. Currency dropdown populated from currencies held in the client's cash ledger.

exchange_books.to_currencystringrequired

To Currency. A dropdown; options come from global_currency_which_support_exchange.

exchange_books.from_amountstring

From Amount. Submit either from_amount or to_amount: the field the user edited last is kept, while the other is computed from the exchange rate and dropped by the client.

exchange_books.to_amountstring

To Amount. Same as from_amount; the two are mutually exclusive and only one is submitted.

Responses

HTTP 200The request was processed successfully. The response data does not contain additional business fields.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 400Bad request. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 401The user is not authenticated, or the login session has expired.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 403The current account is not authorized to use this feature. Grant the required permission to the account in User Permission.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 408The request timed out. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

Whale Docs