Cancel a payment link

A payment link can be cancelled, if necessary.

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

For a payment link to be successfully cancelled, it must fulfil the following conditions:

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

After cancelling a payment link, it cannot be set back to any available state, the merchant must create a new payment link.

Request

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

ParameterDescriptionFormat
paymentIdThe ID that is returned when creating a new payment link.AN32
[a-f0-9]{32}
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.