Skip to main content
POST
/
v1
/
ramp
/
withdraw
Create Withdraw
curl --request POST \
  --url https://api-sandbox.uqpaytech.com/api/v1/ramp/withdraw \
  --header 'Content-Type: application/json' \
  --header 'x-auth-token: <api-key>' \
  --data '
{
  "currency": "USDC",
  "network": "ETH",
  "amount": "100",
  "withdraw_address": "0x0993446fBB19f4e828768515eF7A9408B5F1A000",
  "reason": "test",
  "memo": "test"
}
'
{
  "code": 200,
  "message": "Success",
  "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"
  }
}

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.

​
x-idempotency-key
string<uuid>

A unique identifier (UUID) used to maintain operation idempotency, ensuring that repeated executions of the same operation do not result in unintended effects or duplication. It helps preserve data consistency in the face of network errors, retries, or failures.

Body

application/json
​
currency
string
required

Withdrawal currency

Example:

"USDC"

​
network
string
required

Network code

Example:

"ETH"

​
amount
string
required

Withdrawal amount

Example:

"100"

​
withdraw_address
string
required

Withdrawal address

Example:

"0x0993446fBB19f4e828768515eF7A9408B5F1A000"

​
reason
string
required

Withdrawal reason

Example:

"test"

​
memo
string

Withdrawal memo

Example:

"test"

Response

Withdrawal created successfully

​
code
integer
required
Example:

200

​
message
string
required
Example:

"Success"

​
data
object
required

Response data for Create Withdraw (4.5.1) - 13 fields