Cancel Payment Link
Use this API to cancel a payment link. No further payments can be done against a cancelled link. Only a link in ACTIVE status can be cancelled.
Authorizations
Client app ID. You can find your app id in the Merchant Dashboard.
Client secret key. You can find your secret in the Merchant Dashboard.
Headers
API version to be used. Format is in YYYY-MM-DD
Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree
An idempotency key is a unique identifier you include with your API call. If the request fails or times out, you can safely retry it using the same key to avoid duplicate actions.
Path Parameters
The payment link ID for which you want to view the details.
Response
Payment link success creation response object
Payment link customer entity
Payment link meta information object
Key-value pair that can be used to store additional information about the entity. Maximum 5 key-value pairs
Payment link Notify Object for SMS and Email
Base64 encoded string for payment link. You can scan with camera to open a link in the browser to complete the payment.
Was this page helpful?