Skip to content
Exchange Order

Manual Exchange

Manually perform a foreign-exchange conversion from the source currency to the target currency. Provide either amount (by source) or target_amount (by target).

Request parameters

  • Required: from (source currency), to (target currency)
  • Optional: amount (source amount), target_amount (target amount), account_channel (account channel), aaid (account AAID), origin (origin), ref_no (reference number)
  • See the field definitions for each field's format, allowed values, and business meaning.

Business notes

The conversion actually changes the account's currency balances; confirm the currencies, amount, and account.

Risk warning

This operation may change real funds, positions, or transaction state. Confirm the target record and parameters before calling.

Returns

On success returns the conversion result; see the 200 response for field definitions.

POSThttps://b-api.lbkrs.com/forex/manual_convert

Authorization

AuthorizationstringheaderRequired

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

Permission

b2b_withdraw.user_forex_orderlb_hk_conversion.userexchangebill_query

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

Request body application/json

fromstringrequired

From currency. Specifies From currency. This field is required.

tostringrequired

To currency. Specifies To currency. This field is required.

amountstring

Source amount. Specifies Source amount.

target_amountstring

Target amount. Specifies Target amount.

aaidintegerrequired

Account aaid. Specifies Account aaid.

Pass the internal numeric ID of the customer's securities account (aaid), not the securities account number account_no (such as H00000000) or the customer ID member_id. One customer can have multiple aaid values.

originintegerrequired

Origin. Specifies Origin.

manual_ratestring

Manually specified exchange rate

manual_modestring

Manual conversion mode; options come from a backend data dictionary

manual_rulestring

Manual conversion rule; omitted by the caller when its value is 0

channel_namestring

Conversion channel name; options come from a backend data dictionary

service_strategystring

Service strategy; options come from a backend data dictionary

audit_frontend_resourceobject

Audit context attached by the caller

Responses

HTTP 200The request was processed successfully. data is the result.
Standard response envelopecodemessagedata
dataobjectdata structure
okboolean

Whether succeeded. Specifies Whether succeeded.

idinteger

Convert record id. Specifies Convert record id.

in_serviceboolean

Whether in service hours. Specifies Whether in service hours.

deal_timestring

Deal time. Specifies Deal time.

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