Payment Methods

PaymentMethod objects represent your customer’s payment instruments. You can use them with PaymentIntents to collect payments or save them to Customer objects to store instrument details for future payments.

Related guides: Payment Methods and More Payment Scenarios.

Was this section helpful? Yes No

Create a PaymentMethod

POST / v1 / payment_methods

Update a PaymentMethod

POST / v1 / payment_methods /:id

Retrieve a PaymentMethod

GET / v1 / payment_methods /:id

Retrieve a Customer's PaymentMethod

GET / v1 / customers /:id / payment_methods /:id

List PaymentMethods

GET / v1 / payment_methods

List a Customer's PaymentMethods

GET / v1 / customers /:id / payment_methods

Attach a PaymentMethod to a Customer

POST / v1 / payment_methods /:id / attach

Detach a PaymentMethod from a Customer

POST / v1 / payment_methods /:id / detach

The PaymentMethod object

Attributes

id string Unique identifier for the object.
billing _ details object Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
customer nullable string Expandable 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.
metadata nullable map Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
type enum 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. Possible enum values acss_debit Pre-authorized debit payments are used to debit Canadian bank accounts through the Automated Clearing Settlement System (the related setting). affirm Affirm is a buy now, pay later payment method in the US. afterpay_clearpay Afterpay / Clearpay is a buy now, pay later payment method used in Australia, Canada, France, New Zealand, Spain, the UK, and the US. alipay Alipay is a digital wallet payment method used in China. alma Alma is a Buy Now, Pay Later payment method that lets customers pay in 2, 3, or 4 installments. amazon_pay Amazon Pay is a Wallet payment method that lets hundreds of millions of Amazon customers pay their way, every day. au_becs_debit the related setting Direct Debit is used to debit Australian bank accounts through the Bulk Electronic Clearing System (the related setting). bacs_debit Bacs Direct Debit is used to debit UK bank accounts. bancontact Bancontact is a bank redirect payment method used in Belgium. billie Billie is a payment method. Show 48 more

More attributes

object string, value is "payment_method"
acss _ debit nullable object
affirm nullable object
afterpay _ clearpay nullable object
alipay nullable object
allow _ redisplay nullable enum
alma nullable object
amazon _ pay nullable object
au _ becs _ debit nullable object
bacs _ debit nullable object
bancontact nullable object
billie nullable object
bizum nullable object
blik nullable object
boleto nullable object
card nullable object
card _ present nullable object
cashapp nullable object
created timestamp
crypto nullable object
custom nullable object
customer _ balance nullable object
eps nullable object
fpx nullable object
giropay nullable object
grabpay nullable object
ideal nullable object
interac _ present nullable object Preview feature
kakao _ pay nullable object
klarna nullable object
konbini nullable object
kr _ card nullable object
link nullable object
livemode boolean
mb _ way nullable object
mobilepay nullable object
multibanco nullable object
naver _ pay nullable object
nz _ bank _ account nullable object
oxxo nullable object
p24 nullable object
pay _ by _ bank nullable object
payco nullable object
paynow nullable object
paypal nullable object
paypay nullable object
payto nullable object
pix nullable object
promptpay nullable object
radar _ options nullable object
revolut _ pay nullable object
samsung _ pay nullable object
satispay nullable object
scalapay nullable object
sepa _ debit nullable object
sofort nullable object
sunbit nullable object
swish nullable object
twint nullable object
upi nullable object
us _ bank _ account nullable object
wechat _ pay nullable object
zip nullable object

The PaymentMethod object

{ "id": "pm_1Q0PsIJvEtkwdCNYMSaVuRz6", "object": "payment_method", "allow_redisplay": "unspecified", "billing_details": { "address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null }, "email": null, "name": "John Doe", "phone": null }, "created": 1726673582, "customer": null, "livemode": false, "metadata": {}, "type": "us_bank_account", "us_bank_account": { "account_holder_type": "individual", "account_type": "checking", "bank_name": "STRIPE TEST BANK", "financial_connections_account": null, "fingerprint": "LstWJFsCK7P349Bg", "last4": "6789", "networks": { "preferred": "ach", "supported": [ "ach" ] }, "routing_number": "110000000", "status_details": {} }}

Create a PaymentMethod

POST / v1 / payment_methods

Creates a PaymentMethod object. Read the Stripe.js reference to learn how to create PaymentMethods via Stripe.js.

Instead of creating a PaymentMethod directly, we recommend using the PaymentIntents API to accept a payment immediately or the SetupIntent API to collect payment method details ahead of a future payment.

Parameters

type enum 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. Possible enum values acss_debit Pre-authorized debit payments are used to debit Canadian bank accounts through the Automated Clearing Settlement System (the related setting). affirm Affirm is a buy now, pay later payment method in the US. afterpay_clearpay Afterpay / Clearpay is a buy now, pay later payment method used in Australia, Canada, France, New Zealand, Spain, the UK, and the US. alipay Alipay is a digital wallet payment method used in China. alma Alma is a Buy Now, Pay Later payment method that lets customers pay in 2, 3, or 4 installments. amazon_pay Amazon Pay is a Wallet payment method that lets hundreds of millions of Amazon customers pay their way, every day. au_becs_debit the related setting Direct Debit is used to debit Australian bank accounts through the Bulk Electronic Clearing System (the related setting). bacs_debit Bacs Direct Debit is used to debit UK bank accounts. bancontact Bancontact is a bank redirect payment method used in Belgium. billie Billie is a payment method. Show 48 more
billing _ details object Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
metadata map Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

More parameters

acss _ debit object
affirm object
afterpay _ clearpay object
alipay object
allow _ redisplay enum
alma object
amazon _ pay object
au _ becs _ debit object
bacs _ debit object
bancontact object
billie object
bizum object
blik object
boleto object
card object
cashapp object
crypto object
custom object
customer _ balance object
eps object
fpx object
giropay object
grabpay object
ideal object
interac _ present object Preview feature
kakao _ pay object
klarna object
konbini object
kr _ card object
link object
mb _ way object
mobilepay object
multibanco object
naver _ pay object
nz _ bank _ account object
oxxo object
p24 object
pay _ by _ bank object
payco object
paynow object
paypal object
paypay object
payto object
pix object
promptpay object
radar _ options object
revolut _ pay object
samsung _ pay object
satispay object
scalapay object
sepa _ debit object
sofort object
sunbit object
swish object
twint object
upi object
us _ bank _ account object
wechat _ pay object
zip object

Returns

Returns a PaymentMethod object.

Response

{ "id": "pm_1Q0PsIJvEtkwdCNYMSaVuRz6", "object": "payment_method", "allow_redisplay": "unspecified", "billing_details": { "address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null }, "email": null, "name": "John Doe", "phone": null }, "created": 1726673582, "customer": null, "livemode": false, "metadata": {}, "type": "us_bank_account", "us_bank_account": { "account_holder_type": "individual", "account_type": "checking", "bank_name": "STRIPE TEST BANK", "financial_connections_account": null, "fingerprint": "LstWJFsCK7P349Bg", "last4": "6789", "networks": { "preferred": "ach", "supported": [ "ach" ] }, "routing_number": "110000000", "status_details": {} }}