Retrieve a charge

Error

A valid request URL is required to generate request examples

{
  "payment_context": {
    "version": 1,
    "channel": "<string>",
    "flow": "<string>",
    "wallet": "unknown",
    "wallet_evidence": "unknown",
    "initiated_by": "<string>",
    "card_brand": "<string>",
    "card_funding": "<string>",
    "card_entry_method": "<string>",
    "observed_at": "2023-11-07T05:31:56Z",
    "checkout_session_id": "<string>",
    "payment_link_id": "<string>",
    "invoice_id": "<string>",
    "subscription_id": "<string>",
    "card_country": "<string>"
  },
  "payment_lifecycle": {
    "attempted_at": "2023-11-07T05:31:56Z",
    "dispatched_at": "2023-11-07T05:31:56Z",
    "authorized_at": "2023-11-07T05:31:56Z",
    "captured_at": "2023-11-07T05:31:56Z",
    "voided_at": "2023-11-07T05:31:56Z",
    "finalized_at": "2023-11-07T05:31:56Z"
  },
  "id": "<string>",
  "object": "charge",
  "intent_id": "<string>",
  "payment_method": "<string>",
  "amount": 123,
  "amount_refunded": 123,
  "currency": "<string>",
  "status": "pending",
  "authorization_code": "<string>",
  "settlement_batch_id": "<string>",
  "settled_at": 123,
  "decline_code": "<string>",
  "decline_type": "<string>",
  "failure_message": "<string>",
  "created_at": 123,
  "updated_at": 123
}

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "invalid currency"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "type": "card_error",
    "decline_code": "<string>",
    "decline_type": "authorization",
    "retryable": true,
    "doc_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "type": "card_error",
    "decline_code": "<string>",
    "decline_type": "authorization",
    "retryable": true,
    "doc_url": "<string>"
  }
}

{
  "error": {
    "code": "CHARGE_NOT_FOUND",
    "message": "charge not found"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "type": "card_error",
    "decline_code": "<string>",
    "decline_type": "authorization",
    "retryable": true,
    "doc_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "type": "card_error",
    "decline_code": "<string>",
    "decline_type": "authorization",
    "retryable": true,
    "doc_url": "<string>"
  }
}

GET

charges

{id}

Error

A valid request URL is required to generate request examples

{
  "payment_context": {
    "version": 1,
    "channel": "<string>",
    "flow": "<string>",
    "wallet": "unknown",
    "wallet_evidence": "unknown",
    "initiated_by": "<string>",
    "card_brand": "<string>",
    "card_funding": "<string>",
    "card_entry_method": "<string>",
    "observed_at": "2023-11-07T05:31:56Z",
    "checkout_session_id": "<string>",
    "payment_link_id": "<string>",
    "invoice_id": "<string>",
    "subscription_id": "<string>",
    "card_country": "<string>"
  },
  "payment_lifecycle": {
    "attempted_at": "2023-11-07T05:31:56Z",
    "dispatched_at": "2023-11-07T05:31:56Z",
    "authorized_at": "2023-11-07T05:31:56Z",
    "captured_at": "2023-11-07T05:31:56Z",
    "voided_at": "2023-11-07T05:31:56Z",
    "finalized_at": "2023-11-07T05:31:56Z"
  },
  "id": "<string>",
  "object": "charge",
  "intent_id": "<string>",
  "payment_method": "<string>",
  "amount": 123,
  "amount_refunded": 123,
  "currency": "<string>",
  "status": "pending",
  "authorization_code": "<string>",
  "settlement_batch_id": "<string>",
  "settled_at": 123,
  "decline_code": "<string>",
  "decline_type": "<string>",
  "failure_message": "<string>",
  "created_at": 123,
  "updated_at": 123
}

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "invalid currency"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "type": "card_error",
    "decline_code": "<string>",
    "decline_type": "authorization",
    "retryable": true,
    "doc_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "type": "card_error",
    "decline_code": "<string>",
    "decline_type": "authorization",
    "retryable": true,
    "doc_url": "<string>"
  }
}

{
  "error": {
    "code": "CHARGE_NOT_FOUND",
    "message": "charge not found"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "type": "card_error",
    "decline_code": "<string>",
    "decline_type": "authorization",
    "retryable": true,
    "doc_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "type": "card_error",
    "decline_code": "<string>",
    "decline_type": "authorization",
    "retryable": true,
    "doc_url": "<string>"
  }
}

Authorizations

Authorization

string

header

required

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

Headers

Ionic-Account

string

Merchant ID when an authorized Platform acts for a connected Merchant. Omit when authenticating directly as that Merchant.

Pattern: ^mer_[0-9A-Za-z]{14}$

Path Parameters

string

required

The charge id (ch_…).

Response

The charge.

payment_context

object | null

required

Bounded observations for this payment attempt. Ownership attribution is internal to Ionic. Legacy payments have a null context.

Show child attributes

payment_lifecycle

object

required

First observed lifecycle times. Null means not observed, including historical records; times are never inferred from later updates.

Show child attributes

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 (a fraud signal such as a lost or stolen card), or infrastructure (a processing or network 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.

Fundamentals

Payments

Checkout

In-person payments

Customers and catalog

Connect

Billing

Webhooks

Authorizations

Headers

Path Parameters

Response