Skip to main content
GET
/
payment
/
open
/
institution
/
v1
/
pay
/
wallet
/
withdrawals
Query Withdrawal Records
curl --request GET \
  --url https://openplatform.gateapi.io/payment/open/institution/v1/pay/wallet/withdrawals \
  --header 'X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>' \
  --header 'X-GatePay-Nonce: <x-gatepay-nonce>' \
  --header 'X-GatePay-On-Behalf-Of: <x-gatepay-on-behalf-of>' \
  --header 'X-GatePay-Signature: <x-gatepay-signature>' \
  --header 'X-GatePay-Timestamp: <x-gatepay-timestamp>'
[
  {
    "id": "w1879219868",
    "currency": "USDT",
    "address": "THISISTESTADDRESSFORGATEPAY",
    "amount": "4.023",
    "fee": "0",
    "txid": "Internal transaction 260594131",
    "chain": "BSC",
    "timestamp": "1745220149",
    "status": "DONE",
    "withdraw_order_id": "202504211521368538928",
    "block_number": "1000",
    "fail_reason": "",
    "type": "appbankgp",
    "timestamp2": "1745220149",
    "memo": ""
  }
]

​
Overview

This page documents the GET /payment/open/institution/v1/pay/wallet/withdrawals endpoint. The full schema, parameters, and examples are rendered from the linked OpenAPI definition above.

​
Notes

Headers

​
X-GatePay-Certificate-ClientId
string
required

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

Example:

"4186d0c6-6a35-55a9-8dc6-5312769dbff8"

​
X-GatePay-Signature
string
required

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

​
X-GatePay-Timestamp
string
required

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

Example:

"1672905655498"

​
X-GatePay-Nonce
string
required

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

Example:

"9578"

​
X-GatePay-On-Behalf-Of
string
required

Required delegated-subject header. Provide the initiating account ID for this request. For institution merchant APIs, this is typically the target sub-account ID; for institution charge and transfer APIs, it can be either an institution account ID or a sub-account ID.

Query Parameters

​
currency
string

Specify currency to query, returns all currencies if empty.

​
withdraw_id
string

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

​
asset_class
enum<string>

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

Available options:
SPOT,
PILOT
​
withdraw_order_id
string

User-defined withdrawal order number for specific record query

​
from
integer<int64>

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

​
to
integer<int64>

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

​
limit
integer

Maximum number of records to return.

​
offset
integer

Return record offset (starts from 0).

Response

200 - application/json

Withdrawal records list

​
id
string

Transaction record ID.

​
txid
string

Blockchain transaction hash

​
block_number
string

Block number

​
withdraw_order_id
string

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

​
timestamp
string

Operation time (Unix timestamp in seconds).

​
amount
string

Amount of currency.

​
fee
string

Fee amount.

​
currency
string

Currency name.

​
address
string

Withdrawal address.

​
fail_reason
string

Failure reason (only when status = CANCEL).

​
timestamp2
string

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

​
memo
string

Transaction memo/notes.

​
status
string

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

​
chain
string

Withdrawal chain name.