Skip to content
Account Transfers

Submit Cash Transfer

Moves cash between a Client's main account and sub-account, or between a cash account and a margin account. A successful response means the server accepted the request and created transfer_no. The final result is the status returned by GET /v1/app/risk_event_api/query_cash_transfer_tickets.

Before submitting, call GET /v1/app/risk_event_api/query_cash_transfer_balance to make sure the amount does not exceed max_transfer_balance, call GET /v1/app/risk_event_api/is_over_transfer_limit to make sure no limit is exceeded, and ask the Client to confirm the source account, destination account, and amount. On failure, show message to the Client. If you cannot tell whether the request was accepted, query the transfer records first and resubmit only when no matching record exists.

When calling through WhaleCore requestService(), set requiresTradeToken to true.

POSThttps://api.lbkrs.com/v1/app/rms_gateway/omnibus_cash_transfer

Request body application/json

from_aaidintegerrequired

aaid of the source account

to_aaidintegerrequired

aaid of the destination account

currencystringrequired

Transfer currency, such as HKD

transfer_amountstringrequired

Transfer amount as a decimal string. Must be greater than 0

transfer_typeintegerrequired

Transfer direction:

  • 0 - Sub-account to main account
  • 1 - Main account to sub-account
  • 2 - Cash account to margin account
  • 3 - Margin account to cash account
Values
0
1
2
3
is_enable_dynamic_calculate_modebooleanrequired

Whether to enable dynamic calculation mode. Send true for main account and sub-account transfers, and false for cash account and margin account transfers

operation_typestringrequired

Operation source. The Broker App always sends app

ledger_timeintegerrequired

Submission time as a Unix timestamp in milliseconds

ref_nostringrequired

Unique request number that the Broker App generates for each submission, such as a UUID

Responses

HTTP 200The request succeeded. The response body contains the result of the “Submit Cash Transfer” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
transfer_nostring

Transfer number, used to query the result

Whale Docs