Sign in

v1

latestOpenAPI 3.1.02026-07-2172050.9 KB
wallet

Query Withdrawal Records

Query account withdrawal records list based on filter criteria.

get/v1/pay/wallet/withdrawals

Query parameters

currencystring

Specify currency to query, returns all currencies if empty.

withdraw_idstring

Withdrawal record ID (starts with 'w', e.g. w1879219868), queries single record if specified

asset_class'SPOT' | 'PILOT'

Currency type (Main/Pilot zone), empty by default. Values: SPOT, PILOT.

withdraw_order_idstring

User-defined withdrawal order number for specific record query

frominteger

Start timestamp (Unix) units in seconds, defaults to last 7 days. Query time range cannot exceed 30 days.

tointeger

End timestamp (Unix) units in seconds, defaults to current time.

limitinteger

Maximum number of records to return.

offsetinteger

Return record offset (starts from 0).

Headers

X-GatePay-Certificate-ClientIdstring required
Example:4186d0c6-6a35-55a9-8dc6-5312769dbff8

The clientId assigned when the merchant registers an application in the Gate merchant console.

X-GatePay-Signaturestring required

Request signature. GatePay uses this signature to verify whether the request is valid.

X-GatePay-Timestampstring required
Example:1672905655498

UTC timestamp in milliseconds when the request is generated. GatePay will not process requests where the difference from the receive time exceeds 10 seconds.

X-GatePay-Noncestring required
Example:9578

Random string. Must comply with HTTP header rules; recommended length is within 32 characters, composed of digits and letters.

Response

Withdrawal records list

idstring

Transaction record ID.

txidstring

Blockchain transaction hash

block_numberstring

Block number

withdraw_order_idstring

Client order ID (max 32 chars, only allows numbers/letters/_/-/.).

timestampstring

Operation time (Unix timestamp in seconds).

amountstring

Amount of currency.

feestring

Fee amount.

currencystring

Currency name.

addressstring

Withdrawal address.

fail_reasonstring

Failure reason (only when status = CANCEL).

timestamp2string

Final status time: CANCEL - Cancellation time; DONE (block_number>0) - Success time.

memostring

Transaction memo/notes.

statusstring

Transaction status: DONE (Completed, block_number > 0 means on-chain confirmed), CANCEL (Cancelled), REQUEST (Requesting), MANUAL (Pending manual review), BCODE (Top-up code operation), EXTPEND (Sent awaiting confirmation), FAIL (On-chain failure awaiting confirmation), INVALID (Invalid order), VERIFY (Verifying), PROCES (Processing), PEND (Processing), DMOVE (Pending manual review), REVIEW (Under review).

chainstring

Withdrawal chain name.