Skip to main content
GET
Retrieve a payment

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Response

The payment.

id
string
required
Example:

"pay_01JABCDEF"

object
string
required
Allowed value: "payment"
status
enum<string>
required
Available options:
requires_payment_method,
processing,
requires_action,
authorized,
partially_captured,
captured,
partially_refunded,
refunded,
canceled,
expired,
disputed,
charged_back
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"

amount_authorized
integer<int64>
required

Amount in the currency's minor unit.

Required range: x >= 0
amount_captured
integer<int64>
required

Amount in the currency's minor unit.

Required range: x >= 0
amount_refunded
integer<int64>
required

Amount in the currency's minor unit.

Required range: x >= 0
amount_disputed
integer<int64>
required

Amount in the currency's minor unit.

Required range: x >= 0
amount_capturable
integer<int64>
required

Amount in the currency's minor unit.

Required range: x >= 0
capture_method
enum<string>
required
Available options:
automatic,
manual
reference
string
required
metadata
object
required

Up to 50 keys. Keys up to 40 characters, values up to 500 characters. Echoed back unchanged.

version
integer
required

Increases with every change.

created_at
string<date-time>
required
livemode
boolean
required
amount_mismatch
boolean

True if the provider reported an amount different from the expected one.

checkout_session
string
customer
string | null
description
string | null
payment_method
object
last_payment_error
object | null
authorized_at
string<date-time> | null
captured_at
string<date-time> | null
canceled_at
string<date-time> | null
updated_at
string<date-time>