Skip to main content
POST
Capture an authorized payment

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.

Required string length: 1 - 255

Path Parameters

id
string
required

Body

application/json
amount
integer<int64>

Amount to capture. Cannot exceed the capturable amount.

Required range: x >= 1

Response

Capture requested.

id
string
required
Example:

"cap_01JABCDEF"

object
string
required
Allowed value: "capture"
payment
string
required
amount
integer<int64>
required

Amount in the currency's minor unit.

Required range: x >= 0
currency
string
required

ISO 4217 currency code, uppercase.

Pattern: ^[A-Z]{3}$
Example:

"EUR"

status
enum<string>
required
Available options:
pending,
succeeded,
failed
created_at
string<date-time>
required
failure_reason
string | null
updated_at
string<date-time>