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,
acss_debit
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

active can be charged. consumed: a one-time method already charged. expired: a one-time method past expires_at. detached: removed from the customer's file. requires_action while a card being saved waits on the cardholder's bank (3-D Secure), as next_action says; it then turns active, or failed when nothing was saved (see failure). A method only reads requires_action when its create sent return_url or use_payra_js. A saved method stays active, and chargeable with the details it has, while new details for its card wait on the bank.

Available options:
active,
consumed,
expired,
detached,
requires_action,
failed
Example:

"active"

customer
string<uuid> | null
required
Example:

null

session
string
required

The session the card or account was collected in; for bank details your server sent, the session Payra made for them.

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

acss_debit
object | null
required

Set when type is acss_debit.

Example:

null

billing_details
object
required
next_action
object | null
required

Set while the cardholder's bank wants to authenticate the card before it is saved: on a method that reads requires_action, and on an active saved method your create answered with 200 for a card collected again with a new expiry, name or postal code, which takes those once the step is done and keeps the ones it has if it is not. redirect, when the create sent return_url: send the cardholder to url, a Payra page; they come back to your return_url with ?payment_method=. three_ds_fingerprint and three_ds_challenge, when it sent use_payra_js: Payra Elements runs the step on your page in handleNextAction. Null otherwise.

Example:

null

failure
object | null
required

Set when status is failed: why the card was not saved. card_authentication_failed: the bank did not authenticate the cardholder, or they closed or left its step. card_verification_failed: the processor refused the card after the bank authenticated it. processing_error: anything else. message is Payra's own sentence. Collect the card again with a new session to retry.

Example:

null

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"