Actions9
Overview
This node operation cancels an existing payment link in the Cashfree Payments system. It is useful when a payment link needs to be invalidated to prevent further payments, such as when an order is canceled or a payment link was created by mistake. For example, a merchant can use this operation to cancel a payment link that was sent to a customer but is no longer valid or needed.
Use Case Examples
- Cancel a payment link by providing its unique Link ID to stop any further payments through that link.
- Use the Request ID and Idempotency Key to safely retry the cancellation request without creating duplicate cancellations.
Properties
| Name | Meaning |
|---|---|
| Link ID | The ID of the payment link to cancel (required). Used to identify which payment link to cancel. |
| Request ID | Optional request ID for the API call. Useful for troubleshooting and communicating with Cashfree support. |
| Idempotency Key | Optional unique key to ensure the cancellation request is idempotent, preventing duplicate actions if retried. |
Output
JSON
json- The JSON response from Cashfree API after attempting to cancel the payment link, containing details about the cancellation status.
Dependencies
- Cashfree Payments API with client ID, client secret credentials for authentication.
Troubleshooting
- Ensure the Link ID is correct and corresponds to an existing payment link; otherwise, the cancellation will fail.
- If the API call fails, check that the client ID and client secret credentials are correctly configured in the node.
- Use the Request ID and Idempotency Key to avoid duplicate cancellation requests and help with troubleshooting.
- Common errors include authentication failures due to missing or incorrect credentials, invalid Link ID, or network issues. Verify all inputs and credentials before retrying.
Links
- Cashfree Payment Links API - Cancel Payment Link - Official documentation for the Cancel Payment Link API endpoint in Cashfree Payments.