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
Sample Request
Sample Response
1
curl --location --request POST '<API_HOST>/api/payment-link/<PaymentLink_ID>/cancel' \
2
--header 'Authorization: Basic <API_KEY>'
{
"success": true,
"message": "Payment links was cancelled successfully"
}
Webhook event: PAYMENTLINK_CANCELLED

Webhook Payload Example

{
"event_uid": 'f1b19120cb0b1d9dcf14c27fa59ea227',
"event": 'PAYMENTLINK_CANCELLED',
"data": {
"paymentLinkId": 'r1hzy'
}
}