Skip to content
Deposit Instructions

Get Deposit Instructions

Queries the deposit instruction configuration by receiving region, currency, remitting bank, and transfer method. Returns what the Client needs to transfer funds to the securities account: the receiving bank name, receiving account name, receiving account number, receiving bank address, FPS receiving account, and supported currencies. Used to show the receiving account on the deposit instructions page so the Client can copy the details and make the transfer at their bank.

Also used for transfer verification during account opening: the verification page calls this operation with the remitting bank and currency the Client selected, passing 0 for bank_opeartion_type_id and 1 for rule, then picks the online banking transfer (3) and FPS (8) entries from deposit_configs by bank_operation_id. When the account opening deposit request is submitted, the id of the selected entry is submitted as the deposit configuration id.

An empty deposit_configs means no deposit method is available for the combination. The Broker App should ask the Client to choose another currency or remitting bank.

GEThttps://api.lbkrs.com/v1/portfolio/deposit/config

Parameters

regionstringqueryRequired

Receiving region, such as HONGKONG (Hong Kong) or USA (United States)

currencystringqueryRequired

Deposit currency, such as HKD or USD

bank_idstringquery

Id of the Client's remitting bank. When provided, only configurations that apply to that bank are returned

bank_opeartion_type_idstringquery

Transfer method id, using the same values as bank_operation_id in the response. For transfer verification during account opening, pass 0 and filter the results by bank_operation_id. Note that the parameter name is spelled bank_opeartion_type_id

rulestringquery

Configuration matching rule. For transfer verification during account opening, pass 1

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get Deposit Instructions” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
deposit_configsarray<object>

Deposit configurations

Child attributes
idinteger

Deposit configuration id. Submitted as the deposit configuration id with the account opening deposit request

bank_operation_idinteger

Transfer method id. Common values: 3 online banking transfer (local), 4 online banking transfer (wire), 5 bank-securities transfer, 6 sub-account, 7 eDDA, 8 FPS, 20 cheque, 21 ATM or counter transfer, 23 PayNow (Singapore)

lb_bank_namestring

Receiving bank name

lb_account_namestring

Receiving account name

lb_bank_accountstring

Receiving bank account number

lb_bank_addrstring

Receiving bank address. Returned for transfer methods that need a bank address, such as wire transfers

fps_accountstring

FPS receiving account (FPS identifier). Only populated when bank_operation_id is 8

currenciesarray<string>

Currencies supported by this deposit method

Whale Docs