Withdrawal

Queries Bank Statement-Withdrawal 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_bill_withdrawals

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

Authorizationstringheaderaccounting.atm_bank_billRequired

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

Withdrawal Bill ID. Filters results by Withdrawal Bill ID.

member_idstring

Client ID. Filters results by Client ID.

channel_accountstring

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

order_idstring

Application Number. Filters results by Application Number.

bank_serial_nostring

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

bank_user_namestring

Beneficiary Name. Filters results by Beneficiary Name.

bank_accountstring

Credit Bank Account. Filters results by Credit Bank Account.

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.

match_statestring

Match State. Filters results by Match State.

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

Allowed values:

1 - Matched
2 - Unmatch
4 - Manually Match
5 - Pending Transfer Audit
6 - Frozen

12456

bill_datetimeobject

Bill Datetime. Filters results by Bill Datetime.

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.

bank_remarkstring

Bank Remark. Filters results by Bank Remark.

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.

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.

show_fund_type_idstring

Withdraw Type. Filters results by Withdraw Type.

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

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 Bank Statement-Withdrawal 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

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

order_idstring

Application Number. Returned value: Application Number.

show_fund_type_idstring

Withdraw Type. Returned value: Withdraw Type.

show_fund_type_id_valstring

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

lb_channel_accountstring

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

lb_channelstring

Company's Bank Name. Returned value: Company's Bank Name.

member_idstring

Client ID. Returned value: Client ID.

channel_accountstring

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

real_namestring

Name. Returned value: Name.

bill_datetimestring

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

rms_datestring

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

currencystring

Currency. Returned value: Currency.

amountstring

Actual Debit Amount. Returned value: Actual Debit Amount.

bank_serial_nostring

Bank Serial No.. Returned value: Bank Serial No..

bank_accountstring

Credit Bank Account. Returned value: Credit Bank Account.

bank_user_namestring

Beneficiary Name. Returned value: Beneficiary Name.

bank_remarkstring

Bank Remark. Returned value: Bank Remark.

match_statestring

Match State. Returned value: Match State.

match_state_valstring

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

Business Type. Returned value: Business Type.

custom_remarkstring

Remark. Returned value: Remark.

balancestring

Balance. Returned value: Balance.

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

Request

curl --get \
  --url 'https://b-api.longbridge.xyz/v1/datasets/atm_bank_bill_withdrawals' \
  --header 'Authorization: Bearer <token>' \
  --data-urlencode 'filters={}' \
  --data-urlencode 'page=1' \
  --data-urlencode 'page_size=20' \
  --data-urlencode 'orderBy=[]'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "377424",
        "order_id": "377423",
        "show_fund_type_id": "Refund",
        "show_fund_type_id_val": "40",
        "lb_channel_account": "988812001",
        "lb_channel": "041-041 Chong Hing Bank Limited",
        "member_id": "1000000000000000000",
        "channel_account": "H00000000",
        "real_name": "示例用户",
        "bill_datetime": "1784131200",
        "rms_date": "1784143641",
        "currency": "HKD",
        "amount": "26.00",
        "bank_serial_no": "",
        "bank_account": "示例用户",
        "bank_user_name": "示例用户",
        "bank_remark": "",
        "match_state": "Matched",
        "match_state_val": "1",
        "bank_busi_type": "",
        "custom_remark": "--",
        "balance": "-11.00",
        "updated_at": "1784143646"
      }
    ],
    "total": 1
  }
}