Retrieve a published payment page by slug

GET

/public-payment-pages/{slug}

Fetches the public-facing details of a payment page using its unique, human-readable slug. This endpoint is unauthenticated and intended to power the checkout UI a payer sees when they visit a shareable payment page link — it only ever returns pages that are currently published and not expired, and never exposes internal fields like entity_id or account_id.

If the page has been unpublished, deleted, or its expires_at timestamp has passed, the endpoint responds as if the page does not exist (404).

Request

Path Params

Responses

🟢200

application/json

The payment page is published and not expired; its public details are returned.

Bodyapplication/json

🟠400

🟠404

Response Example

200 - Success

{
    "message": "Payment page retrieved successfully",
    "status": "success",
    "data": {
        "id": "01HXYZ1234567890ABCDEFGHIJ",
        "slug": "support-the-team-8f2a1c",
        "name": "Q3 Fundraiser Page",
        "title": "Support the Team",
        "display_image": "https://cdn.example.com/pages/display-8f2a1c.png",
        "cover_image": "https://cdn.example.com/pages/cover-8f2a1c.png",
        "currency": "NGN",
        "amount": 500000,
        "status": "published",
        "expires_at": null,
        "configuration": {
            "is_single_use": false,
            "amount_settings": {
                "is_dynamic_amount": false,
                "min": null,
                "max": null
            },
            "thank_you_note": "Thank you so much for your support!",
            "additional_fields": [
                {
                    "name": "T-shirt size",
                    "type": "text",
                    "is_required": true,
                    "display_order": 1
                }
            ]
        }
    }
}

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

Retrieve a payment page

Create an invoice