Transfer-out Request

Queries Transfer-out Request 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_records

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

aaidstring

Client. Filters results by Client.

idstring

Transfer-out Request ID. Filters results by Transfer-out Request ID.

created_atobject

Created Time. Filters results by Created 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.

counter_idstring

Stock. Filters results by Stock.

fromstring

Source. Filters results by Source.

Allowed values:

app - Client
bo - Manual
was - WAS

appbowas

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 Request 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

Request ID. Returned value: Unique identifier of the current record.

id_valstring

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

support_manager_namestring

Support Manager. Returned value: Support Manager.

origin_idstring

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

real_namestring

Name. Returned value: Name.

member_regionstring

Member Region. Returned value: Member Region.

member_region_valstring

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

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.

statestring

Application Status. Returned value: Application Status.

state_valstring

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

app_statestring

Notify securities. Returned value: Notify securities.

app_state_valstring

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

custom_remarkstring

Remark. Returned value: Remark.

fromstring

Source. Returned value: Source.

from_valstring

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

member_idstring

Client ID. Returned value: Client ID.

member_id_valstring

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

app_task_idstring

App Task ID. Returned value: App Task ID.

email_task_idstring

Email Task ID. Returned value: Email Task ID.

updated_atstring

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

operatorstring

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.

process_day_countstring

Process Days. Returned value: Process Days.

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_records' \
  --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": "68971",
        "id_val": "",
        "support_manager_name": "楚然(高勇)",
        "origin_id": "H00000000",
        "real_name": "示例用户",
        "member_region": "Hong Kong China",
        "member_region_val": "HK",
        "broker_id": " BOCI Securities Limited",
        "broker_id_val": "1",
        "state": "To Be Submitted",
        "state_val": "0",
        "app_state": "Uninformed",
        "app_state_val": "0",
        "custom_remark": "",
        "from": "Client",
        "from_val": "app",
        "member_id": "1000000000000000000",
        "member_id_val": "",
        "app_task_id": "0",
        "email_task_id": "user@example.com",
        "updated_at": "1783968846",
        "operator": "",
        "created_at": "1783968846",
        "process_day_count": "2"
      }
    ],
    "total": 134
  }
}