PaymentMethod
PaymentMethod objects represent your customer's payment instruments. They can be used with PaymentIntents to collect payments or saved to Customer objects to store instrument details for future payments.
Related guides: Payment Methods and More Payment Scenarios.
See PaymentMethodCreateParams for PaymentMethod creation
Types
Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
If this is a card
PaymentMethod, this hash contains details about the card.
If this is a card_present
PaymentMethod, this hash contains details about the Card Present payment method.
Requires the FPX payment method enabled on your account via https://dashboard.stripe.com/account/payments/settings.
If this is an ideal
PaymentMethod, this hash contains details about the iDEAL payment method.
If this is a sepa_debit
PaymentMethod, this hash contains details about the SEPA debit bank account.
Properties
Indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to "unspecified".
If this is an au_becs_debit
PaymentMethod, this hash contains details about the bank account.
If this is a bacs_debit
PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.
Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
If this is a card
PaymentMethod, this hash contains details about the card.
If this is a card_present
PaymentMethod, this hash contains details about the Card Present payment method.
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.
If this is a fpx
PaymentMethod, this hash contains details about the FPX payment method.
If this is an ideal
PaymentMethod, this hash contains details about the iDEAL payment method.
If this is a sepa_debit
PaymentMethod, this hash contains details about the SEPA debit bank account.
If this is a sofort
PaymentMethod, this hash contains details about the SOFORT payment method.
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.
If this is an us_bank_account
PaymentMethod, this hash contains details about the bank account.