Skip to content
Longport WhaleLongport Whale
File Rules

File Receiving Rules

Query upstream file receiving rules, used to define which upstream files are expected for each market, broker, and settlement channel.

Request parameters

  • This dataset exposes no business filter fields; pass an empty object for filters. You can still use page, page_size, and orderBy to control pagination and sorting.

Business notes

Each record corresponds to one receiving rule, carrying the ID, market, file type, broker, settlement channel, and upstream business number.

These rules specify from which upstream parties and in which file types the system should receive upstream files, serving as the matching basis for upstream file import and clearing reconciliation.

Returns

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

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

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_clearing.ob_file_receive_rules

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

Request body application/json

filtersobject
pageinteger
page_sizeinteger

Responses

HTTP 200Paginated list result.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>required
Child attributes
idstring

ID. Returned value: Receiving rule record ID.

marketstring

Market. Returned value: Market (display value; the raw code is in the matching _val field).

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_codestring

File type. Returned value: Upstream file type (display value; the raw code is in the matching _val field).

file_code_valstring

Raw value behind field file_code: file_code returns the human-readable display value resolved via a dictionary/join mapping, while this field returns the underlying code/ID before that mapping.

custodian_codestring

Broker. Returned value: Broker (display value; the raw code is in the matching _val field).

custodian_code_valstring

Raw value behind field custodian_code: custodian_code returns the human-readable display value resolved via a dictionary/join mapping, while this field returns the underlying code/ID before that mapping.

settlement_channel_codestring

Settlement channel. Returned value: Settlement channel (display value; the raw code is in the matching _val field).

settlement_channel_code_valstring

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

parent_account_channelstring

Upstream business number. Returned value: Upstream business number (display value; the raw code is in the matching _val field).

parent_account_channel_valstring

Raw value behind field parent_account_channel: parent_account_channel returns the human-readable display value resolved via a dictionary/join mapping, while this field returns the underlying code/ID before that mapping.

totalintegerrequired
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

Whale Docs