The Payment Method Configuration object

Payment Methods

Payment Method Configurations

Attributes

idstringretrievable with publishable key
Unique identifier for the object.

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

activeboolean
Whether the configuration can be used for new payments.

applicationnullable string
For child configs, the Connect application associated with the configuration.

is_defaultboolean
The default configuration is used whenever a payment method configuration is not specified.

namestring
The configuration’s name.

parentnullable string
For child configs, the configuration’s parent configuration.

More attributes

acss_debitnullable object
Canadian pre-authorized debit payments, check this page for more details like country availability.
- acss_debit.availableboolean
  Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
- acss_debit.display_preferenceobject
  Whether this payment method should be offered at checkout.
  acss_debit.display_preference.overridablenullable boolean
  For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
  acss_debit.display_preference.preferenceenum
  The account’s display preference.
  Possible enum values
  none
  Use the parent or default setting.
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.
  acss_debit.display_preference.valueenum
  The effective display preference value.
  Possible enum values
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.

affirmnullable object
Affirm gives your customers a way to split purchases over a series of payments. Depending on the purchase, they can pay with four interest-free payments (Split Pay) or pay over a longer term (Installments), which might include interest. Check this page for more details like country availability.
- affirm.availableboolean
  Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
- affirm.display_preferenceobject
  Whether this payment method should be offered at checkout.
  affirm.display_preference.overridablenullable boolean
  For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
  affirm.display_preference.preferenceenum
  The account’s display preference.
  Possible enum values
  none
  Use the parent or default setting.
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.
  affirm.display_preference.valueenum
  The effective display preference value.
  Possible enum values
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.

afterpay_clearpaynullable object
Afterpay gives your customers a way to pay for purchases in installments, check this page for more details like country availability. Afterpay is particularly popular among businesses selling fashion, beauty, and sports products.
- afterpay_clearpay.availableboolean
  Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
- afterpay_clearpay.display_preferenceobject
  Whether this payment method should be offered at checkout.
  afterpay_clearpay.display_preference.overridablenullable boolean
  For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
  afterpay_clearpay.display_preference.preferenceenum
  The account’s display preference.
  Possible enum values
  none
  Use the parent or default setting.
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.
  afterpay_clearpay.display_preference.valueenum
  The effective display preference value.
  Possible enum values
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.

alipaynullable object
Alipay is a digital wallet in China that has more than a billion active users worldwide. Alipay users can pay on the web or on a mobile device using login credentials or their Alipay app. Alipay has a low dispute rate and reduces fraud by authenticating payments using the customer’s login credentials. Check this page for more details.
- alipay.availableboolean
  Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
- alipay.display_preferenceobject
  Whether this payment method should be offered at checkout.
  alipay.display_preference.overridablenullable boolean
  For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
  alipay.display_preference.preferenceenum
  The account’s display preference.
  Possible enum values
  none
  Use the parent or default setting.
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.
  alipay.display_preference.valueenum
  The effective display preference value.
  Possible enum values
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.

amazon_paynullable object
Amazon Pay is a wallet payment method that lets your customers check out the same way as on Amazon.
- amazon_pay.availableboolean
  Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
- amazon_pay.display_preferenceobject
  Whether this payment method should be offered at checkout.
  amazon_pay.display_preference.overridablenullable boolean
  For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
  amazon_pay.display_preference.preferenceenum
  The account’s display preference.
  Possible enum values
  none
  Use the parent or default setting.
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.
  amazon_pay.display_preference.valueenum
  The effective display preference value.
  Possible enum values
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.

apple_paynullable object
Stripe users can accept Apple Pay in iOS applications in iOS 9 and later, and on the web in Safari starting with iOS 10 or macOS Sierra. There are no additional fees to process Apple Pay payments, and the pricing is the same as other card transactions. Check this page for more details.
- apple_pay.availableboolean
  Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
- apple_pay.display_preferenceobject
  Whether this payment method should be offered at checkout.
  apple_pay.display_preference.overridablenullable boolean
  For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
  apple_pay.display_preference.preferenceenum
  The account’s display preference.
  Possible enum values
  none
  Use the parent or default setting.
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.
  apple_pay.display_preference.valueenum
  The effective display preference value.
  Possible enum values
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.

au_becs_debitnullable object
Stripe users in Australia can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with an Australian bank account. Check this page for more details.
- au_becs_debit.availableboolean
  Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
- au_becs_debit.display_preferenceobject
  Whether this payment method should be offered at checkout.
  au_becs_debit.display_preference.overridablenullable boolean
  For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
  au_becs_debit.display_preference.preferenceenum
  The account’s display preference.
  Possible enum values
  none
  Use the parent or default setting.
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.
  au_becs_debit.display_preference.valueenum
  The effective display preference value.
  Possible enum values
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.

bacs_debitnullable object
Stripe users in the UK can accept Bacs Direct Debit payments from customers with a UK bank account, check this page for more details.
- bacs_debit.availableboolean
  Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
- bacs_debit.display_preferenceobject
  Whether this payment method should be offered at checkout.
  bacs_debit.display_preference.overridablenullable boolean
  For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
  bacs_debit.display_preference.preferenceenum
  The account’s display preference.
  Possible enum values
  none
  Use the parent or default setting.
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.
  bacs_debit.display_preference.valueenum
  The effective display preference value.
  Possible enum values
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.

bancontactnullable object
Bancontact is the most popular online payment method in Belgium, with over 15 million cards in circulation. Customers use a Bancontact card or mobile app linked to a Belgian bank account to make online payments that are secure, guaranteed, and confirmed immediately. Check this page for more details.
- bancontact.availableboolean
  Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
- bancontact.display_preferenceobject
  Whether this payment method should be offered at checkout.
  bancontact.display_preference.overridablenullable boolean
  For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
  bancontact.display_preference.preferenceenum
  The account’s display preference.
  Possible enum values
  none
  Use the parent or default setting.
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.
  bancontact.display_preference.valueenum
  The effective display preference value.
  Possible enum values
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.

bliknullable object
BLIK is a single use payment method that requires customers to authenticate their payments. When customers want to pay online using BLIK, they request a six-digit code from their banking application and enter it into the payment collection form. Check this page for more details.
- blik.availableboolean
  Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
- blik.display_preferenceobject
  Whether this payment method should be offered at checkout.
  blik.display_preference.overridablenullable boolean
  For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
  blik.display_preference.preferenceenum
  The account’s display preference.
  Possible enum values
  none
  Use the parent or default setting.
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.
  blik.display_preference.valueenum
  The effective display preference value.
  Possible enum values
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.

boletonullable object
Boleto is an official (regulated by the Central Bank of Brazil) payment method in Brazil. Check this page for more details.
- boleto.availableboolean
  Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
- boleto.display_preferenceobject
  Whether this payment method should be offered at checkout.
  boleto.display_preference.overridablenullable boolean
  For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
  boleto.display_preference.preferenceenum
  The account’s display preference.
  Possible enum values
  none
  Use the parent or default setting.
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.
  boleto.display_preference.valueenum
  The effective display preference value.
  Possible enum values
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.

cardnullable object
Cards are a popular way for consumers and businesses to pay online or in person. Stripe supports global and local card networks.
- card.availableboolean
  Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
- card.display_preferenceobject
  Whether this payment method should be offered at checkout.
  card.display_preference.overridablenullable boolean
  For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
  card.display_preference.preferenceenum
  The account’s display preference.
  Possible enum values
  none
  Use the parent or default setting.
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.
  card.display_preference.valueenum
  The effective display preference value.
  Possible enum values
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.

cartes_bancairesnullable object
Cartes Bancaires is France’s local card network. More than 95% of these cards are co-branded with either Visa or Mastercard, meaning you can process these cards over either Cartes Bancaires or the Visa or Mastercard networks. Check this page for more details.
- cartes_bancaires.availableboolean
  Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
- cartes_bancaires.display_preferenceobject
  Whether this payment method should be offered at checkout.
  cartes_bancaires.display_preference.overridablenullable boolean
  For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
  cartes_bancaires.display_preference.preferenceenum
  The account’s display preference.
  Possible enum values
  none
  Use the parent or default setting.
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.
  cartes_bancaires.display_preference.valueenum
  The effective display preference value.
  Possible enum values
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.

cashappnullable object
Cash App is a popular consumer app in the US that allows customers to bank, invest, send, and receive money using their digital wallet. Check this page for more details.
- cashapp.availableboolean
  Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
- cashapp.display_preferenceobject
  Whether this payment method should be offered at checkout.
  cashapp.display_preference.overridablenullable boolean
  For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
  cashapp.display_preference.preferenceenum
  The account’s display preference.
  Possible enum values
  none
  Use the parent or default setting.
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.
  cashapp.display_preference.valueenum
  The effective display preference value.
  Possible enum values
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.

customer_balancenullable object
Uses a customer’s cash balance for the payment. The cash balance can be funded via a bank transfer. Check this page for more details.
- customer_balance.availableboolean
  Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
- customer_balance.display_preferenceobject
  Whether this payment method should be offered at checkout.
  customer_balance.display_preference.overridablenullable boolean
  For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
  customer_balance.display_preference.preferenceenum
  The account’s display preference.
  Possible enum values
  none
  Use the parent or default setting.
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.
  customer_balance.display_preference.valueenum
  The effective display preference value.
  Possible enum values
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.

epsnullable object
EPS is an Austria-based payment method that allows customers to complete transactions online using their bank credentials. EPS is supported by all Austrian banks and is accepted by over 80% of Austrian online retailers. Check this page for more details.
- eps.availableboolean
  Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
- eps.display_preferenceobject
  Whether this payment method should be offered at checkout.
  eps.display_preference.overridablenullable boolean
  For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
  eps.display_preference.preferenceenum
  The account’s display preference.
  Possible enum values
  none
  Use the parent or default setting.
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.
  eps.display_preference.valueenum
  The effective display preference value.
  Possible enum values
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.

fpxnullable object
Financial Process Exchange (FPX) is a Malaysia-based payment method that allows customers to complete transactions online using their bank credentials. Bank Negara Malaysia (BNM), the Central Bank of Malaysia, and eleven other major Malaysian financial institutions are members of the PayNet Group, which owns and operates FPX. It is one of the most popular online payment methods in Malaysia, with nearly 90 million transactions in 2018 according to BNM. Check this page for more details.
- fpx.availableboolean
  Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
- fpx.display_preferenceobject
  Whether this payment method should be offered at checkout.
  fpx.display_preference.overridablenullable boolean
  For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
  fpx.display_preference.preferenceenum
  The account’s display preference.
  Possible enum values
  none
  Use the parent or default setting.
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.
  fpx.display_preference.valueenum
  The effective display preference value.
  Possible enum values
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.

giropaynullable object
giropay is a German payment method based on online banking, introduced in 2006. It allows customers to complete transactions online using their online banking environment, with funds debited from their bank account. Depending on their bank, customers confirm payments on giropay using a second factor of authentication or a PIN. giropay accounts for 10% of online checkouts in Germany. Check this page for more details.
- giropay.availableboolean
  Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
- giropay.display_preferenceobject
  Whether this payment method should be offered at checkout.
  giropay.display_preference.overridablenullable boolean
  For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
  giropay.display_preference.preferenceenum
  The account’s display preference.
  Possible enum values
  none
  Use the parent or default setting.
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.
  giropay.display_preference.valueenum
  The effective display preference value.
  Possible enum values
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.

google_paynullable object
Google Pay allows customers to make payments in your app or website using any credit or debit card saved to their Google Account, including those from Google Play, YouTube, Chrome, or an Android device. Use the Google Pay API to request any credit or debit card stored in your customer’s Google account. Check this page for more details.
- google_pay.availableboolean
  Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
- google_pay.display_preferenceobject
  Whether this payment method should be offered at checkout.
  google_pay.display_preference.overridablenullable boolean
  For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
  google_pay.display_preference.preferenceenum
  The account’s display preference.
  Possible enum values
  none
  Use the parent or default setting.
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.
  google_pay.display_preference.valueenum
  The effective display preference value.
  Possible enum values
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.

grabpaynullable object
GrabPay is a payment method developed by Grab. GrabPay is a digital wallet - customers maintain a balance in their wallets that they pay out with. Check this page for more details.
- grabpay.availableboolean
  Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
- grabpay.display_preferenceobject
  Whether this payment method should be offered at checkout.
  grabpay.display_preference.overridablenullable boolean
  For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
  grabpay.display_preference.preferenceenum
  The account’s display preference.
  Possible enum values
  none
  Use the parent or default setting.
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.
  grabpay.display_preference.valueenum
  The effective display preference value.
  Possible enum values
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.

idealnullable object
iDEAL is a Netherlands-based payment method that allows customers to complete transactions online using their bank credentials. All major Dutch banks are members of Currence, the scheme that operates iDEAL, making it the most popular online payment method in the Netherlands with a share of online transactions close to 55%. Check this page for more details.
- ideal.availableboolean
  Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
- ideal.display_preferenceobject
  Whether this payment method should be offered at checkout.
  ideal.display_preference.overridablenullable boolean
  For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
  ideal.display_preference.preferenceenum
  The account’s display preference.
  Possible enum values
  none
  Use the parent or default setting.
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.
  ideal.display_preference.valueenum
  The effective display preference value.
  Possible enum values
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.

jcbnullable object
JCB is a credit card company based in Japan. JCB is currently available in Japan to businesses approved by JCB, and available to all businesses in Australia, Canada, Hong Kong, Japan, New Zealand, Singapore, Switzerland, United Kingdom, United States, and all countries in the European Economic Area except Iceland. Check this page for more details.
- jcb.availableboolean
  Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
- jcb.display_preferenceobject
  Whether this payment method should be offered at checkout.
  jcb.display_preference.overridablenullable boolean
  For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
  jcb.display_preference.preferenceenum
  The account’s display preference.
  Possible enum values
  none
  Use the parent or default setting.
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.
  jcb.display_preference.valueenum
  The effective display preference value.
  Possible enum values
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.

klarnanullable object
Klarna gives customers a range of payment options during checkout. Available payment options vary depending on the customer’s billing address and the transaction amount. These payment options make it convenient for customers to purchase items in all price ranges. Check this page for more details.
- klarna.availableboolean
  Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
- klarna.display_preferenceobject
  Whether this payment method should be offered at checkout.
  klarna.display_preference.overridablenullable boolean
  For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
  klarna.display_preference.preferenceenum
  The account’s display preference.
  Possible enum values
  none
  Use the parent or default setting.
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.
  klarna.display_preference.valueenum
  The effective display preference value.
  Possible enum values
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.

konbininullable object
Konbini allows customers in Japan to pay for bills and online purchases at convenience stores with cash. Check this page for more details.
- konbini.availableboolean
  Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
- konbini.display_preferenceobject
  Whether this payment method should be offered at checkout.
  konbini.display_preference.overridablenullable boolean
  For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
  konbini.display_preference.preferenceenum
  The account’s display preference.
  Possible enum values
  none
  Use the parent or default setting.
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.
  konbini.display_preference.valueenum
  The effective display preference value.
  Possible enum values
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.

linknullable object
Link is a payment method network. With Link, users save their payment details once, then reuse that information to pay with one click for any business on the network.
- link.availableboolean
  Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
- link.display_preferenceobject
  Whether this payment method should be offered at checkout.
  link.display_preference.overridablenullable boolean
  For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
  link.display_preference.preferenceenum
  The account’s display preference.
  Possible enum values
  none
  Use the parent or default setting.
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.
  link.display_preference.valueenum
  The effective display preference value.
  Possible enum values
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.

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

mobilepaynullable object
MobilePay is a single-use card wallet payment method used in Denmark and Finland. It allows customers to authenticate and approve payments using the MobilePay app. Check this page for more details.
- mobilepay.availableboolean
  Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
- mobilepay.display_preferenceobject
  Whether this payment method should be offered at checkout.
  mobilepay.display_preference.overridablenullable boolean
  For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
  mobilepay.display_preference.preferenceenum
  The account’s display preference.
  Possible enum values
  none
  Use the parent or default setting.
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.
  mobilepay.display_preference.valueenum
  The effective display preference value.
  Possible enum values
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.

multibanconullable object
Stripe users in Europe and the United States can accept Multibanco payments from customers in Portugal using Sources—a single integration path for creating payments using any supported method.
- multibanco.availableboolean
  Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
- multibanco.display_preferenceobject
  Whether this payment method should be offered at checkout.
  multibanco.display_preference.overridablenullable boolean
  For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
  multibanco.display_preference.preferenceenum
  The account’s display preference.
  Possible enum values
  none
  Use the parent or default setting.
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.
  multibanco.display_preference.valueenum
  The effective display preference value.
  Possible enum values
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.

oxxonullable object
OXXO is a Mexican chain of convenience stores with thousands of locations across Latin America and represents nearly 20% of online transactions in Mexico. OXXO allows customers to pay bills and online purchases in-store with cash. Check this page for more details.
- oxxo.availableboolean
  Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
- oxxo.display_preferenceobject
  Whether this payment method should be offered at checkout.
  oxxo.display_preference.overridablenullable boolean
  For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
  oxxo.display_preference.preferenceenum
  The account’s display preference.
  Possible enum values
  none
  Use the parent or default setting.
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.
  oxxo.display_preference.valueenum
  The effective display preference value.
  Possible enum values
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.

p24nullable object
Przelewy24 is a Poland-based payment method aggregator that allows customers to complete transactions online using bank transfers and other methods. Bank transfers account for 30% of online payments in Poland and Przelewy24 provides a way for customers to pay with over 165 banks. Check this page for more details.
- p24.availableboolean
  Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
- p24.display_preferenceobject
  Whether this payment method should be offered at checkout.
  p24.display_preference.overridablenullable boolean
  For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
  p24.display_preference.preferenceenum
  The account’s display preference.
  Possible enum values
  none
  Use the parent or default setting.
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.
  p24.display_preference.valueenum
  The effective display preference value.
  Possible enum values
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.

paynownullable object
PayNow is a Singapore-based payment method that allows customers to make a payment using their preferred app from participating banks and participating non-bank financial institutions. Check this page for more details.
- paynow.availableboolean
  Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
- paynow.display_preferenceobject
  Whether this payment method should be offered at checkout.
  paynow.display_preference.overridablenullable boolean
  For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
  paynow.display_preference.preferenceenum
  The account’s display preference.
  Possible enum values
  none
  Use the parent or default setting.
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.
  paynow.display_preference.valueenum
  The effective display preference value.
  Possible enum values
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.

paypalnullable object
PayPal, a digital wallet popular with customers in Europe, allows your customers worldwide to pay using their PayPal account. Check this page for more details.
- paypal.availableboolean
  Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
- paypal.display_preferenceobject
  Whether this payment method should be offered at checkout.
  paypal.display_preference.overridablenullable boolean
  For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
  paypal.display_preference.preferenceenum
  The account’s display preference.
  Possible enum values
  none
  Use the parent or default setting.
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.
  paypal.display_preference.valueenum
  The effective display preference value.
  Possible enum values
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.

promptpaynullable object
PromptPay is a Thailand-based payment method that allows customers to make a payment using their preferred app from participating banks. Check this page for more details.
- promptpay.availableboolean
  Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
- promptpay.display_preferenceobject
  Whether this payment method should be offered at checkout.
  promptpay.display_preference.overridablenullable boolean
  For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
  promptpay.display_preference.preferenceenum
  The account’s display preference.
  Possible enum values
  none
  Use the parent or default setting.
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.
  promptpay.display_preference.valueenum
  The effective display preference value.
  Possible enum values
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.

revolut_paynullable object
Revolut Pay, developed by Revolut, a global finance app, is a digital wallet payment method. Revolut Pay uses the customer’s stored balance or cards to fund the payment, and offers the option for non-Revolut customers to save their details after their first purchase.
- revolut_pay.availableboolean
  Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
- revolut_pay.display_preferenceobject
  Whether this payment method should be offered at checkout.
  revolut_pay.display_preference.overridablenullable boolean
  For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
  revolut_pay.display_preference.preferenceenum
  The account’s display preference.
  Possible enum values
  none
  Use the parent or default setting.
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.
  revolut_pay.display_preference.valueenum
  The effective display preference value.
  Possible enum values
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.

sepa_debitnullable object
The Single Euro Payments Area (SEPA) is an initiative of the European Union to simplify payments within and across member countries. SEPA established and enforced banking standards to allow for the direct debiting of every EUR-denominated bank account within the SEPA region, check this page for more details.
- sepa_debit.availableboolean
  Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
- sepa_debit.display_preferenceobject
  Whether this payment method should be offered at checkout.
  sepa_debit.display_preference.overridablenullable boolean
  For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
  sepa_debit.display_preference.preferenceenum
  The account’s display preference.
  Possible enum values
  none
  Use the parent or default setting.
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.
  sepa_debit.display_preference.valueenum
  The effective display preference value.
  Possible enum values
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.

sofortnullable object
Stripe users in Europe and the United States can use the Payment Intents API—a single integration path for creating payments using any supported method—to accept Sofort payments from customers. Check this page for more details.
- sofort.availableboolean
  Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
- sofort.display_preferenceobject
  Whether this payment method should be offered at checkout.
  sofort.display_preference.overridablenullable boolean
  For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
  sofort.display_preference.preferenceenum
  The account’s display preference.
  Possible enum values
  none
  Use the parent or default setting.
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.
  sofort.display_preference.valueenum
  The effective display preference value.
  Possible enum values
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.

swishnullable object
Swish is a real-time payment method popular in Sweden. It allows customers to authenticate and approve payments using the Swish mobile app and the Swedish BankID mobile app. Check this page for more details.
- swish.availableboolean
  Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
- swish.display_preferenceobject
  Whether this payment method should be offered at checkout.
  swish.display_preference.overridablenullable boolean
  For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
  swish.display_preference.preferenceenum
  The account’s display preference.
  Possible enum values
  none
  Use the parent or default setting.
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.
  swish.display_preference.valueenum
  The effective display preference value.
  Possible enum values
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.

twintnullable object
Twint is a payment method popular in Switzerland. It allows customers to pay using their mobile phone. Check this page for more details.
- twint.availableboolean
  Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
- twint.display_preferenceobject
  Whether this payment method should be offered at checkout.
  twint.display_preference.overridablenullable boolean
  For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
  twint.display_preference.preferenceenum
  The account’s display preference.
  Possible enum values
  none
  Use the parent or default setting.
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.
  twint.display_preference.valueenum
  The effective display preference value.
  Possible enum values
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.

us_bank_accountnullable object
Stripe users in the United States can accept ACH direct debit payments from customers with a US bank account using the Automated Clearing House (ACH) payments system operated by Nacha. Check this page for more details.
- us_bank_account.availableboolean
  Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
- us_bank_account.display_preferenceobject
  Whether this payment method should be offered at checkout.
  us_bank_account.display_preference.overridablenullable boolean
  For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
  us_bank_account.display_preference.preferenceenum
  The account’s display preference.
  Possible enum values
  none
  Use the parent or default setting.
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.
  us_bank_account.display_preference.valueenum
  The effective display preference value.
  Possible enum values
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.

wechat_paynullable object
WeChat, owned by Tencent, is China’s leading mobile app with over 1 billion monthly active users. Chinese consumers can use WeChat Pay to pay for goods and services inside of businesses’ apps and websites. WeChat Pay users buy most frequently in gaming, e-commerce, travel, online education, and food/nutrition. Check this page for more details.
- wechat_pay.availableboolean
  Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
- wechat_pay.display_preferenceobject
  Whether this payment method should be offered at checkout.
  wechat_pay.display_preference.overridablenullable boolean
  For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
  wechat_pay.display_preference.preferenceenum
  The account’s display preference.
  Possible enum values
  none
  Use the parent or default setting.
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.
  wechat_pay.display_preference.valueenum
  The effective display preference value.
  Possible enum values
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.

zipnullable object
Zip gives your customers a way to split purchases over a series of payments. Check this page for more details like country availability.
- zip.availableboolean
  Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.
- zip.display_preferenceobject
  Whether this payment method should be offered at checkout.
  zip.display_preference.overridablenullable boolean
  For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.
  zip.display_preference.preferenceenum
  The account’s display preference.
  Possible enum values
  none
  Use the parent or default setting.
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.
  zip.display_preference.valueenum
  The effective display preference value.
  Possible enum values
  off
  Don’t offer the payment method to users at checkout.
  on
  Offer the payment method to users at checkout.

The Payment Method Configuration object

{
  "id": "pmc_abcdef",
  "object": "payment_method_configuration",
  "acss_debit": {
    "available": false,
    "display_preference": {
      "overridable": null,
      "preference": "off",
      "value": "off"
    }
  },
  "active": true,
  "affirm": {
    "available": false,
    "display_preference": {
      "overridable": null,
      "preference": "off",
      "value": "off"
    }
  },
  "afterpay_clearpay": {
    "available": false,
    "display_preference": {
      "overridable": null,
      "preference": "off",
      "value": "off"
    }
  },
  "alipay": {
    "available": false,
    "display_preference": {
      "overridable": null,
      "preference": "off",
      "value": "off"
    }
  },
  "apple_pay": {
    "available": true,
    "display_preference": {
      "overridable": null,
      "preference": "on",
      "value": "on"
    }
  },
  "bancontact": {
    "available": false,
    "display_preference": {
      "overridable": null,
      "preference": "off",
      "value": "off"
    }
  },
  "card": {
    "available": true,
    "display_preference": {
      "overridable": null,
      "preference": "on",
      "value": "on"
    }
  },
  "cartes_bancaires": {
    "available": false,
    "display_preference": {
      "overridable": null,
      "preference": "off",
      "value": "off"
    }
  },
  "eps": {
    "available": false,
    "display_preference": {
      "overridable": null,
      "preference": "off",
      "value": "off"
    }
  },
  "giropay": {
    "available": false,
    "display_preference": {
      "overridable": null,
      "preference": "off",
      "value": "off"
    }
  },
  "google_pay": {
    "available": true,
    "display_preference": {
      "overridable": null,
      "preference": "on",
      "value": "on"
    }
  },
  "ideal": {
    "available": false,
    "display_preference": {
      "overridable": null,
      "preference": "off",
      "value": "off"
    }
  },
  "is_default": true,
  "klarna": {
    "available": false,
    "display_preference": {
      "overridable": null,
      "preference": "off",
      "value": "off"
    }
  },
  "link": {
    "available": true,
    "display_preference": {
      "overridable": null,
      "preference": "on",
      "value": "on"
    }
  },
  "livemode": false,
  "name": "Default",
  "p24": {
    "available": false,
    "display_preference": {
      "overridable": null,
      "preference": "off",
      "value": "off"
    }
  },
  "sepa_debit": {
    "available": false,
    "display_preference": {
      "overridable": null,
      "preference": "off",
      "value": "off"
    }
  },
  "sofort": {
    "available": false,
    "display_preference": {
      "overridable": null,
      "preference": "off",
      "value": "off"
    }
  },
  "us_bank_account": {
    "available": false,
    "display_preference": {
      "overridable": null,
      "preference": "off",
      "value": "off"
    }
  },
  "wechat_pay": {
    "available": false,
    "display_preference": {
      "overridable": null,
      "preference": "off",
      "value": "off"
    }
  }
}

The Payment Method Configuration object

Attributes

idstringretrievable with publishable key

objectstring

activeboolean

applicationnullable string

is_defaultboolean

namestring

parentnullable string

More attributesCollapse all

acss_debitnullable object

acss_debit.availableboolean

acss_debit.display_preferenceobject

acss_debit.display_preference.overridablenullable boolean

acss_debit.display_preference.preferenceenum

acss_debit.display_preference.valueenum

affirmnullable object

affirm.availableboolean

affirm.display_preferenceobject

affirm.display_preference.overridablenullable boolean

affirm.display_preference.preferenceenum

affirm.display_preference.valueenum

afterpay_clearpaynullable object

afterpay_clearpay.availableboolean

afterpay_clearpay.display_preferenceobject

afterpay_clearpay.display_preference.overridablenullable boolean

afterpay_clearpay.display_preference.preferenceenum

afterpay_clearpay.display_preference.valueenum

alipaynullable object

alipay.availableboolean

alipay.display_preferenceobject

alipay.display_preference.overridablenullable boolean

alipay.display_preference.preferenceenum

alipay.display_preference.valueenum

amazon_paynullable object

amazon_pay.availableboolean

amazon_pay.display_preferenceobject

amazon_pay.display_preference.overridablenullable boolean

amazon_pay.display_preference.preferenceenum

amazon_pay.display_preference.valueenum

apple_paynullable object

apple_pay.availableboolean

apple_pay.display_preferenceobject

apple_pay.display_preference.overridablenullable boolean

apple_pay.display_preference.preferenceenum

apple_pay.display_preference.valueenum

au_becs_debitnullable object

au_becs_debit.availableboolean

au_becs_debit.display_preferenceobject

au_becs_debit.display_preference.overridablenullable boolean

au_becs_debit.display_preference.preferenceenum

au_becs_debit.display_preference.valueenum

bacs_debitnullable object

bacs_debit.availableboolean

bacs_debit.display_preferenceobject

bacs_debit.display_preference.overridablenullable boolean

bacs_debit.display_preference.preferenceenum

bacs_debit.display_preference.valueenum

bancontactnullable object

bancontact.availableboolean

bancontact.display_preferenceobject

bancontact.display_preference.overridablenullable boolean

bancontact.display_preference.preferenceenum

bancontact.display_preference.valueenum

bliknullable object

blik.availableboolean

blik.display_preferenceobject

blik.display_preference.overridablenullable boolean

blik.display_preference.preferenceenum

blik.display_preference.valueenum

boletonullable object

boleto.availableboolean

boleto.display_preferenceobject

boleto.display_preference.overridablenullable boolean

boleto.display_preference.preferenceenum

boleto.display_preference.valueenum

cardnullable object

card.availableboolean

card.display_preferenceobject

card.display_preference.overridablenullable boolean

More attributes