List Withdrawals

HTTP Method: GET
Endpoint URL: /withdrawal
Description: Retrieves a list of withdrawal requests 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 (CANCELLED, OPEN, APPROVED, COMPLETE).
page (number ≥ 0): Page index (default 0).
limit (number 1–100): Items per page (default 20).

Example cURL

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

Successful Response (200 OK)

{
	"data": [
		{
			"id": "285d8dce-7663-4580-ba7f-8afb2f2d3292",
			"txnId": "0xe7238caa68382485141be0443d6ba7efd0bd9f6bac5a624bd059acc53af1bf1d19",
			"amount": "1000.12345678",
			"receivedAmount": "1000.12345678",
			"status": "OPEN",
			"createdAt": "2025-05-20T12:34:56Z",
			"updatedAt": "2025-05-20T12:34:56Z"
		},
		{
			"id": "a7c3f2b1-1234-5678-9abc-def012345678",
			"txnId": "0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890",
			"amount": "500.00",
			"receivedAmount": "500.00",
			"status": "COMPLETE",
			"createdAt": "2025-05-19T10:00:00Z",
			"updatedAt": "2025-05-19T10:00:00Z"
		}
	],
	"page": 0,
	"limit": 20,
	"total": 17
}