Transfer-Out Details

Queries Transfer-Out Details data. Combine business filters in filters, and use page, page_size, and orderBy to control pagination and sorting.

Response

On success, the API returns the matching records and pagination metadata. See each filter field for its purpose, allowed values, and dynamic value source.

GEThttps://b-api.longbridge.xyz/v1/datasets/atm_transfer_out_stocks

This Dataset query is read-only. Use GET by default. If the encoded query parameters are too large, send the same parameters as a JSON body with POST to the same path.

Authorization

Authorizationstringheaderfinance.transfer_out_recordRequired

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

Query parameters

filtersobject

Filters. Combines business filters. Omit a filter field to disable that filter.

Child attributes

transfer_idstring

Request ID. Filters results by Request ID.

idstring

Transfer-Out Record ID. Filters results by Transfer-Out Record ID.

is_realitystring

Physical Script. Filters results by Physical Script.

Allowed values:

0 - NO
1 - YES

01

statestring

Transfer-Out Status. Filters results by Transfer-Out Status.

Multiple values are supported. Join them with commas (,). Omit the field to disable this filter.

Allowed values:

0 - Initialize
1 - Success
2 - Fail
3 - Deleted

0123

created_atobject

Submit time. Filters results by Submit time.

Child attributes

gtestring

Greater Than or Equal. Inclusive lower bound of the filter range.

ltestring

Less Than or Equal. Inclusive upper bound of the filter range.

apply_statestring

Approval Status. Filters results by Approval Status.

Multiple values are supported. Join them with commas (,). Omit the field to disable this filter.

Allowed values:

0 - Init
1 - Pending Success Review
2 - Pending Fail Review
3 - Pending Edit Review
6 - Delete pending approval

01236

member_idstring

Client ID. Filters results by Client ID.

marketstring

Market. Filters results by Market.

Allowed values: US, HK, UK, SH, SZ, SG, KR, JP, AU, DE, CA, TH, ID, MY, TR, NA, OSL, HAS, EU, UT, GTMMF

USHKUKSHSZSGKRJPAUDECATHIDMYTRNAOSLHASEUUTGTMMF

counter_idstring

Stock. Filters results by Stock.

settled_atobject

Settled At. Filters results by Settled At.

Child attributes

gtestring

Greater Than or Equal. Inclusive lower bound of the filter range.

ltestring

Less Than or Equal. Inclusive upper bound of the filter range.

cheat_statestring

Risk Status. Filters results by Risk Status.

Allowed values:

0 - Risk Control In Progress
1 - Not Targeted
2 - Targeted

012

hit_rulesstring

Hit Rules. Filters results by Hit Rules.

Values are dynamic. Call GET /v1/datasets/refs/risk_rule_indicators_transfer_out to retrieve the current data dictionary, and use the returned entry's key as this parameter's value.

pageinteger

Page. Page number to retrieve, starting from 1.

page_sizeinteger

Page Size. Number of records to return per page.

orderByarray<object>

Order By. Array of sorting rules. Each item defines a sort field and direction.

Responses

HTTP 200On success, returns paginated Transfer-Out Details records together with pagination metadata such as the page number, page size, and total record count.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

List. Returned value: List of list.

Child attributes

idstring

Transfer-Out Record ID. Returned value: Unique identifier of the current record.

transfer_idstring

Request ID. Returned value: Request ID.

codestring

Stock code. Returned value: Stock code.

real_namestring

Client Name. Returned value: Client Name.

origin_idstring

A/C No.. Returned value: A/C No..

name_localesstring

Transfer Out Stock. Returned value: Transfer Out Stock.

amountstring

Transfer Out Quantity. Returned value: Transfer Out Quantity.

transfer_order_feestring

Handling Fee. Returned value: Handling Fee.

custom_transfer_area_feestring

GST. Returned value: GST.

margin_call_valuestring

Margin Call Value (Reference). Returned value: Margin Call Value (Reference).

apply_statestring

Approval Status. Returned value: Approval Status.

apply_state_valstring

Approval Status (raw value). Raw value of apply_state. The apply_state field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

auditorstring

Approved By. Returned value: Approved By.

updated_atstring

Updated At. Returned value: Updated At. The date or time format follows the value returned by the API.

statestring

Transfer-Out Status. Returned value: Transfer-Out Status.

state_valstring

Transfer-Out Status (raw value). Raw value of state. The state field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

cheat_statestring

Risk Status. Returned value: Risk Status.

cheat_state_valstring

Risk Status (raw value). Raw value of cheat_state. The cheat_state field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

custom_hit_rulesstring

Hit Rule. Returned value: Hit Rule.

si_file_namestring

SI Report Name. Returned value: SI Report Name.

si_purposestring

SI Method. Returned value: SI Method.

si_account_namestring

SI Name. Returned value: SI Name.

si_accountstring

SI Account No.. Returned value: SI Account No..

broker_idstring

Transfer In Broker. Returned value: Transfer In Broker.

broker_id_valstring

Transfer In Broker (raw value). Raw value of broker_id. The broker_id field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

si_broker_codestring

SI Broker Code. Returned value: SI Broker Code.

unit_amountstring

Transfer-Out Quantity. Returned value: Transfer-Out Quantity.

close_pricestring

Closing Price. Returned value: Closing Price.

market_valuestring

Market Value. Returned value: Market Value.

statement_remarkstring

Statement Remarks. Returned value: Statement Remarks.

custodian_beforestring

Custodian. Returned value: Custodian.

custodian_before_valstring

Custodian (raw value). Raw value of custodian_before. The custodian_before field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

sub_position_no_beforestring

Sub Position No.. Returned value: Sub Position No..

sub_position_no_before_valstring

Sub Position No. (raw value). Raw value of sub_position_no_before. The sub_position_no_before field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

street_amount_beforestring

Street Amount Before. Returned value: Street Amount Before.

nominee_amount_beforestring

Nominee Amount Before. Returned value: Nominee Amount Before.

own_amount_beforestring

Own Amount Before. Returned value: Own Amount Before.

creatorstring

Processed By. Returned value: Processed By.

created_atstring

Submit Time. Returned value: Submit Time. The date or time format follows the value returned by the API.

settled_atstring

Settled At. Returned value: Settled At. The date or time format follows the value returned by the API.

totalintegerrequired

Total. Returned value: Total number of matching records, used for pagination.

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

Request

curl --get \
  --url 'https://b-api.longbridge.xyz/v1/datasets/atm_transfer_out_stocks' \
  --header 'Authorization: Bearer <token>' \
  --data-urlencode 'filters={}' \
  --data-urlencode 'page=1' \
  --data-urlencode 'page_size=20' \
  --data-urlencode 'orderBy=[]'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "89760",
        "transfer_id": "68971",
        "code": "45934",
        "real_name": "示例用户",
        "origin_id": "H00000000",
        "name_locales": "ST/HK/45934",
        "amount": " 1",
        "transfer_order_fee": " 0 HKD",
        "custom_transfer_area_fee": " 0.00 HKD",
        "margin_call_value": "0.00",
        "apply_state": "Init",
        "apply_state_val": "0",
        "auditor": "",
        "updated_at": "1783968922",
        "state": "Initialize",
        "state_val": "0",
        "cheat_state": "Targeted",
        "cheat_state_val": "2",
        "custom_hit_rules": "Loan amount4HKD",
        "si_file_name": "",
        "si_purpose": "C",
        "si_account_name": "LI BAI",
        "si_account": "123123",
        "broker_id": " BOCI Securities Limited",
        "broker_id_val": "1",
        "si_broker_code": "B01130",
        "unit_amount": "0",
        "close_price": "0HKD",
        "market_value": "0.00HKD",
        "statement_remark": "",
        "custodian_before": "CCASS",
        "custodian_before_val": "",
        "sub_position_no_before": "4 | margin",
        "sub_position_no_before_val": "",
        "street_amount_before": "1.00000",
        "nominee_amount_before": "0.00000",
        "own_amount_before": "0.00000",
        "creator": "示例用户",
        "created_at": "1783968846",
        "settled_at": ""
      }
    ],
    "total": 9315
  }
}