Skip to content
Withdrawal Application

Withdrawal Application

Queries Withdrawal Application 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/va_coin_withdraw_applications

Dataset endpoints are available on the Test host only (https://b-api.longbridge.xyz); the Production host returns 404.

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

AuthorizationstringheaderRequired

Send the Broker ACCESS_TOKEN as Authorization: Bearer <token>.

Permission

atm.crypto_currency_withdrawal_application_inquiry

The Broker ACCESS_TOKEN must be granted the permission below, or the call will be rejected.

Query parameters

filtersobject

Filters. Combines business filters. Omit a filter field to disable that filter.

Child attributes
idstring

ID. Filters results by ID.

order_nostring

Application No.. Filters results by Application No..

member_idstring

Client ID. Filters results by Client ID.

account_nostring

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

module_member_idstring

Client ID. Filters results by Client ID.

coinstring

Currency Code. Filters results by Currency Code.

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

statusstring

Status. Filters results by Status.

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

locking locked locked_wait_allocate locked_wait_audit · Pending Submitsend · Processingsuccess · Successfailed · Failedreject · Rejected

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.

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

order_nostring

Application No.. Returned value: Application No..

account_nostring

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

member_idstring

Client ID. Returned value: Client ID.

client_namestring

Client Name. Returned value: Client Name.

channel_wallet_idstring

Wallet ID. Returned value: Wallet ID.

client_wallet_addressstring

Client Wallet Address. Returned value: Client Wallet Address.

coinstring

Currency Code. Returned value: Currency Code.

pricing_currencystring

Pricing Currency. Returned value: Pricing Currency.

pricing_quantity_displaystring

Contract Debit. Returned value: Contract Debit.

pricing_fee_displaystring

Fee Debit. Returned value: Fee Debit.

chain_typestring

Network. Returned value: Network.

vasp_namestring

Vasp Name. Returned value: Vasp Name.

vasp_websitestring

Vasp Website. Returned value: Vasp Website.

self_hostedstring

Self Hosted. Returned value: Self Hosted.

recipient_family_namestring

Recipient Family Name. Returned value: Recipient Family Name.

recipient_given_namestring

Recipient Given Name. Returned value: Recipient Given Name.

tagstring

Tag. Returned value: Tag.

quantitystring

Total Quantity. Returned value: Total Quantity.

estimated_fee_coinstring

Fee Currency Code. Returned value: Fee Currency Code.

crypto_fee_detail_displaystring

Whale Fee. Returned value: Whale Fee.

custom_fee_quantitystring

Channel Fee. Returned value: Channel Fee.

fiat_feestring

Fiat Fee (Equivalent USD). Returned value: Fiat Fee (Equivalent USD).

exchange_ratestring

USD Rate. Returned value: USD Rate.

net_quantitystring

Actual Withdrawal Qty. Returned value: Actual Withdrawal Qty.

statusstring

Status. Returned value: Status.

status_valstring

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.

upstream_brokerstring

Channel. Returned value: Channel.

channel_status_textstring

Channel Return Reason-Status Text. Returned value: Channel Return Reason-Status Text.

channel_failure_reasonstring

Channel Return Reason-Failure Reason. Returned value: Channel Return Reason-Failure Reason.

custom_channel_return_reasonstring

Channel Return Reason. Returned value: Channel Return Reason.

bank_request_idstring

Serial No.-Channel Serial No.. Returned value: Serial No.-Channel Serial No..

chain_transaction_idstring

Serial No.-Block Chain Hash. Returned value: Serial No.-Block Chain Hash.

channel_serial_nostring

Serial No.-Transfer ID. Returned value: Serial No.-Transfer ID.

ref_nostring

Serial No.-Ref No. Returned value: Serial No.-Ref No.

custom_serial_nostring

Serial No.. Returned value: Serial No..

created_atstring

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

channel_debited_timestring

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

updated_atstring

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

custom_timestring

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

audit_rule_idstring

Rule Name. Returned value: Rule Name.

audit_rule_id_valstring

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

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