Cancel Payment Page

The Cancel Payment Page API allows partners to cancel Payment Pages and change status to CANCELLED.

POST https://<PayEngine-host>/api/payment-page/:id/cancel

Request

Path Parameters

Name	Type	Description
id*	string	Payment page ID

200

Field Definitions

Field Name	Type	Description	Required?
success	boolean	Indicates the successful cancellation of the payment page. false if fails to cancel payment link	Required
message	string	Error or success message	Required

Sample Request

curl --location --request POST '<API_HOST>/api/payment-page/<PaymentPage_ID>/cancel' \
--header 'Authorization: Basic <API_KEY>'

Sample Response

{
    "success": true,
    "message": "Payment page was cancelled successfully"
}

Webhook event: PAYMENTPAGE_CANCELLED

Webhook Payload Example

{
  "event_uid": "f1b19120cb0b1d9dcf14c27fa59ea227",
  "event": "PAYMENTPAGE_CANCELLED",
  "data": {
    "payment_page_id": "r1hzy"
  }
}