List Withdrawals

HTTP Method: GET
Endpoint URL: /withdrawal
Description: Retrieves a list of withdrawal requests with detailed information, filtered by query parameters.
Security: Requires the API-KEY header.

Query Parameters

txnIds (string[]): Filter by one or more transaction IDs
ids (string[]): Filter by one or more withdrawal IDs
invoices (string[]): Filter by one or more invoice identifiers
statuses (string[]): Filter by withdrawal status (OPEN, APPROVED, COMPLETE, CANCELLED)
page (number ≥ 0): Page index (default 0)
limit (number 1–100): Items per page (default 20)

Request Headers

API-KEY: your_account_api_key

Example cURL

curl "https://api.alppay.io/v2/withdrawal?statuses=OPEN&page=0&limit=20" \
  -H "API-KEY: ak_live_1234567890abcdef"

Example with Multiple Filters

curl "https://api.alppay.io/v2/withdrawal?statuses=OPEN,COMPLETE&limit=50&page=1" \
  -H "API-KEY: ak_live_1234567890abcdef"

Successful Response (200 OK)

{
  "data": [
    {
      "id": "5f5a8ced-5c6a-4038-9d73-662441242fd3",
      "txnId": "",
      "amount": "10",
      "receivedAmount": "0",
      "asset": {
        "short": "USDT",
        "name": "Tether",
        "logoUrl": "https://cryptologos.cc/logos/tether-usdt-logo.png",
        "network": "tron"
      },
      "addressFrom": "",
      "addressTo": "TPSMckmxoQBQWfUcasbUs2cRUdh2EMQu4n",
      "destTag": "",
      "status": "OPEN",
      "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-07T09:08:58.780375285Z",
      "timeToApprove": null
    },    {
      "id": "a7c3f2b1-1234-5678-9abc-def012345678",
      "txnId": "0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890",
      "amount": "500.00",
      "receivedAmount": "500.00",
      "asset": {
        "short": "USDC",
        "name": "USD Coin",
        "logoUrl": "https://cryptologos.cc/logos/usd-coin-usdc-logo.png",
        "network": "ethereum"
      },
      "addressFrom": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb1",
      "addressTo": "0x5D8D9C7f68A46634BCEaD2a6FF166A0BdFb08540",
      "destTag": "",
      "status": "COMPLETE",
      "customer": {
        "id": 2,
        "name": "Jane Smith",
        "email": "[email protected]"
      },
      "merchant": {
        "id": 1,
        "name": "TestMerchant",
        "email": "[email protected]",
        "siteUrl": "",
        "logoUrl": ""
      },
      "invoice": "INV-2024-002",
      "createdAt": "2025-08-06T14:22:15.123456789Z",
      "updatedAt": "2025-08-06T15:45:33.987654321Z",
      "timeToApprove": "2025-08-06T15:22:15.123456789Z"
    }
  ],
  "page": 0,
  "limit": 20,
  "total": 17
}

Response Fields

Pagination

data: Array of withdrawal objects
page: Current page index (0-based)
limit: Number of items per page
total: Total number of withdrawals matching the filters

Withdrawal Object Fields

id — Unique UUID identifier of the withdrawal
txnId — Blockchain transaction ID (empty until processed)
amount — Requested withdrawal amount
receivedAmount — Actually sent amount (0 until processed)
asset — Cryptocurrency details:
- short — Ticker symbol
- name — Full name
- logoUrl — Logo image URL
- network — Blockchain network
addressFrom — Source address (empty until processing)
addressTo — Destination wallet address
destTag — Destination tag/memo if applicable
status — Current withdrawal status
customer — Customer information
merchant — Merchant account details
invoice — Internal reference ID
createdAt — Creation timestamp (ISO 8601)
updatedAt — Last update timestamp (ISO 8601)
timeToApprove — Auto-approval timestamp (null if manual)

Status Values

OPEN — Awaiting approval
APPROVED — Approved, pending blockchain processing
COMPLETE — Successfully processed
CANCELLED — Cancelled before processing

Error Responses

401 Unauthorized: Invalid or missing API key
400 Bad Request: Invalid query parameters
429 Too Many Requests: Rate limit exceeded