Delete a payment page

DELETE

/payment-pages/{id}

Permanently removes a payment page belonging to the authenticated entity. The page is first marked as deleted (its status field is set to deleted and updated is refreshed) and its resulting state is returned, after which the underlying record is soft-deleted from storage. Once deleted, the page's public slug becomes unavailable and any subsequent payment attempts against it will fail. This action cannot be undone — there is no endpoint to restore a deleted payment page. The entity_id is derived from the bearer token, so you can only delete payment pages owned by your own entity.

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, marked as deleted, and removed successfully. The response reflects the page's final state at the moment of deletion.

Bodyapplication/json

🟠400

🟠401

🟠404

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Success

{
    "message": "Payment page deleted successfully",
    "status": "success",
    "data": {
        "id": "01J8Z3K9QW7XABCD1234EFGHJK",
        "entity_id": "01J8Z2H5N6P8QRSTUVWX9YZ012",
        "account_id": "01J8Z2QWERTY1234567890ABCD",
        "currency": "NGN",
        "amount": 5000,
        "name": "September Fundraiser",
        "title": "Support Our September Drive",
        "display_image": null,
        "cover_image": null,
        "slug": "september-fundraiser-8f2a1c",
        "status": "deleted",
        "payment_intent_id": "01J8Z2ABCD5678EFGH901234IJ",
        "client_reference": "sept-drive-ref-001",
        "client_meta": null,
        "expires_at": null,
        "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": "Thank you for your support!",
            "additional_fields": []
        },
        "stats": {
            "total_payments": 42,
            "max_allowed_total_payments": 100
        },
        "created": 1725984000000,
        "updated": 1757520000000
    }
}

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

List payment pages

Edit a payment page