API Deposit Bill

Query the inbound bank bill details fetched through the bank API, used to look up and confirm incoming bills and follow up on remarks and tickets.

Request parameters

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

Business notes

Each record is one inbound bank bill fetched via the bank API, carrying the full information needed for reconciliation.

Counterparty account details include from_bank_username (payer name) and from_bank_account (payer bank account).
Company beneficiary details include lb_bank_account (company bank account) and to_bank_name (company bank).
Bill details include amount, currency, ref (online bank serial no.), business type, cross-bank return reason, bank_remark (bank remark), and bank balance.
Processing details include dr (fund flow), status (push state), backend remark, updater, the linked ticket id, and the bank accounting, created, and updated times.

Returns

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

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

Authorization

AuthorizationstringheaderRequired

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

Permission

atm.api_deposit_message_inquiry

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

ID. Filters results by ID.

refstring

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

from_bank_usernamestring

Name of Counterparty. Filters results by Name of Counterparty.

from_bank_accountstring

Bank Account of Counterparty. Filters results by Bank Account of Counterparty.

lb_bank_accountstring

Company Bank Account. Filters results by Company Bank Account.

to_bank_namestring

Company Bank. Filters results by Company Bank.

bank_remarkstring

Bank Remark. Filters results by Bank Remark.

business_timeobject

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.

updated_atobject

Updated Time. Filters results by Updated Time.

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.

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.

currencystring

Currency. Filters results by Currency.

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

statusstring

Status. Filters results by Status.

Allowed values: 0 Not Pushed (Pending Auto Processing), 1 Pushed, 2 Pending Push Review, 3 Not Pushed (Pending Manual Processing)

Values

0: Not Pushed (Pending Auto Processing)
1: Pushed
2: Pending Push Review
3: Not Pushed (Pending Manual Processing)

drstring

Fund Flows. Filters results by Fund Flows.

Allowed values: 2 Deposit, 1 Withdraw

Values

2: Deposit
1: Withdraw

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 API Deposit Bill 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

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

drstring

Fund Flow. Returned value: Fund Flow.

dr_valstring

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

custom_counterparty_info_from_serverstring

Counterparty Acct Info. Returned value: Counterparty Acct Info.

lb_bank_accountstring

Company Bank Account-A/C No.. Returned value: Company Bank Account-A/C No..

custom_company_bank_account_from_serverstring

Company Bank Account. Returned value: Company Bank Account.

amountstring

Amount (Currency). Returned value: Amount (Currency).

bank_busi_typestring

Bill Info-Business Type. Returned value: Bill Info-Business Type.

bank_ret_msgstring

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

bank_remarkstring

Bill Info-Bank Remark. Returned value: Bill Info-Bank Remark.

order_contentstring

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

statusstring

Status. Returned value: Status.

status_valstring

Status (raw value). 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.

latest_remarkstring

Backend Remarks. Returned value: Backend Remarks.

updaterstring

Updater. Returned value: Updater.

created_atstring

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

updated_atstring

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

business_timestring

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

custom_time_from_serverstring

Time. Returned value: Time.

custom_bill_infostring

Bill Info. Returned value: Bill Info.

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/atm_bank_bill_details' \
  --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": "526471",
        "dr": "Deposit",
        "dr_val": "2",
        "custom_counterparty_info_from_server": "Name of Counterparty: TEST\nBank Account of Counterparty: 757331943166476",
        "lb_bank_account": "Zhang San",
        "custom_company_bank_account_from_server": "Zhang San",
        "amount": "10(HKD)",
        "bank_busi_type": "INWARD PAYNOW",
        "bank_ret_msg": "",
        "bank_remark": "匯款存入",
        "order_content": "{\"date\":\"20221125\",\"en_abstract\":\"\",\"trade_time\":\"08:25:09\",\"use_cn\":\"\",\"detail_no\":\"\",\"debit_amount\":0,\"mg_currency\":\"\",\"for_currency\":0,\"ref\":\"IRM002139775\",\"balance\":203282761,\"trade_location\":\"\",\"busi_code\":\"S103\",\"recip_bk_name\":\"\",\"open_bankbic\":\"\",\"recip_account_no\":\"10012633588\",\"tran_serial_no\":\"\",\"en_summary\":\"Inward Remittance Credit\",\"credit_amount\":12956394,\"up_dtranf\":\"0\",\"recip_bk_no1\":\"\",\"refund_msg\":\"\",\"cashf\":\"\",\"mg_no\":\"\",\"t_info_new\":\"\",\"bus_type_no\":\"\",\"oref1\":\"\",\"drcrf\":\"2\",\"open_bank_no\":\"\",\"vouh_type\":\"0\",\"busi_time\":\"08:25:09\",\"post_script\":\"\",\"remark\":\"RFC002139775\",\"agent_account_name\":\"\",\"ref1\":\"\",\"trade_fee\":0,\"recip_name\":\"MILVUS CAPITAL FUND                RM 2105-07 21/F MAN YEE BUILDING 68DES VOEUX RD CENTRAL CENTRAL HONG  KONG\",\"th_currency\":\"14\",\"tel_no\":\"\",\"only_sequence\":\"\",\"agent_account_no\":\"\",\"recip_bk_name1\":\"\",\"busi_date\":\"20221125\",\"add_info\":\"\",\"summary\":\"匯款存入\",\"mdcardno\":\"\",\"receipt_info\":\"\",\"toutfo\":\"\",\"ex_rate\":\"0\",\"mg_account_no\":\"\",\"trx_code\":\"5352\",\"oref\":\"1348478955\",\"cash_exf\":\"2\",\"busi_type\":\"0\",\"open_bank_name\":\"\",\"time\":\"\",\"sub_acct_seq\":\"\",\"vouh_no\":\"0\",\"recip_bk_no\":\"DBSSHKHHXXX\",\"value_date\":\"20221125\"}",
        "status": "Pushed",
        "status_val": "1",
        "latest_remark": "",
        "updater": "",
        "created_at": "2026-07-15 13:47:22",
        "updated_at": "2026-07-15 14:06:33",
        "business_time": "2026-07-15 13:47:23",
        "custom_time_from_server": "Accounting Date (Bank): 2026-07-15 13:47:23\nCreated Time: 2026-07-15 13:47:22\nUpdated Time: 2026-07-15 14:06:33",
        "custom_bill_info": "Online Bank Serial No.: T11072511784094442Business Type: INWARD PAYNOWBank Return Reason：Bank Remark：匯款存入Bank Balance：203,282,761.00"
      }
    ],
    "total": 29
  }
}