Cancels a card payment link that has not been paid. The response carries no data key.
Requires the card_payment_links:cancel ability. It does not require a verified account, and it reaches the same set of links the read operation does.
One condition is checked, and only one. The link must still be active. There is no second use-count check here, so this rail has no equivalent of the local rail's PAYMENT_LINK_CANNOT_CANCEL.
Cancelling here notifies your webhook endpoints. A successful cancel dispatches card_payment_link.cancelled to every active endpoint subscribed to it, exactly as a cancel from the dashboard does.
Refusals past the shared ones: 401 INVALID_API_KEY in the ordinary envelope, 404 USER_NOT_FOUND, 404 CARD_PAYMENT_LINK_NOT_FOUND, 404 RESOURCE_NOT_FOUND, 422 CARD_PAYMENT_LINK_NOT_ACTIVE, 500 CARD_PAYMENT_ERROR and 500 SYSTEM_DATABASE_ERROR.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
