Skip to main content
GET
Error

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

The charge id (ch_…).

Response

The charge.

id
string
required

The charge id (ch_…).

object
enum<string>
required

Always charge.

Available options:
charge
intent_id
string
required

The payment intent this charge belongs to (pi_…).

payment_method
string
required

The payment method (pm_…) used. Always present.

amount
integer
required

The charge amount, in minor units. Always positive.

amount_refunded
integer
required

Total refunded so far, in minor units.

currency
string
required

The charge's currency, matching amount's currency.

status
enum<string>
required

uncertain means the final outcome is not known yet. Retrieve the Charge again before retrying.

Available options:
pending,
authorized,
succeeded,
declined,
failed,
refunded,
voided,
uncertain
authorization_code
string | null
required

Authorization code for an approved payment. Null until the Charge is authorized or completed.

settlement_batch_id
string | null
required

Terminal batch (tmb_…) containing this Charge. Null until the Charge is settled in a batch.

settled_at
integer | null
required

Unix epoch seconds when the Charge settled. Null until settlement completes.

decline_code
string | null
required

Machine-readable decline reason, such as insufficient_funds.

decline_type
string | null
required

One of authorization (a card or funds issue), authentication (the payment could not be authenticated), or infrastructure (a temporary processing problem). Set only when the Charge was declined; null otherwise.

failure_message
string | null
required

A human-readable failure detail. Nullable; present when the charge failed.

created_at
integer
required

Unix epoch seconds when the charge was created.

updated_at
integer
required

Unix epoch seconds when the charge was last updated.