Skip to main content
POST
Error

Authorizations

Authorization
string
header
required

A merchant secret key (sk_…) sent as Authorization: Bearer <key>.

Headers

Idempotency-Key
string

A unique key that makes retries safe: the same key with the same request body returns the original response instead of repeating the operation.

Maximum string length: 255

Path Parameters

id
string
required

The payment intent id (pi_…).

Response

The captured payment intent.

id
string
required

The payment intent id (pi_…).

object
enum<string>
required

Always payment_intent.

Available options:
payment_intent
merchant_id
string
required

The owning merchant (mer_…).

livemode
boolean
required

Whether this intent was created with a live (true) or test (false) key.

client_secret
string | null
required

Returned when the intent is created or confirmed; null on capture, cancel, and list responses.

customer
string | null
required

The attached customer (cus_…). Null unless a customer was passed at creation.

amount
integer
required

The amount to collect, in minor units. Always positive.

currency
string
required

Three-letter ISO currency code. USD, EUR, and GBP are supported.

capture_method
enum<string>
required

automatic captures the charge on confirmation. manual authorizes a hold; capture it later via POST /payment_intents/{id}/capture.

Available options:
automatic,
manual
status
enum<string>
required

One of requires_payment_method (collect or attach a payment method), requires_confirmation (ready to confirm), processing (payment is in progress), requires_action (the buyer must complete another step), requires_capture (authorized and awaiting manual capture), succeeded (payment completed), or canceled (payment can no longer be completed).

Available options:
requires_payment_method,
requires_confirmation,
requires_action,
requires_capture,
processing,
succeeded,
canceled
payment_method
string | null
required

The attached payment method (pm_…). Nullable; cleared on a decline so a retry can attach a different method.

latest_charge_id
string | null
required

The most recent charge produced by this intent (ch_…).

metadata
object
required

A string key-value map for storing your own structured data. Up to 50 keys; each key at most 40 characters and each value at most 500 characters.

created_at
integer
required

Unix epoch seconds.

updated_at
integer
required

Unix epoch seconds, bumped on every mutation.

tokenization
object | null

Browser-safe card-fields configuration returned with client_secret on publishable-key requests. Null when card collection is not available.

reference
string

Your order number or other reference. Max 256 characters.