Cancel Payment Link

The Cancel Payment Link API allows partners to cancel Payment Links and change link's status to CANCELLED.

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

Request

Path Parameters

Name	Type	Description
id*	string	Payment Link ID

200

Field Definitions

Field Name	Type	Description	Required?
success	boolean	Indicates the successful cancellation of the payment link. 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-link/<PaymentLink_ID>/cancel' \
--header 'Authorization: Basic <API_KEY>'

Sample Response

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

Webhook event: PAYMENTLINK_CANCELLED

Webhook Payload Example

{
  "event_uid": "f1b19120cb0b1d9dcf14c27fa59ea227",
  "event": "PAYMENTLINK_CANCELLED",
  "data": {
    "payment_link_id": "paymentLinkId"
  }
}