Abort a payment attempt

curl --request POST \
  --url https://api.sandbox.primer.io/payment-attempts/{id}/abort \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --header 'X-API-VERSION: <x-api-version>' \
  --data '
{
  "reason": "fraud-check-failed"
}
'

{
  "paymentAttemptId": "6c5d3a30-3c2e-4f55-9d8e-5b3d5e3a5c7f"
}

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

Abort a payment attempt

curl --request POST \
  --url https://api.sandbox.primer.io/payment-attempts/{id}/abort \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --header 'X-API-VERSION: <x-api-version>' \
  --data '
{
  "reason": "fraud-check-failed"
}
'

{
  "paymentAttemptId": "6c5d3a30-3c2e-4f55-9d8e-5b3d5e3a5c7f"
}

Authorizations

X-API-KEY

string

header

required

Headers

X-API-VERSION

string

required

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

Example:

"2.4"

Path Parameters

string<uuid>

required

ID of the payment attempt to abort.

Body

application/json

reason

string

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.

Maximum string length: 512

Response

Successful Response

paymentAttemptId

string<uuid>

required

ID of the aborted payment attempt.

Approve a payment attempt Save a payment method token

⌘I