List payment pages

GET

/payment-pages

Returns a paginated list of payment pages belonging to the authenticated entity, ordered newest first. A payment page is a hosted, shareable checkout that collects payment against an underlying payment intent, and can be configured for single or repeated use, a fixed or dynamic amount, and custom additional fields. Use the optional query parameters to filter by status. Pagination is cursor-based: pass the cursor value from the previous response's meta.pagination.cursor field to fetch the next page. When has_more is false, you have reached the end of the list.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

Responses

🟢200

application/json

Payment pages retrieved successfully. Returns a page of payment pages and pagination metadata.

Bodyapplication/json

🟠400

🟠401

Request Example

Shell

JavaScript

Java

Swift

curl --location '/payment-pages?status=published&cursor=01HQZR2BKPFQ8MXJVT3G7LWNA&limit=20' \
--header 'Authorization: Bearer <token>'

Response Example

200 - First page — more results available

{
    "message": "Payment pages retrieved successfully",
    "status": "success",
    "data": [
        {
            "id": "01HQZR2BKPFQ8MXJVT3G7LWNZ",
            "entity_id": "01HQZR2BKPFQ8MXJVT3G7LWNA",
            "account_id": "01HQZR2BKPFQ8MXJVT3G7LWNC",
            "currency": "NGN",
            "amount": 500000,
            "name": "Q3 Conference Ticket",
            "title": "Register for the Q3 Conference",
            "display_image": "https://cdn.example.com/pages/conference-display.png",
            "cover_image": "https://cdn.example.com/pages/conference-cover.png",
            "slug": "q3-conference-ticket",
            "status": "published",
            "payment_intent_id": "01HQZR2BKPFQ8MXJVT3G7LWNE",
            "client_reference": "page-ref-20260806-001",
            "client_meta": {
                "department": "events"
            },
            "expires_at": 1767225600000,
            "qr_image_data": null,
            "configuration": {
                "is_single_use": false,
                "max_payments_allowed": 100,
                "amount_settings": {
                    "is_dynamic_amount": false,
                    "min": null,
                    "max": null
                },
                "thank_you_note": "Thanks for registering — see you at the conference!",
                "additional_fields": [
                    {
                        "name": "T-shirt size",
                        "type": "text",
                        "is_required": true,
                        "display_order": 0
                    }
                ]
            },
            "stats": {
                "total_payments": 12,
                "max_allowed_total_payments": 100
            },
            "created": 1754524800000,
            "updated": 1754524800000
        }
    ],
    "meta": {
        "pagination": {
            "cursor": "01HQZR2BKPFQ8MXJVT3G7LWNZ",
            "has_more": true
        }
    }
}

Modified at 2026-09-15 11:41:25

Create a payment page

Delete a payment page