Skip to content
Pending Requests

Pending Requests

Queries Pending Requests 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_applications

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_user_deposit_applicationRequired

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. Filters results by Client.

search_member_idstring

Member ID. Filters results by Member ID.

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.

channel_accountstring

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

idstring

Deposit Request ID. Filters results by Deposit Request ID.

ref_statestring

Match State. Filters results by Match State.

Allowed values:

  • 0 - Not Matched
  • 1 - Already Matched

01

statestring

Status. Filters results by Status.

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

Allowed values:

  • 0 - Processing
  • 1 - Load Completed
  • 2 - Failed
  • 3 - Canceled
  • 5 - Rejected
  • 6 - Modify to be approved
  • 7 - Delete pending approval
  • 8 - Deleted
  • 9 - Reject pending approval
  • 100 - Pending Release
  • 200 - Pending Release Review

012356789100200

deposit_typestring

Deposit Type. Filters results by Deposit Type.

Allowed values:

  • 0 - Client Deposit
  • 1 - Account Opening Deposit

01

created_atobject

Created Time. Filters results by Created 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 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.

bank_operation_type_idstring

Deposit Method. Filters results by Deposit Method.

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

bank_idstring

Remittance Bank. Filters results by Remittance Bank.

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

lb_bank_account_idstring

Beneficiary Bank. Filters results by Beneficiary Bank.

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

detail_idstring

Deposit ID. Filters results by Deposit ID.

bills_idstring

Deposit Billing No. Filters results by Deposit Billing No.

initiatorstring

Requestor. Filters results by Requestor.

Allowed values: APP (User), system (System), AUTO

APPsystemAUTO

sub_statestring

Deposit Expedited. Filters results by Deposit Expedited.

Allowed values:

  • 0 - None
  • 1 - Pending
  • 2 - Confirm

012

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 Pending Requests 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 Request ID. Returned value: Unique identifier of the current record.

id_valstring

Deposit Request 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.

detail_idstring

Deposit ID. Returned value: Deposit ID.

member_idstring

Client ID. Returned value: Client ID.

member_id_valstring

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

channel_accountstring

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

user_namestring

User Name. Returned value: User Name.

custom_credential_infostring

Voucher Information. Returned value: Voucher Information.

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 Notified. Returned value: Amount Notified.

receivable_amountstring

Amount Received. Returned value: Amount Received.

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.

face_merchantstring

Account Type. Returned value: Account Type.

face_merchant_valstring

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

verify_statestring

Account Opening Status. Returned value: Account Opening Status.

verify_state_valstring

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

ref_statestring

Match State. Returned value: Match State.

ref_state_valstring

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

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.

lb_bank_account_idstring

Bank Abbreviation. Returned value: Bank Abbreviation.

lb_bank_account_id_valstring

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

bank_idstring

Remittance Bank. Returned value: Remittance Bank.

bank_id_valstring

Remittance Bank (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.

remittance_timestring

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

show_statestring

Status. Returned value: Status.

show_state_valstring

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.

hit_rulesstring

Hit Rules. Returned value: Hit Rules.

hit_rules_valstring

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

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.

reference_nostring

Reference. Returned value: Reference.

initiatorstring

Requestor. Returned value: Requestor.

initiator_valstring

Requestor (raw value). Raw value of initiator. The initiator 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.

created_atstring

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

account_atstring

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

canceled_atstring

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

custom_last_remarkstring

Remarks. Returned value: Remarks.

all_remarkstring

Remark. Returned value: Remark.

statement_remarkstring

Statement Remark. Returned value: Statement Remark.

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