Skip to content

Withdrawal status

GET
/withdraw/status/{orderId}

orderId is URL-safe and is passed as is, no encoding needed.

Read the state from detail.code: 10000 — the TRX was sent, 10001 — queued or sending, 5003 — failed, with the reason in error_message.

Authorizations

ApiKeyAuth

API key from the dashboard. Some Host Mode endpoints also accept the key as an api_key field in the request body — this is stated in the schema of the particular operation.

Type
API Key (header: X-API-KEY)

Parameters

Header Parameters

X-Real-IP*

An IP address from the key's whitelist. A request from an address outside the whitelist is rejected with 401.

Type
string
Required
Example"203.0.113.10"
Format
"ipv4"

Path Parameters

orderId*
Type
string
Required

Responses

State of the request.

application/json
JSON
{
  
"detail": {
  
  
"code": 10000,
  
  
"status": "string",
  
  
"msg": "string",
  
  
"data": {
  
  
  
"orderId": "string",
  
  
  
"amount": 0,
  
  
  
"fee": 0,
  
  
  
"net": 0,
  
  
  
"address": "TQn9Y2khEsLJW1ChVWFMSMeRDow5KcbLSE",
  
  
  
"processed_at": "string",
  
  
  
"error_message": "string"
  
  
}
  
}
}

Playground

Authorization
Headers
Variables
Key
Value

Samples

Powered by VitePress OpenAPI