Skip to content
Longport WhaleLongport Whale
API raw data

Deposit Message

Queries Deposit Message 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_bank_messages

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
idstring

ID. Filters results by ID.

bank_serial_nostring

Online Bank Serial No.. Filters results by Online Bank Serial No..

bank_user_namestring

Name of Counterparty. Filters results by Name of Counterparty.

bank_accountstring

Bank Account of Counterparty. Filters results by Bank Account of Counterparty.

lb_bank_accountstring

Company Bank Account. Filters results by Company Bank Account.

bank_remarkstring

Bank Remark. Filters results by Bank Remark.

bill_datetimeobject

Accounting Date (Bank). Filters results by Accounting Date (Bank).

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

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

currencystring

Currency. Filters results by Currency.

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

statestring

State. Filters results by State.

Allowed values:

  • 0 - Unassociated
  • 1 - Associated and Recorded
  • 2 - Rejected After Association
  • 3 - Associated
  • 4,5 - Cancelled

01234,5

lb_bank_namestring

Company Bank Name. Filters results by Company Bank Name.

bill_typestring

Bill Type. Filters results by Bill Type.

Allowed values:

  • 1 - Deposit
  • 2 - Withdraw

12

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 Message 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

ID. Returned value: Unique identifier of the current record.

id_valstring

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.

bill_typestring

Fund Flow. Returned value: Fund Flow.

bill_type_valstring

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

bank_user_namestring

Counterparty Acct Info-Name of Counterparty. Returned value: Counterparty Acct Info-Name of Counterparty.

bank_accountstring

Counterparty Acct Info-Bank Account of Counterparty. Returned value: Counterparty Acct Info-Bank Account of Counterparty.

custom_counterparty_info_from_serverstring

Counterparty Acct Info. Returned value: Counterparty Acct Info.

lb_bank_accountstring

Company Bank Account-A/C No.. Returned value: Company Bank Account-A/C No..

lb_bank_namestring

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

custom_company_bank_account_from_serverstring

Company Bank Account. Returned value: Company Bank Account.

currencystring

Amount(Currency)-Currency. Returned value: Amount(Currency)-Currency.

amountstring

Amount(Currency)-Amount. Returned value: Amount(Currency)-Amount.

custom_amount_currency_from_serverstring

Amount(Currency). Returned value: Amount(Currency).

bank_serial_nostring

Bill Info-Online Bank Serial No.. Returned value: Bill Info-Online Bank Serial No..

bank_busi_typestring

Bill Info-Business Type. Returned value: Bill Info-Business Type.

bank_ret_msgstring

Bill Info-Cross-bank Return Reason. Returned value: Bill Info-Cross-bank Return Reason.

bank_remarkstring

Bill Info-Bank Remark. Returned value: Bill Info-Bank Remark.

balancestring

Bill Info-Bank Balance. Returned value: Bill Info-Bank Balance.

custom_bill_info_from_serverstring

Bill Info. Returned value: Bill Info.

statestring

State. Returned value: State.

state_valstring

State (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.

bill_datetimestring

Time-Accounting Date (Bank). Returned value: Time-Accounting Date (Bank). The date or time format follows the value returned by the API.

created_atstring

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

updated_atstring

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

custom_time_from_serverstring

Time. Returned value: Time.

remarkstring

Backend Remarks. Returned value: Backend Remarks.

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