Manual Transfer-out Apply

Submits a manual transfer-out (securities withdrawal) application for a customer, moving holdings out to an external receiving broker.

Request parameters

Required: aaid (asset account ID), member_id (member/customer ID), from (source flag), params.name_en (receiving broker name), params.code (CCASS / DTC code), params.name (account name), params.account_channel (account channel), params.stocks (withdrawal detail list) and its items counter_id (security counter ID), is_reality (whether physical stock), custodian (custodian number), sub_position_no (sub-position number), amount (total holding quantity)
Optional: params.broker_id (transfer-in broker), params.account (account number), params.broker (broker name), item-level street_amount/nominee_amount/own_amount, market, name_en (security English name), code (security code)
See the field descriptions for the format, value range, and business meaning of each field.

Business notes

Each security line specifies the withdrawal quantity and custody information. After submission the application enters the subsequent withdrawal review workflow.

Risk warning

This operation creates a live transfer-out application and affects the customer's holdings and trading state. Confirm the customer, receiving broker, and each security line before calling.

Result

On success, the manual transfer-out application is created. The resulting state and returned data follow the 200 response definition.

POSThttps://b-api.lbkrs.com/admin/transfer/out/apply

Authorization

AuthorizationstringheaderRequired

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

Permission

atm.admin_transfer_out_applyb2b_atm.admin_transfer_out_apply

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

Request body application/json

aaidstringrequired

Asset Account ID. Asset Account ID associated with this request.

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.

member_idstringrequired

Member ID. Member ID associated with this request.

member_id is the customer ID. It differs from the securities account number account_no and the internal securities account ID aaid; one customer can have multiple securities accounts.

fromstringrequired

Source Flag. Always sends 'bo' (back office).

paramsobjectrequired

Transfer-out request parameters. Include the receiving broker, account details, and securities to transfer out.

Child attributes

broker_idstring

Receiving Broker. Broker dropdown with an additional id = 0 option representing Other Broker.

name_enstringrequired

Name of Receiving Broker. Must be filled in manually when broker_id = '0' (other broker); otherwise auto-populated from the selected broker record.

codestringrequired

CCASS / DTC No.. Must be filled in manually when broker_id = '0' (other broker); otherwise auto-populated from the selected broker record.

namestringrequired

Account Name. An enumerated value; the data source is the list of client names.

accountstring

A/C No.. Specifies A/C No..

brokerstring

Broker Name (submit). A computed field: when broker_id ≠ '0' it takes the selected broker's name, otherwise it takes name_en.

account_channelstringrequired

Account Channel. The currently logged-in channel, obtained automatically; not manually entered by the user.

stocksarray<object>required

Transfer Out Stock List. Multiple groups can be added/removed dynamically; each group's structure is described by the stocks[] fields below.

Child attributes

counter_idstringrequired

Stock (Counter ID). Select the instrument; upon selection, market/name_en/code and custodian-holding info are populated in cascade. Format is {type}/{market}/{code}, for example, stock ST/HK/700 or ST/US/AAPL, and option OP/US/AAPL270319C320000.

is_realityintegerrequired

Whether It Is a Physical Stock. Specifies Whether It Is a Physical Stock. This field is required.

Allowed values: 1 Yes, 0 No

Values

1: Yes
0: No

custodianstringrequired

Custodian. An enumerated value; after an instrument is selected, options are provided by the holdings-query result or the clear_custodian_no_all dynamic enumeration.

Call GET /v1/datasets/refs/clearing_custodians to retrieve the current data dictionary, and use the returned entry's key as this field's value.

sub_position_nostringrequired

Depot. An enumerated value, sourced from holdings information or the clear_sub_position_no_all dynamic enumeration.

Call GET /v1/datasets/refs/custodian_sub_positions to retrieve the current data dictionary, and use the returned entry's key as this field's value.

street_amountinteger

Street Amount. A non-negative integer, defaults to 0, populated automatically from the holdings query, editable.

nominee_amountinteger

Nominee Amount. A non-negative integer, defaults to 0, populated automatically from the holdings query, editable.

own_amountinteger

Own Amount. A non-negative integer, defaults to 0, populated automatically from the holdings query, editable.

amountstringrequired

Total Amount. Auto-computed as street_amount + nominee_amount + own_amount; must be a positive integer, converted to a string on submit.

marketstring

Market. Populated automatically from the selected counter_id.

name_enstring

Stock Name (English). Populated automatically from the selected counter_id.

codestring

Stock Code. Populated automatically from the selected counter_id.

Responses

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