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

• typeenumRequired

  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 (ACSS).

  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 BECS Direct Debit is used to debit Australian bank accounts through the Bulk Electronic Clearing System (BECS).

  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 50 more

• billing_detailsobject

  Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.

  Show child parameters

• metadatamap

  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

Expand all

• acss_debitobject

• affirmobject

• afterpay_clearpayobject

• alipayobject

• allow_redisplayenum

• almaobject

• amazon_payobject

• au_becs_debitobject

• bacs_debitobject

• bancontactobject

• billieobject

• bizumobject

• blikobject

• boletoobject

• cardobject

• cashappobject

• cryptoobject

• customobject

• customer_balanceobject

• epsobject

• fpxobject

• giropayobject

• grabpayobject

• idealobject

• interac_presentobjectPreview feature

• kakao_payobject

• klarnaobject

• konbiniobject

• kr_cardobject

• linkobject

• mb_wayobject

• mobilepayobject

• multibancoobject

• naver_payobject

• nz_bank_accountobject

• oxxoobject

• p24object

• pay_by_bankobject

• paycoobject

• paynowobject

• paypalobject

• paypayobject

• paytoobject

• pixobject

• promptpayobject

• radar_optionsobject

• revolut_payobject

• samsung_payobject

• satispayobject

• scalapayobject

• sepa_debitobject

• sequraobjectPreview feature

• sofortobject

• sunbitobject

• swishobject

• twintobject

• upiobject

• us_bank_accountobject

• wechat_payobject

• weroobjectPreview feature

• zipobject

Updates a PaymentMethod object. A PaymentMethod must be attached to a customer to be updated.

Parameters

• billing_detailsobject

  Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.

  Show child parameters

• metadatamap

  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

Expand all

• allow_redisplayenum

• cardobject

• us_bank_accountobject

Retrieves a PaymentMethod object attached to the StripeAccount. To retrieve a payment method attached to a Customer, you should use Retrieve a Customer’s PaymentMethods

Parameters

No parameters.