Statement Delivery Management

Query customer statement delivery settings, used to manage how each customer is notified and whether statements are sent online or offline.

Request parameters

Combine business filters through filters (see the filter field descriptions below), and use page, page_size, and orderBy to control pagination and sorting.

Business notes

The data comes from customer statement delivery settings; each record represents the delivery configuration for one customer account.

Each record carries the securities account, member ID, customer name, and account source, and records separately whether daily and monthly statements notify the customer via App and email, and whether online delivery is used.

It also includes the last operator, so operators can review and maintain each customer's statement delivery method.

Returns

On success, returns the list of matching records with pagination. See the response definition for column meanings.

POSThttps://b-api.lbkrs.com/v1/datasets/atm_statement_send_settings

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 above, or the call will be rejected.

Request body application/json

filtersobject

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

Child attributes

aaidstring

Filters results by Account No..

Pass the internal numeric ID of the customer's securities account (aaid), not the securities account number account_no (such as H00000000) or the customer ID member_id. One customer can have multiple aaid values.

member_idstring

Filters results by Member ID.

member_id is the customer ID. It differs from the securities account number account_no and the internal securities account ID aaid; one customer can have multiple securities accounts.

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

idstring

Record ID. Returned value: Record ID (row primary key); write operations on this record take it as their id.

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 --request POST \
  --url 'https://b-api.lbkrs.com/v1/datasets/atm_statement_send_settings' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "filters": {},
  "page": 1,
  "page_size": 20
}'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "123",
        "origin_id": "H00000000",
        "member_id": "101456715",
        "real_name": "Zhang San",
        "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": "Zhang San"
      }
    ],
    "total": 99
  }
}