Payment Attempts API

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

Path parameters

idstring uuid required

ID of the payment attempt to approve.

Headers

X-API-VERSIONstring required

Example:2.4

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

Response

Successful Response

paymentAttemptIdstring uuid required

ID of the approved payment attempt.

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

Changes

No recorded changes to this endpoint across all 1 revision of this API.