Skip to main content
GET
Retrieve a payment method

Authorizations

Authorization
string
header
required

A secret key, sk_test_... or sk_live_...; a publishable key (pk_...) on the browser routes only

Path Parameters

id
string
required
Required string length: 1 - 64

Response

The payment method

object
enum<string>
required
Available options:
payment_method
id
string
required
Example:

"pm_test_9kQ2mL7Hs1pXv4cR8tWzAbCdEf"

type
enum<string>
required
Available options:
card,
us_bank_account
Example:

"card"

usage
enum<string>
required

saved when the session named a customer: the instrument is vaulted and stays on their file. one_time otherwise: chargeable once, before expires_at.

Available options:
one_time,
saved
Example:

"saved"

status
enum<string>
required
Available options:
active,
consumed,
expired,
detached
Example:

"active"

customer
string<uuid> | null
required
Example:

null

session
string
required

The session the card was collected in.

Example:

"pms_test_7Hs2kQ9mL1pXv4cR8tWzAbCd"

card
object | null
required

Set when type is card.

us_bank_account
object | null
required

Set when type is us_bank_account.

Example:

null

billing_details
object
required
livemode
boolean
required
Example:

false

expires_at
string<date-time> | null
required

Set on a one-time method.

Example:

null

created_at
string<date-time>
required
Example:

"2026-09-18T14:00:00.000Z"