Withdrawal - Pending

Queries Withdrawal - Pending 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_pending_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.withdraw_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

order_idstring

Application Number. Filters results by Application Number.

member_idstring

Client. Filters results by Client.

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

to_bank_regionstring

To Bank Region. Filters results by To Bank Region.

Allowed values:

HONGKONG - Banks In Hong Kong
SINGAPORE - Banks In Singapore
ABROAD - Banks In Other Regions
USA - Banks In The U. S.
AUSTRALIA - Banks In Australia
MALAYSIA - Banks In Malaysia

HONGKONGSINGAPOREABROADUSAAUSTRALIAMALAYSIA

to_bank_accountstring

Credit Bank Account. Filters results by Credit Bank Account.

to_bank_namestring

Credit Bank Name. Filters results by Credit Bank Name.

remarkstring

Remark. Filters results by Remark.

withdraw_typestring

Withdraw Type. Filters results by Withdraw Type.

Allowed values:

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

1,3,7,,16,

idstring

Withdraw ID. Filters results by Withdraw ID.

created_atobject

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

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.

uwa_created_atobject

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

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.

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

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

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.

uwa_created_atstring

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

uwa_approval_atstring

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

channel_accountstring

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

order_idstring

Application Number. Returned value: Application Number.

withdraw_type_concatstring

Withdraw Type. Returned value: Withdraw Type.

withdraw_type_concat_valstring

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

custom_deposit_lb_bank_account_idstring

Original Deposit Bank. Returned value: Original Deposit Bank.

custom_deposit_lb_bank_account_id_valstring

Original Deposit Bank (raw value). Raw value of custom_deposit_lb_bank_account_id. The custom_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.

to_bank_regionstring

To Bank Region. Returned value: To Bank Region.

to_bank_region_valstring

To 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_namestring

Name of Creditor. Returned value: Name of Creditor.

wc_addressstring

Receiving Address. Returned value: Receiving Address.

to_bank_accountstring

Credit Bank Account. Returned value: Credit Bank Account.

to_bank_namestring

Credit Bank Name. Returned value: Credit Bank Name.

to_swift_codestring

To Swift Code. Returned value: To Swift Code.

to_countrystring

Country. Returned value: Country.

to_currencystring

Currency. Returned value: Currency.

to_amountstring

Client Requested Amount. Returned value: Client Requested Amount.

feestring

Fee. Returned value: Fee.

taxstring

GST. Returned value: GST.

actual_to_amountstring

Debit Amount. Returned value: Debit Amount.

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_pending_details' \
  --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": "167584",
        "member_id": "1000000000000000000",
        "member_id_val": "",
        "uwa_created_at": "",
        "uwa_approval_at": "",
        "channel_account": "H00000000",
        "order_id": "368472",
        "withdraw_type_concat": "Set As Withdrawal",
        "withdraw_type_concat_val": "3",
        "custom_deposit_lb_bank_account_id": "示例用户",
        "custom_deposit_lb_bank_account_id_val": "示例用户",
        "hit_rules": "",
        "hit_rules_val": "",
        "to_bank_region": "Banks in Hong Kong",
        "to_bank_region_val": "HONGKONG",
        "to_name": "LI YANG",
        "wc_address": "",
        "to_bank_account": "示例用户",
        "to_bank_name": "012 Bank of China (HK)",
        "to_swift_code": "BKCHHKHHXXX",
        "to_country": "Hong Kong",
        "to_currency": "HKD",
        "to_amount": "11.00",
        "fee": "0.00",
        "tax": "--",
        "actual_to_amount": "11.00"
      }
    ],
    "total": 275
  }
}