Skip to content
Account Opening Deposit

Account Opening Deposit

Queries Account Opening Deposit 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_review_processing_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
member_idstring

Client. Filters results by Client.

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.

channel_accountstring

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

lb_bank_accountstring

Bank Account. Filters results by Bank Account.

idstring

Deposit Detail ID. Filters results by Deposit Detail ID.

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.

from_atobject

Date Recorded. Filters results by Date Recorded.

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

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

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 Account Opening Deposit 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 Detail ID. Returned value: Unique identifier of the current record.

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

Bank Account. Returned value: Bank Account.

lb_bank_namestring

Bank Account Name. Returned value: Bank Account Name.

member_idstring

Client ID. Returned value: Client ID.

channel_accountstring

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

user_namestring

User Name. Returned value: User Name.

from_bank_accountstring

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

from_bank_usernamestring

Name Of Payer. Returned value: Name Of Payer.

from_atstring

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

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

Amount Received. Returned value: Amount Received.

from_serial_nostring

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

statestring

Deposit Status. Returned value: Deposit Status.

state_valstring

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

order_idstring

Deposit Request ID. Returned value: Deposit Request ID.

updated_atstring

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

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.

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