Retrieve a payment page

GET

/payment-pages/{id}

Fetch a single payment page owned by the authenticated entity, by its unique identifier. Returns the page's configuration (amount settings, single-use/multi-use limits, thank-you note, additional collected fields) along with lightweight usage stats (total_payments and max_allowed_total_payments). The page must belong to the authenticated entity — pages belonging to other entities are reported as not found.

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 ********************

Path Params

Responses

🟢200

application/json

The payment page was found and returned successfully.

Bodyapplication/json

🟠401

🟠404

Request Example

Shell

JavaScript

Java

Swift

curl --location '/payment-pages/01J8Z3K9N4Q7R2M5T6V8W0X1Y2' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Success

{
    "message": "Payment page retrieved successfully",
    "status": "success",
    "data": {
        "id": "01J8Z3K9N4Q7R2M5T6V8W0X1Y2",
        "entity_id": "01H8XW3B5K9P2M6Q7R1T4V0Z3A",
        "account_id": "01H9Y4C6L0Q3N7R8S2U5W1A4B6",
        "currency": "NGN",
        "amount": 500000,
        "name": "Q3 Conference Ticket",
        "title": "Q3 Developer Conference — General Admission",
        "display_image": "https://cdn.example.com/pages/display.png",
        "cover_image": "https://cdn.example.com/pages/cover.png",
        "slug": "q3-conference-ticket-8fa1",
        "status": "published",
        "payment_intent_id": "01J1A2B3C4D5E6F7G8H9J0K1L2",
        "client_reference": "conf-2026-q3-ticket",
        "client_meta": {
            "campaign": "q3-launch"
        },
        "expires_at": 1798761600000,
        "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 your payment — see you at the conference!",
            "additional_fields": [
                {
                    "name": "T-shirt size",
                    "type": "text",
                    "is_required": true,
                    "display_order": 1
                }
            ]
        },
        "stats": {
            "total_payments": 42,
            "max_allowed_total_payments": 100
        },
        "created": 1755000000000,
        "updated": 1755000000000
    }
}

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

Edit a payment page

Retrieve a published payment page by slug