Skip to main content
Manja / Stripe
Schema2020-08-27object

api_errors

Source
openapi/spec3.json
Commit
d70de345383d
Active snapshot
da69df7e6e11

PaymentMethod

object

PaymentMethod objects represent your customer's payment instruments. They can be used with [PaymentIntents](https://stripe.com/docs/payments/payment-intents) to collect payments or saved to Customer objects to store instrument details for future payments. Related guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/payments/more-payment-scenarios).

created integer (unix-time)
required

Time at which the object was created. Measured in seconds since the Unix epoch.

customer
optionalnullable

The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.

id string
required

Unique identifier for the object.

maxLength:5000

livemode boolean
required

Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.

metadata object
optionalnullable

Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

object string
required

String representing the object's type. Objects of the same type share the same value.

Allowed: "payment_method"

type string
required

The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.

Allowed: "acss_debit""afterpay_clearpay""alipay""au_becs_debit""bacs_debit""bancontact""boleto""card""card_present""eps""fpx""giropay""grabpay""ideal""interac_present""klarna""oxxo""p24""sepa_debit""sofort""wechat_pay"