Attributes

• idstring

  Unique identifier for the object.

• billing_detailsobject

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

  Show child attributes

• customernullable stringExpandable

  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.

• metadatanullable object

  Set ofkey-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

• typeenum

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

More attributes

Expand all

• objectstring

• acss_debitnullable object

• affirmnullable object

• afterpay_clearpaynullable object

• alipaynullable object

• allow_redisplaynullable enum

• almanullable object

• amazon_paynullable object

• au_becs_debitnullable object

• bacs_debitnullable object

• bancontactnullable object

• billienullable object

• bliknullable object

• boletonullable object

• cardnullable object

• card_presentnullable object

• cashappnullable object

• createdtimestamp

• cryptonullable object

• customnullable object

• customer_balancenullable object

• epsnullable object

• fpxnullable object

• giropaynullable object

• grabpaynullable object

• idealnullable object

• interac_presentnullable objectPreview feature

• kakao_paynullable object

• klarnanullable object

• konbininullable object

• kr_cardnullable object

• linknullable object

• livemodeboolean

• mb_waynullable object

• mobilepaynullable object

• multibanconullable object

• naver_paynullable object

• nz_bank_accountnullable object

• oxxonullable object

• p24nullable object

• pay_by_banknullable object

• payconullable object

• paynownullable object

• paypalnullable object

• paypaynullable objectPreview feature

• paytonullable object

• pixnullable object

• promptpaynullable object

• radar_optionsnullable object

• revolut_paynullable object

• samsung_paynullable object

• satispaynullable object

• sepa_debitnullable object

• sofortnullable object

• swishnullable object

• twintnullable object

• us_bank_accountnullable object

• wechat_paynullable object

• zipnullable object

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

Instead of creating a PaymentMethod directly, we recommend using thePaymentIntents API to accept a payment immediately or theSetupIntent 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 44 more

• billing_detailsobject

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

  Show child parameters

• metadataobject

  Set ofkey-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 tometadata.

More parameters

Expand all

• acss_debitobject

• affirmobject

• afterpay_clearpayobject

• alipayobject

• allow_redisplayenum

• almaobject

• amazon_payobject

• au_becs_debitobject

• bacs_debitobject

• bancontactobject

• billieobject

• 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

• paypayobjectPreview feature

• paytoobject

• pixobject

• promptpayobject

• radar_optionsobject

• revolut_payobject

• samsung_payobject

• satispayobject

• sepa_debitobject

• sofortobject

• swishobject

• twintobject

• us_bank_accountobject

• wechat_payobject

• 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

• metadataobject

  Set ofkey-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 tometadata.

More parameters

Expand all

• allow_redisplayenum

• cardobject

• paytoobject

• us_bank_accountobject

Retrieves a PaymentMethod object for a given Customer.

Parameters

No parameters.