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 payment method id (pm_…).

Response

The payment method.

id
string
required

The payment method id (pm_…).

object
enum<string>
required

Always payment_method.

Available options:
payment_method
type
enum<string>
required

card is an online/vaulted card. card_present is Ionic's read-only record of one physical Terminal presentation.

Available options:
card,
card_present
livemode
boolean
required

Whether this method belongs to the live (true) or test (false) environment.

reusable
boolean
required

true when the method can be charged multiple times; false for a single-use method that is consumed by its first charge. Only reusable methods can become expired or revoked; single-use methods cannot be revoked and never expire.

status
enum<string>
required

active — eligible for its type-specific application flow. consumed — used by a single-use charge. expired — network-expired reusable card. revoked — permanently deactivated by the merchant. A card_present method is staged active and consumed atomically by Terminal payment processing; clients cannot charge it directly.

Available options:
active,
consumed,
expired,
revoked
customer
string | null
required

The attached customer id (cus_…), or null if not attached.

card
object | null
required

Card details. Present for type: card; null otherwise.

card_present
object | null
required

Card details returned for type: card_present, or null when unavailable. Null for type: card.

fingerprint
string
required

Stable card identifier for duplicate detection when available. Always empty for type: card_present.

metadata
object
required

A string key-value map for storing your own structured data.

created_at
integer
required

Unix epoch seconds.

billing_details
object | null

Billing details captured for this method. Null when not supplied.