Skip to main content
GET
/
v1
/
ramp
/
withdraw
List Withdraws
curl --request GET \
  --url https://api-sandbox.uqpaytech.com/api/v1/ramp/withdraw \
  --header 'x-auth-token: <api-key>'
{
  "code": 200,
  "message": "Success",
  "data": {
    "data": [
      {
        "order_id": "f75fdee5-0cc1-4b52-818e-497dd376cced",
        "short_order_id": "WD260124-N1PAAIXX",
        "order_status": "Pending",
        "order_type": "Withdraw",
        "currency": "USDC",
        "network": "ETH",
        "amount": "100",
        "withdraw_address": "0x0993446fBB19f4e828768515eF7A9408B5F1A000",
        "network_fee": "0.66",
        "processing_fee": "0",
        "actual_amount": "99.34",
        "reason": "test",
        "create_time": "2026-01-24 11:41:37 +08:00",
        "txid": "0x1234567890abcdef",
        "completed_time": "<string>"
      }
    ],
    "total_pages": 123,
    "total_items": 123
  }
}

Authorizations

​
x-auth-token
string
header
required

The API token for login provided by UQPay.

Headers

​
x-on-behalf-of
string

Specifies the sub-account on whose behalf the request is made. This should be set to the account_id, which can be retrieved via the List Connected Accounts API. If omitted or empty, the request is executed using the master account. More information at Connected Accounts.

Query Parameters

​
page_num
integer
default:1

Page number, default 1

Required range: x >= 1
​
page_size
integer
default:20

Items per page, default 20

Required range: x >= 1
​
currency
string

Filter by currency

​
network
string

Filter by network

​
status
string

Order status

​
start_time
string

Exclusive start time used to filter by create_time. ISO 8601 format.

Example:

"2024-03-01T00:00:00+08:00"

​
end_time
string

Exclusive end time used to filter by create_time. ISO 8601 format.

Example:

"2024-03-02T00:00:00+08:00"

Response

Successfully retrieved withdrawals

​
code
integer
required
Example:

200

​
message
string
required
Example:

"Success"

​
data
object
required