Transfer Announcement

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

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

AuthorizationstringheaderRequired

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

Query parameters

filtersobject

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

Child attributes

notice_typestring

Filters results by Announcement Type.

Allowed values:

1 - Deposit
2 - Withdrawal

1 · Deposit2 · Withdrawal

idstring

Filters results by ID.

statusstring

Filters results by Status.

Allowed values:

1 - Not Enabled
2 - Enable

1 · Not Enabled2 · Enable

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

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

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

Returned value: List of list.

Child attributes

idstring

Returned value: Unique identifier of the current record.

notice_typestring

Returned value: Announcement Type.

notice_type_valstring

Raw value of notice_type. The notice_type field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

custom_client_channelstring

Returned value: Channel Name.

account_channelstring

Returned value: Account Channel.

account_channel_valstring

Raw value of account_channel. The account_channel field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

new_org_idsstring

Returned value: Organization.

new_org_ids_valstring

Raw value of new_org_ids. The new_org_ids field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

new_app_idsstring

Returned value: Reach App.

new_app_ids_valstring

Raw value of new_app_ids. The new_app_ids field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

region_idsstring

Returned value: Bank Region.

region_ids_valstring

Raw value of region_ids. The region_ids field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

region_bank_idsstring

Returned value: Bank Name.

region_bank_ids_valstring

Raw value of region_bank_ids. The region_bank_ids field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

bank_operation_types_idstring

Returned value: Deposit Method.

bank_operation_types_id_valstring

Raw value of bank_operation_types_id. The bank_operation_types_id field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

remarkstring

Returned value: Remarks.

time_rangestring

Returned value: Time Range.

begin_atstring

Returned value: Start Date. The date or time format follows the value returned by the API.

end_atstring

Returned value: End Date. The date or time format follows the value returned by the API.

linkstring

Returned value: Redirect Link.

client_display_waystring

Returned value: Display Mode.

client_display_way_valstring

Raw value of client_display_way. The client_display_way field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

title_cnstring

Returned value: Simplified Chinese Title.

desc_cnstring

Returned value: Simplified Chinese Description.

title_hkstring

Returned value: Traditional Chinese Title.

desc_hkstring

Returned value: Traditional Chinese Description.

title_enstring

Returned value: English Title.

desc_enstring

Returned value: English Description.

prioritystring

Returned value: Priority.

confirm_button_labelstring

Returned value: Button Copy.

statusstring

Returned value: Status.

status_valstring

Raw value of status. The status field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

created_atstring

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

updated_atstring

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

operatorstring

Returned value: Operator.

totalintegerrequired

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_deposit_withdraw_notices' \
  --header 'Authorization: Bearer <token>' \
  --data-urlencode 'filters={}' \
  --data-urlencode 'page=1' \
  --data-urlencode 'page_size=20'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "209",
        "notice_type": "Withdrawal",
        "notice_type_val": "2",
        "custom_client_channel": "All Channels",
        "account_channel": "LB",
        "account_channel_val": "lb",
        "new_org_ids": "1 长桥证券",
        "new_org_ids_val": "lb-1",
        "new_app_ids": "longbridge",
        "new_app_ids_val": "longbridge",
        "region_ids": "All Regions",
        "region_ids_val": "all",
        "region_bank_ids": "All Banks",
        "region_bank_ids_val": "-1",
        "bank_operation_types_id": "0",
        "bank_operation_types_id_val": "0",
        "remark": "",
        "time_range": "Start Date: 2026-05-23 21:51:29\nEnd Date: 2026-05-24 21:51:35",
        "begin_at": "1779544289",
        "end_at": "1779630695",
        "link": "https://support.longbridgehk.com/topics/misc.disable/bcoqip",
        "client_display_way": "Manual Closing Is Not Allowed, Fixed Display",
        "client_display_way_val": "3",
        "title_cn": "测试用",
        "desc_cn": "测试用测试用测试用测试用测试用测试用测试用测试用测试用测试用测试用测试用测试用测试用测试用测试用测试用测试用测试用测试用测试用测试用测试用测试用测试用测试用测试用测试用测试用测试用测试用测试用测试用测试用测试用测试用测试用测试用测试用测试用测试用测试用测试用测试用测试用测试用测试用测试用测试用测试用测试用测试用测试用测试用测试用测试用测试用测试用测试用测试用测试用测试用测试用测试用测试用测试用测试用测试用测试用测试用",
        "title_hk": "测试用-繁体",
        "desc_hk": "测试用-繁体测试用-繁体测试用-繁体测试用-繁体测试用-繁体测试用-繁体测试用-繁体测试用-繁体",
        "title_en": "测试用-en",
        "desc_en": "测试用-en测试用-en测试用-en测试用-en测试用-en测试用-en测试用-en测试用-en测试用-en测试用-en测试用-en测试用-en",
        "priority": "0",
        "confirm_button_label": "{\"zh-CN\":\"查看详情\"}",
        "status": "Enable",
        "status_val": "2",
        "created_at": "1779544462",
        "updated_at": "1779545293",
        "operator": "user@example.com"
      }
    ],
    "total": 13
  }
}

Export

The export endpoint uses the same filters as this Dataset query.

POSThttps://b-api.longbridge.xyz/v1/datasets/atm_deposit_withdraw_notices/download

Export options Export records Download result