Cancel Payment Link

DELETE 
/public/api/v1/payment-links/:id

Cancels a payment link that has not yet been completed.

A payment link can only be cancelled if no transactions are currently being processed for it. If the payment link cannot be cancelled, an UNEXPECTED_SESSION_STATE error is returned.

Request

Responses

200

Payment link cancelled successfully. No content returned.

400

Standard error response returned when a request fails. Contains a machine-readable error code, a human-readable message.

422

Standard error response returned when a request fails. Contains a machine-readable error code, a human-readable message, and an errors object with field-specific validation issues.

500

Standard error response returned when a request fails. Contains a machine-readable error code, a human-readable message.