Skip to content
Deposit Records

Deposit Records

Queries Deposit Records 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_records

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_user_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
member_idstring

Client ID. Filters results by Client ID.

channel_accountstring

A/C No.. Filters results by A/C No..

lb_bank_accountstring

Company Bank Account No.. Filters results by Company Bank Account No..

lb_bank_namestring

Company Bank Name. Filters results by Company Bank Name.

from_bank_accountstring

Remitter Bank - Bank Account. Filters results by Remitter Bank - Bank Account.

from_serial_nostring

Bank Transaction No.. Filters results by Bank Transaction No..

idstring

Deposit ID. Filters results by Deposit ID.

from_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_idstring

Remitter Bank - Bank Name. Filters results by Remitter Bank - Bank Name.

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

statestring

Deposit Status. Filters results by Deposit Status.

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

Allowed values:

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

345891002006

updated_atobject

Updated At. Filters results by Updated At.

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.

deposit_typestring

Deposit Type. Filters results by Deposit Type.

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

Allowed values:

  • 1 - Add Money
  • 2 - Withdrawal refund
  • 7 - Deposit refund
  • 8 - Register

1278

bank_operation_type_namestring

Deposit Method. Filters results by Deposit Method.

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

bill_datetimeobject

Bill Received Date. Filters results by Bill Received Date.

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.

account_atobject

Credit Date. Filters results by Credit Date.

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.

bills_idstring

Bill ID. Filters results by Bill ID.

from_amount_rangeobject

Amount Range. Filters results by Amount Range.

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.

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 Records 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.

id_valstring

Deposit ID (raw value). Raw value of id. The id 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.

deposit_typestring

Deposit Type. Returned value: Deposit Type.

deposit_type_valstring

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

lb_bank_accountstring

Company Bank Account-Bank Account No.. Returned value: Company Bank Account-Bank Account No..

lb_bank_namestring

Company Bank Account-Bank Name. Returned value: Company Bank Account-Bank Name.

custom_lb_bank_accountstring

Company Bank Account. Returned value: Company Bank Account.

group_memberstring

Client. Returned value: Client.

member_idstring

Member ID. Returned value: Member ID.

channel_accountstring

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

user_namestring

Client Name. Returned value: Client Name.

from_bank_accountstring

Remittance Bank - Bank Account. Returned value: Remittance Bank - Bank Account.

from_bank_usernamestring

Remittance Bank - Remitter Name. Returned value: Remittance Bank - Remitter Name.

custom_from_bank_accountstring

Remitter Bank. Returned value: Remitter Bank.

bank_codestring

Remittance Bank - Bank Code. Returned value: Remittance Bank - Bank Code.

bank_idstring

Remittance Bank - Bank Name. Returned value: Remittance Bank - Bank Name.

bank_id_valstring

Remittance Bank - Bank Name (raw value). Raw value of bank_id. The bank_id field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

from_currencystring

Currency. Returned value: Currency.

from_currency_valstring

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

from_amountstring

Received Amount. Returned value: Received Amount.

related_partystring

Related Party. Returned value: Related Party.

related_party_valstring

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

fund_source_idstring

Related Party ID. Returned value: Related Party ID.

fund_source_bank_accountstring

Remitter Account. Returned value: Remitter Account.

fund_source_bank_usernamestring

Remitter Name. Returned value: Remitter Name.

fund_source_datestring

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

fund_sourcestring

Fund Source. Returned value: Fund Source.

from_serial_nostring

Bank Transaction No.. Returned value: Bank Transaction No..

bank_operation_type_idstring

Deposit Method. Returned value: Deposit Method.

bank_operation_type_id_valstring

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

show_statestring

Deposit Status. Returned value: Deposit Status.

show_state_valstring

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

custom_aml_statusstring

Risk Status. Returned value: Risk Status.

audit_rule_idstring

Risk Control Deposit Rules. Returned value: Risk Control Deposit Rules.

audit_rule_id_valstring

Risk Control Deposit Rules (raw value). Raw value of audit_rule_id. The audit_rule_id field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

custom_timestring

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

account_atstring

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

custom_remarkstring

User Remarks. Returned value: User Remarks.

updated_atstring

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

lock_atstring

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

custom_expect_unlock_timestring

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

unlock_atstring

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

creatorstring

Processed By. Returned value: Processed By.

auditorstring

Approved By. Returned value: Approved By.

ticket_creator_admin_idstring

Match Person. Returned value: Match Person.

ticket_creator_admin_id_valstring

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

compliance_auditorstring

Compliance Auditor. Returned value: Compliance Auditor.

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