Statement Delivery Management

Query the statement delivery management settings. Combine business filters through filters, and control pagination with page and page_size.

Response

On success, returns the matching list of records together with pagination information. See each field's documentation for the purpose, allowed values, and dynamic data source of every filter.

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

Dataset endpoints are available on the Test host only (https://b-api.longbridge.xyz); the Production host returns 404.

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

Permission

b2b_statement.send_typelb_hk_clearing.send_type

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

Query parameters

filtersobject

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

Child attributes

aaidstring

Filters results by Account No..

member_idstring

Filters results by Member ID.

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Statement Sending Management 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

origin_idstring

Returned value: A/C No..

member_idstring

Returned value: Member Id.

real_namestring

Returned value: Name.

onlinestring

Returned value: Offline Send.

online_valstring

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

daily_notice_emailstring

Returned value: Daily Email.

daily_notice_email_valstring

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

monthly_notice_emailstring

Returned value: Monthly Email.

monthly_notice_email_valstring

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

daily_notice_appstring

Returned value: Daily App.

daily_notice_app_valstring

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

monthly_notice_appstring

Returned value: Monthly App.

monthly_notice_app_valstring

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

op_user_namestring

Returned value: Origin.

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

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "origin_id": "H00000000",
        "member_id": "1000000000000000000",
        "real_name": "示例用户",
        "online": "YES",
        "online_val": "-1",
        "daily_notice_email": "user@example.com",
        "daily_notice_email_val": "user@example.com",
        "monthly_notice_email": "user@example.com",
        "monthly_notice_email_val": "user@example.com",
        "daily_notice_app": "No",
        "daily_notice_app_val": "-1",
        "monthly_notice_app": "Yes",
        "monthly_notice_app_val": "1",
        "op_user_name": "示例用户"
      }
    ],
    "total": 99
  }
}