Approve a payment attempt

curl --request POST \
  --url https://api.sandbox.primer.io/payment-attempts/{id}/approve \
  --header 'X-API-KEY: <api-key>' \
  --header 'X-API-VERSION: <x-api-version>'

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

Approve a payment attempt

Approve a payment attempt that is awaiting merchant approval, and trigger payment authorization on Primer’s side.

This endpoint is the merchant entry-point of the Backend-Driven CIT (MANUAL approval) flow: after the SDK tokenises a payment method and the merchant backend has decided the payment should proceed (e.g. after a fraud check or inventory validation), the backend calls this endpoint to hand off orchestration to Primer (3DS, retries, webhooks).

The paymentAttemptId is the idempotency key: concurrent or retried calls converge on a single downstream payment.

POST

payment-attempts

{id}

approve

Approve a payment attempt

curl --request POST \
  --url https://api.sandbox.primer.io/payment-attempts/{id}/approve \
  --header 'X-API-KEY: <api-key>' \
  --header 'X-API-VERSION: <x-api-version>'

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

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 approve.

Response

Successful Response

paymentAttemptId

string<uuid>

required

ID of the approved payment attempt.

paymentId

string

required

ID of the payment created on Primer's side as a result of the approval. Use this to look up the payment via the Payments API.

Get a payment Abort a payment attempt

⌘I