Skip to main content
GET
Retrieve a payment method session

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

Query Parameters

client_secret
string

Required with a publishable key: the secret returned when the session was created.

Response

The session; with a publishable key, also where to collect

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

"pms_test_7Hs2kQ9mL1pXv4cR8tWzAbCd"

status
enum<string>
required
Available options:
requires_payment_method,
succeeded,
canceled,
expired
Example:

"requires_payment_method"

customer
string<uuid> | null
required
Example:

null

payment_method_types
enum<string>[]
required
Available options:
card,
us_bank_account
Example:
amount
integer | null
required

What a one-time bank debit will authorize, in the smallest unit of currency. Null on a card session and when a bank account is being saved.

Example:

null

currency
enum<string> | null
required
Available options:
USD
Example:

null

livemode
boolean
required
Example:

false

expires_at
string<date-time>
required
Example:

"2026-09-17T18:30:00.000Z"

canceled_at
string<date-time> | null
required
Example:

null

succeeded_at
string<date-time> | null
required
Example:

null

card
object | null
required

Set once the browser confirmed a card.

Example:

null

us_bank_account
object | null
required

Set once the browser confirmed a bank account.

Example:

null

ach_authorization
object | null
required

On a us_bank_account session: the authorization shown to the account holder, and when they accepted it.

Example:

null

payment_method
string | null
required

The payment method your server created from this session, once it did.

Example:

null

created_at
string<date-time>
required
Example:

"2026-09-17T18:00:00.000Z"

collect
object

Present only when retrieved with a publishable key and the session client_secret.