Skip to content
Withdrawal Request

Withdrawal Request

Queries Withdrawal Request 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_applications

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.user_withdraw_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
member_idstring

Client. Filters results by Client.

idstring

Application Number. Filters results by Application Number.

statusstring

Application Status. Filters results by Application Status.

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

Allowed values:

  • 0 99 - To be Submitted
  • 7 - Submitted
  • 1 - Processing
  • 2 - Rejected
  • 3 - Cancelled
  • 4 - Done
  • 5 - Failed
  • 6 - Returned
  • 9 - Modification pending approval
  • 10 - Delete pending approval
  • 11 - Deleted
  • 12 - Reject pending approval
  • 13 - Pending Review

0 997123456910111213

originstring

Withdrawal Type. Filters results by Withdrawal Type.

Allowed values:

  • 0 - Client Withdrawal
  • 1 - Manual Withdrawal
  • 2 - Bank Withdrawal

012

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

Packing Status. Filters results by Packing Status.

Allowed values:

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

01245

wd_idstring

Withdraw ID. Filters results by Withdraw ID.

created_atobject

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

approval_atobject

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

wb_created_atobject

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

anti_cheat_task_statusstring

Risk Status. Filters results by Risk Status.

Allowed values:

  • =, - Unknown
  • ~waiting_request/waiting_response - Risk Control In Progress
  • finish,= - Not Targeted
  • finish,!= - Targeted

=,~waiting_request/waiting_responsefinish,=finish,!=

audit_limit_timeobject

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

remarkstring

Remark. Filters results by Remark.

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.

not_rulestring

No transactions Rule. Filters results by No transactions Rule.

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.

to_bank_namestring

Beneficiary Bank. Filters results by Beneficiary Bank.

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

Application Number. Returned value: Unique identifier of the current record.

id_valstring

Application Number (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.

wd_idstring

Withdrawal ID. Returned value: Withdrawal ID.

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.

channel_accountstring

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

lookup_valuestring

Withdrawable Amount (reference). Returned value: Withdrawable Amount (reference).

custom_withdraw_amount_from_serverstring

Withdraw Amount. Returned value: Withdraw Amount.

wd_to_amountstring

Amount. Returned value: Amount.

wd_feestring

Handling Fees. Returned value: Handling Fees.

tax_downstring

GST. Returned value: GST.

wd_payment_amountstring

Debit Amount. Returned value: Debit Amount.

currencystring

Currency. Returned value: Currency.

custom_to_bank_name_from_serverstring

Beneficiary Bank. Returned value: Beneficiary Bank.

wc_created_at_for_customstring

Linked Date. Returned value: Linked Date.

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.

audit_rule_idstring

Audit Rule ID. Returned value: Audit Rule ID.

audit_rule_id_valstring

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

uwa_created_atstring

Withdrawal Request Create at. Returned value: Withdrawal Request Create at. The date or time format follows the value returned by the API.

uwa_approval_atstring

Withdrawal Request Approval Time. Returned value: Withdrawal Request Approval Time. The date or time format follows the value returned by the API.

uwa_account_atstring

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

uwa_canceled_atstring

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

uwa_audit_limit_timestring

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

wb_created_at_for_customstring

Batch Time. Returned value: Batch Time.

lbc_namestring

Batch Channel. Returned value: Batch Channel.

lbc_name_valstring

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

originstring

Withdraw Type. Returned value: Withdraw Type.

origin_valstring

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

audit_typestring

Audit Type. Returned value: Audit Type.

audit_type_valstring

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

statusstring

Withdrawal application status. Returned value: Withdrawal application status.

status_valstring

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

custom_anti_cheat_task_status_from_serverstring

Risk Status. Returned value: Risk Status.

to_namestring

Payee Name. Returned value: Payee Name.

to_bank_codestring

Payee Bank Code. Returned value: Payee Bank Code.

to_bank_namestring

Due Bank. Returned value: Due Bank.

to_bank_accountstring

Payee Bank Account. Returned value: Payee Bank Account.

to_addressstring

Payee Address. Returned value: Payee Address.

to_swift_codestring

To Swift Code. Returned value: To Swift Code.

to_countrystring

Country. Returned value: Country.

custom_remarkstring

Remarks. Returned value: Remarks.

custom_payment_remarkstring

Payment Remark. Returned value: Payment Remark.

custom_fee_remarkstring

Cost Remark. Returned value: Cost Remark.

custom_last_remarkstring

Last Remarks. Returned value: Last Remarks.

custom_remark_from_serverstring

Remark. Returned value: Remark.

custom_detail_created_atstring

Withdrawal Record Create at. Returned value: Withdrawal Record Create at. The date or time format follows the value returned by the API.

custom_time_from_serverstring

Time. Returned value: Time.

custom_batch_from_serverstring

Packing Batch. Returned value: Packing Batch.

type_customstring

Type. Returned value: Type.

status_customstring

Status. Returned value: Status.

params_customstring

Parameters. Returned value: Parameters.

aml_remarkstring

Mark Remark. Returned value: Mark Remark.

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