Cancel a payment link

You can cancel a payment link, if necessary.

For example, if a merchant's payment request is for a travel purchase, but the price is no longer valid, you can cancel the payment link.

To cancel a payment link, it must fulfil the following conditions:

  • The payment in Checkout must be unpaid.
  • The payment link must not be in an initiated state.
  • The payment link must not have expired.

After cancelling a payment link, you cannot change it back to any available state. You must create a new payment link.


The request to cancel a payment link consists of the following attributes.

paymentIdCreating a new payment link returns this ID.AN32
Authorization headerBearer tokens are Auth0 tokens that enable requests to authenticate using an access key. The token is a text string included in the request header.Bearer token

Example requests and responses

For sample requests and responses, see the interactive API playground and the Postman workspace.