Bank Statement

Queries Bank Statement data. Combine business filters in filters, and use page, page_size, and orderBy to control pagination and sorting.

Response

On success, the API returns the matching records and pagination metadata. See each filter field for its purpose, allowed values, and dynamic value source.

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

Authorization

AuthorizationstringheaderRequired

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

Permission

accounting.bank_bill

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

Request body application/json

filtersobject

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

Child attributes

idstring

Bank Statement ID. Filters results by Bank Statement ID.

order_idstring

Order ID. Filters results by Order ID.

bank_serial_nostring

Online Bank Serial No.. Filters results by Online Bank Serial No..

atm_bill_idstring

Withdrawal/Deposit Statement ID. Filters results by Withdrawal/Deposit Statement ID.

bank_accountstring

Bank Account of Payer. Filters results by Bank Account of Payer.

bank_user_namestring

Name of Payer. Filters results by Name of Payer.

statestring

Marking State. Filters results by Marking State.

Values

1: Unprocess
2: Pending Audit

fund_type_idstring

Fund Type. Filters results by Fund Type.

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

currencystring

Currency. Filters results by Currency.

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

bill_typestring

Fund Flow. Filters results by Fund Flow.

Values

1: In
2: Out

bill_dateobject

Accounting Date (Bank). Filters results by Accounting Date (Bank).

Child attributes

gtestring

Greater Than or Equal. Inclusive lower bound of the filter range.

ltestring

Less Than or Equal. Inclusive upper bound of the filter range.

rms_dateobject

Accounting Date (Asset Middle Office). Filters results by Accounting Date (Asset Middle Office).

Child attributes

gtestring

Greater Than or Equal. Inclusive lower bound of the filter range.

ltestring

Less Than or Equal. Inclusive upper bound of the filter range.

keystring

Deposit Status. Filters results by Deposit Status.

Values

3: Match
4: Counter Deal
5: Load Completed
8: Failed
9: Deleted
100: Pending Release
200: Pending Release Review
6: Rejected

match_statestring

Match Status. Filters results by Match Status.

Multiple values are supported. Join them with commas (,). Omit the field to disable this filter.

Values

1: Matched
2: Unmatch
4: Manually Match
5: Pending Transfer Audit
6: Frozen

bank_remarkstring

Bank Remark. Filters results by Bank Remark.

amountobject

Amount. Filters results by Amount.

Child attributes

gtenumber

Greater Than or Equal. Inclusive lower bound of the filter range.

ltenumber

Less Than or Equal. Inclusive upper bound of the filter range.

lb_channelstring

All Banks. Filters results by All Banks.

pageinteger

Page. Page number to retrieve, starting from 1.

page_sizeinteger

Page Size. Number of records to return per page.

orderByarray<object>

Order By. Array of sorting rules. Each item defines a sort field and direction.

Responses

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

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

List. Returned value: List of list.

Child attributes

idstring

Bank Statement ID. Returned value: Unique identifier of the current record.

bill_typestring

Fund Flow. Returned value: Fund Flow.

bill_type_valstring

Fund Flow (raw value). Raw value of bill_type. The bill_type field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

order_idstring

Order ID. Returned value: Order ID.

fund_type_idstring

Fund Type. Returned value: Fund Type.

fund_type_id_valstring

Fund Type (raw value). Raw value of fund_type_id. The fund_type_id field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

lb_channel_accountstring

A/C No.. Returned value: A/C No..

lb_channelstring

All Banks. Returned value: All Banks.

bill_datestring

Accounting Date (Bank). Returned value: Accounting Date (Bank). The date or time format follows the value returned by the API.

rms_datestring

Accounting Date (Asset Middle Office). Returned value: Accounting Date (Asset Middle Office). The date or time format follows the value returned by the API.

currencystring

Currency. Returned value: Currency.

amountstring

Amount. Returned value: Amount.

atm_bill_idstring

Withdrawal/Deposit Bill ID. Returned value: Withdrawal/Deposit Bill ID.

bank_serial_nostring

Online Bank Serial No.. Returned value: Online Bank Serial No..

bank_accountstring

Bank Account of Counterparty. Returned value: Bank Account of Counterparty.

bank_user_namestring

Name of Counterparty. Returned value: Name of Counterparty.

bank_busi_typestring

Business Type. Returned value: Business Type.

bank_sub_accountstring

Sub Account. Returned value: Sub Account.

bank_ret_msgstring

Cross-bank Return Reason. Returned value: Cross-bank Return Reason.

bank_remarkstring

Bank Remark. Returned value: Bank Remark.

balancestring

Bank Balance. Returned value: Bank Balance.

remarkstring

Remark. Returned value: Remark.

statestring

Marking State. Returned value: Marking State.

state_valstring

Marking State (raw value). Raw value of state. The state field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

updated_atstring

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

match_statestring

Match State. Returned value: Match State.

match_state_valstring

Match State (raw value). Raw value of match_state. The match_state field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

totalintegerrequired

Total. 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/booking_bank_bills' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "filters": {},
  "page": 1,
  "page_size": 20,
  "orderBy": []
}'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "690629",
        "bill_type": "In",
        "bill_type_val": "1",
        "order_id": "188731",
        "fund_type_id": "Client Deposit",
        "fund_type_id_val": "2",
        "lb_channel_account": "861520160012",
        "lb_channel": "072-072 ICBC (Asia) Ltd",
        "bill_date": "1784131200",
        "rms_date": "1784183889",
        "currency": "HKD",
        "amount": "70,000.00",
        "atm_bill_id": "377429",
        "bank_serial_no": "",
        "bank_account": "Zhang San",
        "bank_user_name": "Zhang San",
        "bank_busi_type": "",
        "bank_sub_account": "",
        "bank_ret_msg": "",
        "bank_remark": "",
        "balance": "",
        "remark": "",
        "state": "Unprocess",
        "state_val": "1",
        "updated_at": "1784183888",
        "match_state": "Manually Match",
        "match_state_val": "4"
      }
    ],
    "total": 576
  }
}