Withdrawal Records

Queries Withdrawal 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_withdraw_all_details_simple

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.withdraw_detailcmbc.withdraw_detail_allRequired

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

order_idstring

Application Number. Filters results by Application Number.

member_idstring

Member ID. Filters results by Member ID.

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

batch_idstring

Batch ID. Filters results by Batch ID.

deposit_lb_bank_account_idstring

Original Deposit Bank. Filters results by Original Deposit Bank.

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

remarkstring

Remarks. Filters results by Remarks.

statestring

Withdrawal Status. Filters results by Withdrawal Status.

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

Allowed values:

0 - Unknown
1 - Unprocessed
2 - Processing
3 - Success
4 - Failed
5 - Cancelled
6 - Backed
7 - Update result pending approval
8 - Deleted

012345678

withdraw_typestring

Withdrawal Type. Filters results by Withdrawal Type.

Allowed values:

1, - Client Withdrawal
3, - Set As Withdrawal
7, - Refund
,1 - Manual Withdrawal
6, - Bank Withdrawal

1,3,7,,16,

bills_idstring

Withdrawal Bill ID. Filters results by Withdrawal Bill ID.

created_atobject

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

lb_bank_channel_idstring

Channel. Filters results by Channel.

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

charge_typestring

Bank Cost Paid By. Filters results by Bank Cost Paid By.

Allowed values: SHA, OUR, BEN

SHAOURBEN

idstring

Withdrawal ID. Filters results by Withdrawal ID.

to_bank_accountstring

Beneficiary Account. Filters results by Beneficiary Account.

to_bank_namestring

Beneficiary Bank. Filters results by Beneficiary Bank.

to_namestring

Beneficiary Name. Filters results by Beneficiary Name.

amountobject

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

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.

account_atobject

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

bank_namestring

Company Bank. Filters results by Company Bank.

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

statesstring

Withdraw Status. Filters results by Withdraw Status.

batch_statestring

Batch Status. Filters results by Batch Status.

Allowed values:

0 - Packed
1 - Pending Approval
2 - Approved
4 - Done
5 - Cancelled

01245

bank_channel_serial_nostring

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

hit_rulesstring

Hit Rules. Filters results by Hit Rules.

Values are dynamic. Call GET /v1/datasets/refs/risk_rule_indicators_withdraw 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 Withdrawal 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

batch_idstring

Batch ID. Returned value: Batch ID.

order_idstring

Application Number. Returned value: Application Number.

order_id_valstring

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

idstring

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

lba_bank_accountstring

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

lba_bank_namestring

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

lba_account_type_namestring

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

lba_account_type_name_valstring

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

lba_currencystring

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

lbc_namestring

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

charge_typestring

Company Bank Account - Bank Cost Paid By. Returned value: Company Bank Account - Bank Cost Paid By.

custom_company_bank_accountstring

Company Bank Account. Returned value: Company Bank Account.

member_idstring

Member - Member ID. Returned value: Member - Member ID.

member_id_valstring

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

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

custom_memberstring

Member. Returned value: Member.

withdraw_type_concatstring

Withdrawal Type. Returned value: Withdrawal Type.

withdraw_type_concat_valstring

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

deposit_lb_bank_account_idstring

Original Deposit Bank. Returned value: Original Deposit Bank.

deposit_lb_bank_account_id_valstring

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

hit_rulesstring

Hit Rule. Returned value: Hit Rule.

hit_rules_valstring

Hit Rule (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.

bank_channel_serial_nostring

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

to_bank_accountstring

Beneficiary Bank - Beneficiary Account. Returned value: Beneficiary Bank - Beneficiary Account.

to_namestring

Beneficiary Bank - Beneficiary Name. Returned value: Beneficiary Bank - Beneficiary Name.

to_bank_namestring

Beneficiary Bank - Bank Name. Returned value: Beneficiary Bank - Bank Name.

to_bank_codestring

Beneficiary Bank - Bank Code. Returned value: Beneficiary Bank - Bank Code.

to_bank_regionstring

Beneficiary Bank - Bank Region. Returned value: Beneficiary Bank - Bank Region.

to_bank_region_valstring

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

to_countrystring

Beneficiary Bank - Country/Region. Returned value: Beneficiary Bank - Country/Region.

to_swift_codestring

Beneficiary Bank - Swift Code. Returned value: Beneficiary Bank - Swift Code.

fps_accountstring

Beneficiary Bank - FPS ID. Returned value: Beneficiary Bank - FPS ID.

addressstring

Beneficiary Bank - Beneficiary Address. Returned value: Beneficiary Bank - Beneficiary Address.

custom_beneficiary_bankstring

Beneficiary Bank. Returned value: Beneficiary Bank.

post_customstring

Bank Statement Remarks. Returned value: Bank Statement Remarks.

to_currencystring

Currency. Returned value: Currency.

to_currency_valstring

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

to_amountstring

Debit Amount. Returned value: Debit Amount.

feestring

Handling Fee. Returned value: Handling Fee.

taxstring

GST. Returned value: GST.

actual_to_amountstring

Actual Withdrawal Amount. Returned value: Actual Withdrawal Amount.

custom_to_amountstring

Amount. Returned value: Amount.

statestring

Withdrawal Status. Returned value: Withdrawal Status.

state_valstring

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

wb_statestring

Batch Status. Returned value: Batch Status.

wb_state_valstring

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

custom_statesstring

Status. Returned value: Status.

account_atstring

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

created_atstring

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

updated_atstring

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

custom_datesstring

Date. Returned value: Date.

bills_idstring

Withdrawal Bill ID. Returned value: Withdrawal Bill ID.

order_remarkstring

Remarks - Application remarks. Returned value: Remarks - Application remarks.

remarkstring

Remarks - Withdrawal Processing Remarks. Returned value: Remarks - Withdrawal Processing Remarks.

custom_remarksstring

Remarks. Returned value: Remarks.

creatorstring

Processed By. Returned value: Processed By.

auditorstring

Approved By. Returned value: Approved By.

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_withdraw_all_details_simple' \
  --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": [
      {
        "batch_id": "40455",
        "order_id": "377344",
        "order_id_val": "",
        "id": "170096",
        "lba_bank_account": "示例用户",
        "lba_bank_name": "072-072 ICBC (Asia) Ltd",
        "lba_account_type_name": "ALL",
        "lba_account_type_name_val": "ALL",
        "lba_currency": "ALL",
        "lbc_name": "",
        "charge_type": "",
        "custom_company_bank_account": "示例用户",
        "member_id": "1000000000000000000",
        "member_id_val": "",
        "channel_account": "H00000000",
        "custom_member": "Member ID:1000000000000000000\nA/C No.:H00000000",
        "withdraw_type_concat": "Refund",
        "withdraw_type_concat_val": "7",
        "deposit_lb_bank_account_id": "示例用户",
        "deposit_lb_bank_account_id_val": "示例用户",
        "hit_rules": "",
        "hit_rules_val": "",
        "bank_channel_serial_no": "",
        "to_bank_account": "",
        "to_name": "",
        "to_bank_name": "",
        "to_bank_code": "",
        "to_bank_region": "",
        "to_bank_region_val": "",
        "to_country": "",
        "to_swift_code": "",
        "fps_account": "",
        "address": "",
        "custom_beneficiary_bank": "\n\n\n\n\n\n\n\n",
        "post_custom": "W/D FOR H00000000 Long Bridge HK Limited",
        "to_currency": "HKD",
        "to_currency_val": "HKD",
        "to_amount": "88.00",
        "fee": "0.00",
        "tax": "--",
        "actual_to_amount": "88.00",
        "custom_to_amount": "Withdrawal Amount:88.00\nHandling Fee:0.00\n\nActual Withdrawal Amount:88.00",
        "state": "Success",
        "state_val": "3",
        "wb_state": "Done",
        "wb_state_val": "4",
        "custom_states": "Withdrawal Status:Success\nBatch Status:Done",
        "account_at": "2026-07-16 11:41:30",
        "created_at": "2026-07-16 11:36:43",
        "updated_at": "2026-07-16 11:41:30",
        "custom_dates": "Debit Date:2026-07-16 11:41:30\nCreated At:2026-07-16 11:36:43\nUpdated At:2026-07-16 11:41:30",
        "bills_id": "--",
        "order_remark": "",
        "remark": "",
        "custom_remarks": "--",
        "creator": "示例用户",
        "auditor": "示例用户"
      }
    ],
    "total": 435
  }
}