Get Withdrawal

HTTP Method: GET
Endpoint URL: /withdrawal/:id
Description: Fetches a specific withdrawal request by its unique ID.
Security: Requires the API-KEY header.

Path Parameter

• :id — the UUID of the withdrawal to retrieve (e.g. 5f5a8ced-5c6a-4038-9d73-662441242fd3)

Request Headers

• API-KEY: your_account_api_key

Example cURL

curl https://api.alppay.io/v2/withdrawal/5f5a8ced-5c6a-4038-9d73-662441242fd3 \
  -H "API-KEY: ak_live_1234567890abcdef"

Successful Response (200 OK)

{
  "id": "5f5a8ced-5c6a-4038-9d73-662441242fd3",
  "txnId": "0xe7238caa68382485141be0443d6ba7efd0bd9f6bac5a624bd059acc53af1bf1d19",
  "amount": "10",
  "receivedAmount": "10",
  "asset": {
    "short": "USDT",
    "name": "Tether",
    "logoUrl": "https://cryptologos.cc/logos/tether-usdt-logo.png",
    "network": "tron"
  },
  "addressFrom": "TXkFpL3HmzE9KPpXGWNXdCbNcDYYn73U4C",
  "addressTo": "TPSMckmxoQBQWfUcasbUs2cRUdh2EMQu4n",
  "destTag": "",
  "status": "COMPLETE",
  "customer": {
    "id": 1,
    "name": "Customer Name",
    "email": "[email protected]"
  },
  "merchant": {
    "id": 1,
    "name": "TestMerchant",
    "email": "[email protected]",
    "siteUrl": "",
    "logoUrl": ""
  },
  "invoice": "your-system-invoice-id",
  "createdAt": "2025-08-07T09:08:58.780375195Z",
  "updatedAt": "2025-08-07T10:15:32.123456789Z",
  "timeToApprove": "2025-08-07T10:08:58.780375195Z"
}

Response Field Descriptions

• id — Unique UUID identifier of the withdrawal request
• txnId — Transaction ID on blockchain (empty string if not yet processed)
• amount — Requested withdrawal amount as decimal string
• receivedAmount — Amount actually sent as decimal string (0 until processed)
• asset — Asset details object:
  • short — Asset ticker symbol
  • name — Full asset name
  • logoUrl — URL to asset logo image
  • network — Blockchain network name
• addressFrom — Source wallet address (empty until processing)
• addressTo — Destination wallet address
• destTag — Destination tag/memo if applicable
• status — Current withdrawal status
• customer — Customer information:
  • id — Your internal customer identifier
  • name — Customer's name
  • email — Customer's email address
• merchant — Merchant account details:
  • id — Merchant ID in ALPPAY system
  • name — Merchant company name
  • email — Merchant contact email
  • siteUrl — Merchant website URL
  • logoUrl — Merchant logo URL
• invoice — Your internal invoice/reference ID
• createdAt — ISO 8601 timestamp of withdrawal creation
• updatedAt — ISO 8601 timestamp of last update
• timeToApprove — ISO 8601 timestamp when withdrawal will be auto-approved (null if manual approval required)

Withdrawal Status Values

• OPEN — Initial status, awaiting approval
• APPROVED — Withdrawal approved, pending blockchain processing
• COMPLETE — Successfully processed on blockchain
• CANCELLED — Withdrawal cancelled before processing

Error Responses

• 404 Not Found: Withdrawal ID does not exist
• 401 Unauthorized: Invalid or missing API key
• 429 Too Many Requests: Rate limit exceeded