Creates a payment method configuration
Parameters
- namestring
Configuration name.
- parentstring
Configuration’s parent configuration. Specify to create a child configuration.
More parameters
- acss_
debitobject Canadian pre-authorized debit payments, check this page for more details like country availability.
- acss_debit.
display_ preferenceobject Whether or not the payment method should be displayed.
- acss_debit.
display_preference. preferenceenum The account’s preference for whether or not to display this payment method.
Possible enum valuesnone
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.
- affirmobject
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.
display_ preferenceobject Whether or not the payment method should be displayed.
- affirm.
display_preference. preferenceenum The account’s preference for whether or not to display this payment method.
Possible enum valuesnone
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_
clearpayobject 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.
display_ preferenceobject Whether or not the payment method should be displayed.
- afterpay_clearpay.
display_preference. preferenceenum The account’s preference for whether or not to display this payment method.
Possible enum valuesnone
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.
- alipayobject
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.
display_ preferenceobject Whether or not the payment method should be displayed.
- alipay.
display_preference. preferenceenum The account’s preference for whether or not to display this payment method.
Possible enum valuesnone
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_
payobject Amazon Pay is a wallet payment method that lets your customers check out the same way as on Amazon.
- amazon_pay.
display_ preferenceobject Whether or not the payment method should be displayed.
- amazon_pay.
display_preference. preferenceenum The account’s preference for whether or not to display this payment method.
Possible enum valuesnone
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_
payobject 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.
display_ preferenceobject Whether or not the payment method should be displayed.
- apple_pay.
display_preference. preferenceenum The account’s preference for whether or not to display this payment method.
Possible enum valuesnone
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_ laterobject Apple Pay Later, a payment method for customers to buy now and pay later, gives your customers a way to split purchases into four installments across six weeks.
- apple_pay_later.
display_ preferenceobject Whether or not the payment method should be displayed.
- apple_pay_later.
display_preference. preferenceenum The account’s preference for whether or not to display this payment method.
Possible enum valuesnone
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_ debitobject 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.
display_ preferenceobject Whether or not the payment method should be displayed.
- au_becs_debit.
display_preference. preferenceenum The account’s preference for whether or not to display this payment method.
Possible enum valuesnone
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_
debitobject 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.
display_ preferenceobject Whether or not the payment method should be displayed.
- bacs_debit.
display_preference. preferenceenum The account’s preference for whether or not to display this payment method.
Possible enum valuesnone
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.
- bancontactobject
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.
display_ preferenceobject Whether or not the payment method should be displayed.
- bancontact.
display_preference. preferenceenum The account’s preference for whether or not to display this payment method.
Possible enum valuesnone
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.
- blikobject
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.
display_ preferenceobject Whether or not the payment method should be displayed.
- blik.
display_preference. preferenceenum The account’s preference for whether or not to display this payment method.
Possible enum valuesnone
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.
- boletoobject
Boleto is an official (regulated by the Central Bank of Brazil) payment method in Brazil. Check this page for more details.
- boleto.
display_ preferenceobject Whether or not the payment method should be displayed.
- boleto.
display_preference. preferenceenum The account’s preference for whether or not to display this payment method.
Possible enum valuesnone
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.
- cardobject
Cards are a popular way for consumers and businesses to pay online or in person. Stripe supports global and local card networks.
- card.
display_ preferenceobject Whether or not the payment method should be displayed.
- card.
display_preference. preferenceenum The account’s preference for whether or not to display this payment method.
Possible enum valuesnone
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_
bancairesobject 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.
display_ preferenceobject Whether or not the payment method should be displayed.
- cartes_bancaires.
display_preference. preferenceenum The account’s preference for whether or not to display this payment method.
Possible enum valuesnone
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.
- cashappobject
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.
display_ preferenceobject Whether or not the payment method should be displayed.
- cashapp.
display_preference. preferenceenum The account’s preference for whether or not to display this payment method.
Possible enum valuesnone
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_
balanceobject 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.
display_ preferenceobject Whether or not the payment method should be displayed.
- customer_balance.
display_preference. preferenceenum The account’s preference for whether or not to display this payment method.
Possible enum valuesnone
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.
- epsobject
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.
display_ preferenceobject Whether or not the payment method should be displayed.
- eps.
display_preference. preferenceenum The account’s preference for whether or not to display this payment method.
Possible enum valuesnone
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.
- fpxobject
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.
display_ preferenceobject Whether or not the payment method should be displayed.
- fpx.
display_preference. preferenceenum The account’s preference for whether or not to display this payment method.
Possible enum valuesnone
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.
- giropayobject
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.
display_ preferenceobject Whether or not the payment method should be displayed.
- giropay.
display_preference. preferenceenum The account’s preference for whether or not to display this payment method.
Possible enum valuesnone
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_
payobject 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.
display_ preferenceobject Whether or not the payment method should be displayed.
- google_pay.
display_preference. preferenceenum The account’s preference for whether or not to display this payment method.
Possible enum valuesnone
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.
- grabpayobject
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.
display_ preferenceobject Whether or not the payment method should be displayed.
- grabpay.
display_preference. preferenceenum The account’s preference for whether or not to display this payment method.
Possible enum valuesnone
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.
- idealobject
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.
display_ preferenceobject Whether or not the payment method should be displayed.
- ideal.
display_preference. preferenceenum The account’s preference for whether or not to display this payment method.
Possible enum valuesnone
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.
- jcbobject
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.
display_ preferenceobject Whether or not the payment method should be displayed.
- jcb.
display_preference. preferenceenum The account’s preference for whether or not to display this payment method.
Possible enum valuesnone
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.
- klarnaobject
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.
display_ preferenceobject Whether or not the payment method should be displayed.
- klarna.
display_preference. preferenceenum The account’s preference for whether or not to display this payment method.
Possible enum valuesnone
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.
- konbiniobject
Konbini allows customers in Japan to pay for bills and online purchases at convenience stores with cash. Check this page for more details.
- konbini.
display_ preferenceobject Whether or not the payment method should be displayed.
- konbini.
display_preference. preferenceenum The account’s preference for whether or not to display this payment method.
Possible enum valuesnone
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.
- linkobject
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.
display_ preferenceobject Whether or not the payment method should be displayed.
- link.
display_preference. preferenceenum The account’s preference for whether or not to display this payment method.
Possible enum valuesnone
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.
- mobilepayobject
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.
display_ preferenceobject Whether or not the payment method should be displayed.
- mobilepay.
display_preference. preferenceenum The account’s preference for whether or not to display this payment method.
Possible enum valuesnone
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.
- multibancoobject
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.
display_ preferenceobject Whether or not the payment method should be displayed.
- multibanco.
display_preference. preferenceenum The account’s preference for whether or not to display this payment method.
Possible enum valuesnone
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.
- oxxoobject
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.
display_ preferenceobject Whether or not the payment method should be displayed.
- oxxo.
display_preference. preferenceenum The account’s preference for whether or not to display this payment method.
Possible enum valuesnone
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.
- p24object
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.
display_ preferenceobject Whether or not the payment method should be displayed.
- p24.
display_preference. preferenceenum The account’s preference for whether or not to display this payment method.
Possible enum valuesnone
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.
- paynowobject
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.
display_ preferenceobject Whether or not the payment method should be displayed.
- paynow.
display_preference. preferenceenum The account’s preference for whether or not to display this payment method.
Possible enum valuesnone
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.
- paypalobject
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.
display_ preferenceobject Whether or not the payment method should be displayed.
- paypal.
display_preference. preferenceenum The account’s preference for whether or not to display this payment method.
Possible enum valuesnone
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.
- promptpayobject
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.
display_ preferenceobject Whether or not the payment method should be displayed.
- promptpay.
display_preference. preferenceenum The account’s preference for whether or not to display this payment method.
Possible enum valuesnone
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_
payobject 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.
display_ preferenceobject Whether or not the payment method should be displayed.
- revolut_pay.
display_preference. preferenceenum The account’s preference for whether or not to display this payment method.
Possible enum valuesnone
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_
debitobject 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.
display_ preferenceobject Whether or not the payment method should be displayed.
- sepa_debit.
display_preference. preferenceenum The account’s preference for whether or not to display this payment method.
Possible enum valuesnone
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.
- sofortobject
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.
display_ preferenceobject Whether or not the payment method should be displayed.
- sofort.
display_preference. preferenceenum The account’s preference for whether or not to display this payment method.
Possible enum valuesnone
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.
- swishobject
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.
display_ preferenceobject Whether or not the payment method should be displayed.
- swish.
display_preference. preferenceenum The account’s preference for whether or not to display this payment method.
Possible enum valuesnone
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.
- twintobject
Twint is a payment method popular in Switzerland. It allows customers to pay using their mobile phone. Check this page for more details.
- twint.
display_ preferenceobject Whether or not the payment method should be displayed.
- twint.
display_preference. preferenceenum The account’s preference for whether or not to display this payment method.
Possible enum valuesnone
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_ accountobject 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.
display_ preferenceobject Whether or not the payment method should be displayed.
- us_bank_account.
display_preference. preferenceenum The account’s preference for whether or not to display this payment method.
Possible enum valuesnone
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_
payobject 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.
display_ preferenceobject Whether or not the payment method should be displayed.
- wechat_pay.
display_preference. preferenceenum The account’s preference for whether or not to display this payment method.
Possible enum valuesnone
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.
- zipobject
Zip gives your customers a way to split purchases over a series of payments. Check this page for more details like country availability.
- zip.
display_ preferenceobject Whether or not the payment method should be displayed.
- zip.
display_preference. preferenceenum The account’s preference for whether or not to display this payment method.
Possible enum valuesnone
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.
Returns
Returns 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" } }}