PRprimer
Payment Attempts API

Abort a payment attempt

Abort a payment attempt that is awaiting merchant approval. No payment is created. The tokenised payment instrument associated with the attempt is invalidated. Call this endpoint when, after tokenisation, a business decision is made that the payment should not proceed (e.g. a merchant-side fraud check flagged the transaction, the customer cancelled on the merchant's own UI, or an inventory check failed between tokenisation and approval).

post/payment-attempts/{id}/abort

Request

  • Base URL
    https://api.sandbox.primer.io
  • URL
    https://api.sandbox.primer.io/payment-attempts/{id}/abort
  • Auth
    API key in header X-API-KEY

Path parameters

idstring uuid required

ID of the payment attempt to abort.

Headers

X-API-VERSIONstring required
Example:2.4

Specifies the version of the API to use. This must be set to 2.4.

Request body

reasonstring

Optional free-text reason for aborting the payment attempt, recorded for your own records. Useful for observability into abort patterns. Do not include cardholder data.

Response

Successful Response

paymentAttemptIdstring uuid required

ID of the aborted payment attempt.

Changes

No recorded changes to this operation across all 6 revisions of this API.