Skip to content

Confirm a checkout payment

POST
/checkout/confirm-payment
curl --request POST \
--url https://apisandbox.puurk.com/checkout/confirm-payment \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "payment_intent_id": "example", "payment_method_id": "example", "oid": "example", "off_session": false }'

Confirms a prepared PaymentIntent server-side with a payment method collected on the client. Call POST /checkout/verify-payment afterwards to record the Payment.

Payment to confirm

Media typeapplication/json
object
payment_intent_id
required

PaymentIntent returned by /checkout/prepare

string
payment_method_id
required

Stripe PaymentMethod ID collected on the client

string
oid
required

Organization ID the PaymentIntent belongs to

string
off_session

Set to true when charging a stored payment method with the customer not present, so Stripe handles authentication rather than expecting an interactive challenge.

boolean

Successful operation

Media typeapplication/json
object
payment_intent_id

Stripe PaymentIntent ID

string
status

PaymentIntent status. ‘succeeded’, or ‘processing’ for asynchronous methods such as ACH that settle later.

string
Examplegenerated
{
"payment_intent_id": "example",
"status": "example"
}

Invalid parameter

Unauthorized

PaymentIntent does not belong to this organization

PaymentIntent not found

Payment declined or not completed