Skip to main content
POST

Authorizations

Authorization
string
header
required

Secret key, kc_sk_test_... or kc_sk_live_.... Server-side only.

Headers

Idempotency-Key
string
required

Unique key per logical request, reused on retries. 1 to 255 characters, kept for 24 hours. A retry with the same key and body returns the stored response with the header Idempotent-Replayed: true.

Required string length: 1 - 255

Path Parameters

id
string
required

Body

application/json
outcome
enum<string>
default:succeeded
Available options:
succeeded,
declined,
insufficient_funds,
processing,
amount_mismatch

Response

The simulated attempt and its immediate result. Webhooks follow.

object
string
required
Allowed value: "checkout_session_simulation"
checkout_session
string
required
payment
string
required
outcome
enum<string>
required
Available options:
succeeded,
declined,
insufficient_funds,
processing,
amount_mismatch
attempt
object
required

The simulated attempt's immediate result. The payment's final state arrives by webhook.