Manual Transfer-out Apply

Processes Transfer-out Apply.

Request parameters

Required: aaid (Asset Account ID), member_id (Member ID), from (Source Flag), params.name_en (Name of Receiving Broker), params.code (CCASS / DTC No.), params.name (Account Name), params.account_channel (Account Channel), params.stocks (Transfer Out Stock List), params.stocks[].counter_id (Stock (Counter ID)), params.stocks[].is_reality (Whether It Is a Physical Stock), params.stocks[].custodian (Custodian), params.stocks[].sub_position_no (Depot), params.stocks[].amount (Total Amount)
Optional: params.broker_id (Receiving Broker), params.account (A/C No.), params.broker (Broker Name (submit)), params.stocks[].street_amount (Street Amount), params.stocks[].nominee_amount (Nominee Amount), params.stocks[].own_amount (Own Amount), params.stocks[].market (Market), params.stocks[].name_en (Stock Name (English)), params.stocks[].code (Stock Code)
See each field for its format, allowed values, and business meaning.

Risk notice

This operation may change real cash balances, positions, or transaction state. Verify the target records and parameters before calling it.

Result

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

POSThttps://b-api.longbridge.xyz/admin/transfer/out/apply

Authorization

Authorizationstringheaderatm.admin_transfer_out_applyb2b_atm.admin_transfer_out_applyRequired

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

Request body application/json

aaidstringrequired

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

member_idstringrequired

Member ID. Member ID associated with this request.

fromstringrequired

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

params.broker_idstring

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

params.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.

params.codestringrequired

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

params.namestringrequired

Account Name. A dropdown selection; the data source is the list of client names.

params.accountstring

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

params.brokerstring

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

params.account_channelstringrequired

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

params.stocksarray<string>required

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

params.stocks[].counter_idstringrequired

Stock (Counter ID). Select the instrument; upon selection, market/name_en/code and custodian-holding info are populated in cascade.

params.stocks[].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

10

params.stocks[].custodianstringrequired

Custodian. A dropdown selection; 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.

params.stocks[].sub_position_nostringrequired

Depot. A dropdown selection, 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.

params.stocks[].street_amountinteger

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

params.stocks[].nominee_amountinteger

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

params.stocks[].own_amountinteger

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

params.stocks[].amountstringrequired

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

params.stocks[].marketstring

Market. Populated automatically from the selected counter_id.

params.stocks[].name_enstring

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

params.stocks[].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.