List Payments

HTTP Method: GET
Endpoint URL: /payment
Description: Retrieves a list of payments 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 payment IDs.
invoices (string[]): Filter by one or more invoice identifiers.
statuses (string[]): Filter by payment status (OPEN, EXPIRED, etc.).
page (number ≥ 1): Page number (default 1).
limit (number 1–100): Items per page (default 20).

Example cURL

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

Successful Response (200 OK)

{
	"data": [
		{
			"id": "285d8dce-7663-4580-ba7f-8afb2f2d3292",
			"amount": "1000.00",
			"totalReceivedAmount": "20.00",
			"status": "OPEN",
			"createdAt": "2025-05-20T12:34:56Z",
			"updatedAt": "2025-05-20T12:34:56Z"
		},
		{
			"id": "a7c3f2b1-1234-5678-9abc-def012345678",
			"amount": "250.00",
			"totalReceivedAmount": "250.00",
			"status": "EXPIRED",
			"createdAt": "2025-05-19T09:15:00Z",
			"updatedAt": "2025-05-19T09:15:00Z"
		}
	],
	"page": 1,
	"limit": 20,
	"total": 42
}