OB Downstream File Delivery

Query records of files sent to OB downstream institutions, used to track how downstream files were generated and delivered.

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 OB downstream file-send records combined with downstream file configuration and file-type information; each record represents one file generated for a given downstream institution and market.

Each record carries the file date, member ID and name, company ID, market, file type, file name, file status, file create and send times, and the original and public file URLs.

This lets operators verify whether the files due for each downstream institution in a given market and date were generated and successfully sent.

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/ipo_ob_file_downstream_sends

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_clearing.ob_file_sending_list

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

member_idstring

Filters results by Client.

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.

ledger_datestring

Filters results by File Date.

marketstring

Filters results by Market.

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

file_codestring

Filters results by File Type.

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

statusstring

Filters results by File Status.

Allowed values: 0 Unsent, 1 Sending, 2 Sent, 3 Send Failed, 4 Sent And Updated

Values

0: Unsent
1: Sending
2: Sent
3: Send Failed
4: Sent And Updated

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated OB Downstream File Sending 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.

ledger_datestring

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

member_idstring

Returned value: Member Id.

member_id_valstring

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.

member_real_namestring

Returned value: Name.

org_account_channelstring

Returned value: Company ID.

marketstring

Returned value: Market.

market_valstring

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

file_titlestring

Returned value: File Type.

file_namestring

Returned value: File Name.

statusstring

Returned value: File 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: File Created At. The date or time format follows the value returned by the API.

send_timestring

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

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/ipo_ob_file_downstream_sends' \
  --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",
        "ledger_date": " ",
        "member_id": "101456715",
        "member_id_val": "",
        "member_real_name": "Zhang San",
        "org_account_channel": "longport_test",
        "market": "Nonmarket",
        "market_val": "ALL",
        "file_title": "Miscellaneous Cash Transaction",
        "file_name": "",
        "status": "File Not Generated",
        "status_val": "",
        "created_at": "",
        "send_time": ""
      }
    ],
    "total": 79
  }
}