Skip to content
Longport WhaleLongport Whale
Deposit Match

Deposit Matching - Match User Credit

Queries Deposit Matching - Match User Credit 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_candidates

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

Bank Account Of Payer. Filters results by Bank Account Of Payer.

idstring

Deposit ID. Filters results by Deposit ID.

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 Matching - Match User Credit 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 ID. Returned value: Unique identifier of the current record.

bank_accountstring

Bank Account Of Payer. Returned value: Bank Account Of Payer.

bank_user_namestring

Name Of Payer. Returned value: Name Of Payer.

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

Amount Received. Returned value: Amount Received.

lb_bank_accountstring

Bank Account. Returned value: Bank Account.

lb_bank_namestring

Bank. Returned value: Bank.

bill_datetimestring

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

bank_serial_nostring

Online Banking Serial No.. Returned value: Online Banking 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 Business Type. Returned value: Bank Business Type.

bank_sub_accountstring

Sub Account. Returned value: Sub Account.

bank_ret_msgstring

Bank Return Message. Returned value: Bank Return Message.

bank_remarkstring

Bank Remark. Returned value: Bank Remark.

balancestring

Bank Balance. Returned value: Bank Balance.

remarkstring

Remark. Returned value: Remark.

updated_atstring

Update Time. Returned value: Update Time. 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

Whale Docs