Deposit Match

Queries Deposit Match 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.

GEThttps://b-api.longbridge.xyz/v1/datasets/atm_deposit_match_details

This Dataset query is read-only. Use GET by default. If the encoded query parameters are too large, send the same parameters as a JSON body with POST to the same path.

Authorization

Authorizationstringheadercmbc.hk_deposit_detailRequired

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

Query parameters

filtersobject

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

Child attributes

bank_accountstring

Remitter Bank Account No.. Filters results by Remitter Bank Account No..

idstring

Deposit Billing No.. Filters results by Deposit Billing No..

bank_user_namestring

Name Of Payer. Filters results by Name Of Payer.

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.

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.

bank_busi_typestring

Bank Transaction Type. Filters results by Bank Transaction Type.

remarkstring

Remarks. Filters results by Remarks.

remark_emptystring

Remarks Is Empty. Filters results by Remarks Is Empty.

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 Deposit Match 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

Deposit Billing No.. Returned value: Unique identifier of the current record.

bank_accountstring

Remitter Bank Account No.. Returned value: Remitter Bank Account No..

bank_user_namestring

Remitter Name. Returned value: Remitter Name.

currencystring

Currency. Returned value: Currency.

currency_valstring

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

amountstring

Received Amount. Returned value: Received Amount.

lb_bank_accountstring

Account No.. Returned value: Account No..

lb_bank_namestring

Bank. Returned value: Bank.

bill_datetimestring

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

bank_serial_nostring

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

match_statestring

Match Status. Returned value: Match Status.

match_state_valstring

Match Status (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.

bank_busi_typestring

Bank Transaction Type. Returned value: Bank Transaction Type.

bank_sub_accountstring

Sub Account. Returned value: Sub Account.

bank_ret_msgstring

Bank Return Message. Returned value: Bank Return Message.

bank_remarkstring

Bank Remarks. Returned value: Bank Remarks.

balancestring

Bank Balance. Returned value: Bank Balance.

remarkstring

Remark. Returned value: Remark.

updated_atstring

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

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 --get \
  --url 'https://b-api.longbridge.xyz/v1/datasets/atm_deposit_match_details' \
  --header 'Authorization: Bearer <token>' \
  --data-urlencode 'filters={}' \
  --data-urlencode 'page=1' \
  --data-urlencode 'page_size=20' \
  --data-urlencode 'orderBy=[]'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "377411",
        "bank_account": "示例用户",
        "bank_user_name": "示例用户",
        "currency": "HKD",
        "currency_val": "HKD",
        "amount": "11.00",
        "lb_bank_account": "示例用户",
        "lb_bank_name": "041-041 Chong Hing Bank Limited",
        "bill_datetime": "1744646400",
        "bank_serial_no": "20230717172508001009788074005",
        "match_state": "Unmatch",
        "match_state_val": "2",
        "bank_busi_type": "1231231",
        "bank_sub_account": "",
        "bank_ret_msg": "",
        "bank_remark": "1231231",
        "balance": "11.00",
        "remark": "--",
        "updated_at": "1784170455"
      }
    ],
    "total": 11
  }
}