Skip to main content
GET
Get a payment method

Path Parameters

paymentMethodId
string
required

The unique, opaque system identifier for a resource. This case-sensitive ID is also used as path parameters in URLs or in other properties or parameters that reference a resource by ID rather than URL.

Response

Ok. The operation succeeded.

Representation of a payment method for a customer.

type
enum<string>
required

Indicator of the payment method type.

Available options:
card,
digitalWallet
isDefault
boolean
default:false
required

Indicates if this card is the default card in a customer's saved payment methods.

card
object

A representation of the customer's credit or debit card. This property is required when the payment method type is card.

digitalWallet
object

A representation of the customer's digital wallet, such as Apple Pay. This property is required when the payment method type is digitalWallet.

nickname
string

An optional nickname for the payment method to help identify it.

Maximum string length: 50