Stripe: Payment method configurations schemas

← Payment method configurations operations · All schemas

Update payment method configuration — request body — body affirm

Field	Type	Presence	Description and constraints
$	object	Root	[Affirm](https://www.affirm.com/) 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](https://docs.stripe.com/payments/affirm) for more details like country availability.
display_preference	object	Optional
display_preference.preference	string	Optional	One of: none, off, on

Update payment method configuration — request body — body alipay

Field	Type	Presence	Description and constraints
$	object	Root	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](https://docs.stripe.com/payments/alipay) for more details.
display_preference	object	Optional
display_preference.preference	string	Optional	One of: none, off, on

Update payment method configuration — request body — body apple pay

Field	Type	Presence	Description and constraints
$	object	Root	Stripe users can accept [Apple Pay](https://stripe.com/payments/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](https://stripe.com/pricing) is the same as other card transactions. Check this [page](https://docs.stripe.com/apple-pay) for more details.
display_preference	object	Optional
display_preference.preference	string	Optional	One of: none, off, on

Update payment method configuration — request body — body bancontact

Field	Type	Presence	Description and constraints
$	object	Root	Bancontact is the most popular online payment method in Belgium, with over 15 million cards in circulation. [Customers](https://docs.stripe.com/api/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](https://docs.stripe.com/payments/bancontact) for more details.
display_preference	object	Optional
display_preference.preference	string	Optional	One of: none, off, on

Update payment method configuration — request body — body billie

Field	Type	Presence	Description and constraints
$	object	Root	Billie is a [single-use](https://docs.stripe.com/payments/payment-methods#usage) payment method that offers businesses Pay by Invoice where they offer payment terms ranging from 7-120 days. Customers are redirected from your website or app, authorize the payment with Billie, then return to your website or app. You get [immediate notification](/payments/payment-methods#payment-notification) of whether the payment succeeded or failed.
display_preference	object	Optional
display_preference.preference	string	Optional	One of: none, off, on

Update payment method configuration — request body — body blik

Field	Type	Presence	Description and constraints
$	object	Root	BLIK is a [single use](https://docs.stripe.com/payments/payment-methods#usage) 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](https://docs.stripe.com/payments/blik) for more details.
display_preference	object	Optional
display_preference.preference	string	Optional	One of: none, off, on

Update payment method configuration — request body — body fpx

Field	Type	Presence	Description and constraints
$	object	Root	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](https://docs.stripe.com/payments/fpx) for more details.
display_preference	object	Optional
display_preference.preference	string	Optional	One of: none, off, on

Update payment method configuration — request body — body giropay

Field	Type	Presence	Description and constraints
$	object	Root	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](https://docs.stripe.com/payments/giropay) for more details.
display_preference	object	Optional
display_preference.preference	string	Optional	One of: none, off, on

Update payment method configuration — request body — body google pay

Field	Type	Presence	Description and constraints
$	object	Root	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](https://docs.stripe.com/google-pay) for more details.
display_preference	object	Optional
display_preference.preference	string	Optional	One of: none, off, on

Update payment method configuration — request body — body ideal

Field	Type	Presence	Description and constraints
$	object	Root	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](https://docs.stripe.com/payments/ideal) for more details.
display_preference	object	Optional
display_preference.preference	string	Optional	One of: none, off, on

Update payment method configuration — request body — body jcb

Field	Type	Presence	Description and constraints
$	object	Root	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](https://support.stripe.com/questions/accepting-japan-credit-bureau-%28jcb%29-payments) for more details.
display_preference	object	Optional
display_preference.preference	string	Optional	One of: none, off, on

Update payment method configuration — request body — body klarna

Field	Type	Presence	Description and constraints
$	object	Root	Klarna gives customers a range of [payment options](https://docs.stripe.com/payments/klarna#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](https://docs.stripe.com/payments/klarna) for more details.
display_preference	object	Optional
display_preference.preference	string	Optional	One of: none, off, on

Update payment method configuration — request body — body mobilepay

Field	Type	Presence	Description and constraints
$	object	Root	MobilePay is a [single-use](https://docs.stripe.com/payments/payment-methods#usage) card wallet payment method used in Denmark and Finland. It allows customers to [authenticate and approve](https://docs.stripe.com/payments/payment-methods#customer-actions) payments using the MobilePay app. Check this [page](https://docs.stripe.com/payments/mobilepay) for more details.
display_preference	object	Optional
display_preference.preference	string	Optional	One of: none, off, on

Update payment method configuration — request body — body p24

Field	Type	Presence	Description and constraints
$	object	Root	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](https://docs.stripe.com/payments/p24) for more details.
display_preference	object	Optional
display_preference.preference	string	Optional	One of: none, off, on

Update payment method configuration — request body — body satispay

Field	Type	Presence	Description and constraints
$	object	Root	Satispay is a [single-use](/payments/payment-methods#usage) payment method where customers are required to [authenticate](/payments/payment-methods#customer-actions) their payment. Customers pay by being redirected from your website or app, authorizing the payment with Satispay, then returning to your website or app. You get [immediate notification](/payments/payment-methods#payment-notification) of whether the payment succeeded or failed.
display_preference	object	Optional
display_preference.preference	string	Optional	One of: none, off, on

Update payment method configuration — request body — body scalapay

Field	Type	Presence	Description and constraints
$	object	Root	Scalapay is a [single-use](/payments/payment-methods#usage) payment method that lets customers pay in 3 or 4 installments. Customers are redirected from your website or app, authorize the payment with Scalapay, then return to your website or app. You get [immediate notification](/payments/payment-methods#payment-notification) of whether the payment succeeded or failed.
display_preference	object	Optional
display_preference.preference	string	Optional	One of: none, off, on

Update payment method configuration — request body — body sepa debit

Field	Type	Presence	Description and constraints
$	object	Root	The [Single Euro Payments Area (SEPA)](https://en.wikipedia.org/wiki/Single_Euro_Payments_Area) 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](https://docs.stripe.com/payments/sepa-debit) for more details.
display_preference	object	Optional
display_preference.preference	string	Optional	One of: none, off, on

Update payment method configuration — request body — body sequra

Field	Type	Presence	Description and constraints
$	object	Root	SeQura is a [single-use](https://docs.stripe.com/payments/payment-methods#usage) payment method that offers customers payment terms ranging from 7-120 days. Customers are redirected from your website or app, authorize the payment with SeQura, then return to your website or app. You get [immediate notification](https://docs.stripe.com/payments/payment-methods#payment-notification) of whether the payment succeeded or failed.
display_preference	object	Optional
display_preference.preference	string	Optional	One of: none, off, on

Update payment method configuration — request body — body sofort

Field	Type	Presence	Description and constraints
$	object	Root	Stripe users in Europe and the United States can use the [Payment Intents API](https://stripe.com/docs/payments/payment-intents)—a single integration path for creating payments using any supported method—to accept [Sofort](https://www.sofort.com/) payments from customers. Check this [page](https://docs.stripe.com/payments/sofort) for more details.
display_preference	object	Optional
display_preference.preference	string	Optional	One of: none, off, on

Update payment method configuration — request body — body sunbit

Field	Type	Presence	Description and constraints
$	object	Root	Sunbit is a [single-use](https://docs.stripe.com/payments/payment-methods#usage) payment method where customers choose to pay in 3, 6, or 12 installments. Customers are redirected from your website or app, authorize the payment with Sunbit, then return to your website or app. You get [immediate notification](https://docs.stripe.com/payments/payment-methods#payment-notification) of whether the payment succeeded or failed.
display_preference	object	Optional
display_preference.preference	string	Optional	One of: none, off, on

Update payment method configuration — request body — body swish

Field	Type	Presence	Description and constraints
$	object	Root	Swish is a [real-time](https://docs.stripe.com/payments/real-time) payment method popular in Sweden. It allows customers to [authenticate and approve](https://docs.stripe.com/payments/payment-methods#customer-actions) payments using the Swish mobile app and the Swedish BankID mobile app. Check this [page](https://docs.stripe.com/payments/swish) for more details.
display_preference	object	Optional
display_preference.preference	string	Optional	One of: none, off, on

Update payment method configuration — request body — body wechat pay

Field	Type	Presence	Description and constraints
$	object	Root	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](https://docs.stripe.com/payments/wechat-pay) for more details.
display_preference	object	Optional
display_preference.preference	string	Optional	One of: none, off, on

Update payment method configuration — response body

Field	Type	Presence	Description and constraints
$	object	Root	PaymentMethodConfigurations control which payment methods are displayed to your customers when you don't explicitly specify payment method types. You can have multiple configurations with different sets of payment methods for different scenarios. There are two types of PaymentMethodConfigurations. Which is used depends on the [charge type](https://docs.stripe.com/connect/charges): **Direct** configurations apply to payments created on your account, including Connect destination charges, Connect separate charges and transfers, and payments not involving Connect. **Child** configurations apply to payments created on your connected accounts using direct charges, and charges with the on_behalf_of parameter. Child configurations have a `parent` that sets default values and controls which settings connected accounts may override. You can specify a parent ID at payment time, and Stripe will automatically resolve the connected account’s associated child configuration. Parent configurations are [managed in the dashboard](https://dashboard.stripe.com/settings/payment_methods/connected_accounts) and are not available in this API. Related guides: - [Payment Method Configurations API](https://docs.stripe.com/connect/payment-method-configurations) - [Multiple configurations on dynamic payment methods](https://docs.stripe.com/payments/multiple-payment-method-configs) - [Multiple configurations for your Connect accounts](https://docs.stripe.com/connect/multiple-payment-method-configurations)
acss_debit	Model	Optional	Expand Update payment method configuration — response body — eps
active	boolean	Required within parent	Whether the configuration can be used for new payments.
affirm	Model	Optional	Expand Update payment method configuration — response body — eps
afterpay_clearpay	Model	Optional	Expand Update payment method configuration — response body — eps
alipay	Model	Optional	Expand Update payment method configuration — response body — eps
alma	Model	Optional	Expand Update payment method configuration — response body — eps
amazon_pay	Model	Optional	Expand Update payment method configuration — response body — eps
apple_pay	Model	Optional	Expand Update payment method configuration — response body — eps
application	JSON	Optional
application (anyOf 1)	string	Alternative	For child configs, the Connect application associated with the configuration. Maximum length: 5000
application (anyOf 2)	null	Alternative
au_becs_debit	Model	Optional	Expand Update payment method configuration — response body — eps
bacs_debit	Model	Optional	Expand Update payment method configuration — response body — eps
bancontact	Model	Optional	Expand Update payment method configuration — response body — eps
billie	Model	Optional	Expand Update payment method configuration — response body — eps
bizum	Model	Optional	Expand Update payment method configuration — response body — eps
blik	Model	Optional	Expand Update payment method configuration — response body — eps
boleto	Model	Optional	Expand Update payment method configuration — response body — eps
card	Model	Optional	Expand Update payment method configuration — response body — eps
cartes_bancaires	Model	Optional	Expand Update payment method configuration — response body — eps
cashapp	Model	Optional	Expand Update payment method configuration — response body — eps
crypto	Model	Optional	Expand Update payment method configuration — response body — eps
customer_balance	Model	Optional	Expand Update payment method configuration — response body — eps
eps	Model	Optional	Expand Update payment method configuration — response body — eps
fpx	Model	Optional	Expand Update payment method configuration — response body — eps
giropay	Model	Optional	Expand Update payment method configuration — response body — eps
google_pay	Model	Optional	Expand Update payment method configuration — response body — eps
grabpay	Model	Optional	Expand Update payment method configuration — response body — eps
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
ideal	Model	Optional	Expand Update payment method configuration — response body — eps
is_default	boolean	Required within parent	The default configuration is used whenever a payment method configuration is not specified.
jcb	Model	Optional	Expand Update payment method configuration — response body — eps
kakao_pay	Model	Optional	Expand Update payment method configuration — response body — eps
klarna	Model	Optional	Expand Update payment method configuration — response body — eps
konbini	Model	Optional	Expand Update payment method configuration — response body — eps
kr_card	Model	Optional	Expand Update payment method configuration — response body — eps
link	Model	Optional	Expand Update payment method configuration — response body — eps
livemode	boolean	Required within parent	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
mb_way	Model	Optional	Expand Update payment method configuration — response body — eps
mobilepay	Model	Optional	Expand Update payment method configuration — response body — eps
multibanco	Model	Optional	Expand Update payment method configuration — response body — eps
name	string	Required within parent	The configuration's name. Maximum length: 5000
naver_pay	Model	Optional	Expand Update payment method configuration — response body — eps
nz_bank_account	Model	Optional	Expand Update payment method configuration — response body — eps
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: payment_method_configuration
oxxo	Model	Optional	Expand Update payment method configuration — response body — eps
p24	Model	Optional	Expand Update payment method configuration — response body — eps
parent	JSON	Optional
parent (anyOf 1)	string	Alternative	For child configs, the configuration's parent configuration. Maximum length: 5000
parent (anyOf 2)	null	Alternative
pay_by_bank	Model	Optional	Expand Update payment method configuration — response body — eps
payco	Model	Optional	Expand Update payment method configuration — response body — eps
paynow	Model	Optional	Expand Update payment method configuration — response body — eps
paypal	Model	Optional	Expand Update payment method configuration — response body — eps
paypay	Model	Optional	Expand Update payment method configuration — response body — eps
payto	Model	Optional	Expand Update payment method configuration — response body — eps
pix	Model	Optional	Expand Update payment method configuration — response body — eps
promptpay	Model	Optional	Expand Update payment method configuration — response body — eps
revolut_pay	Model	Optional	Expand Update payment method configuration — response body — eps
samsung_pay	Model	Optional	Expand Update payment method configuration — response body — eps
satispay	Model	Optional	Expand Update payment method configuration — response body — eps
scalapay	Model	Optional	Expand Update payment method configuration — response body — eps
sepa_debit	Model	Optional	Expand Update payment method configuration — response body — eps
sequra	Model	Optional	Expand Update payment method configuration — response body — eps
sofort	Model	Optional	Expand Update payment method configuration — response body — eps
sunbit	Model	Optional	Expand Update payment method configuration — response body — eps
swish	Model	Optional	Expand Update payment method configuration — response body — eps
twint	Model	Optional	Expand Update payment method configuration — response body — eps
upi	Model	Optional	Expand Update payment method configuration — response body — eps
us_bank_account	Model	Optional	Expand Update payment method configuration — response body — eps
wechat_pay	Model	Optional	Expand Update payment method configuration — response body — eps
zip	Model	Optional	Expand Update payment method configuration — response body — eps

Referenced models: Update payment method configuration — response body — eps

Update payment method configuration — response body — eps

Field	Type	Presence	Description and constraints
$	object	Root
available	boolean	Required within parent	Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
display_preference	Model	Required within parent	Expand Update payment method configuration — response body — eps display preference

Referenced models: Update payment method configuration — response body — eps display preference

Update payment method configuration — response body — eps display preference

Field	Type	Presence	Description and constraints
$	object	Root
overridable	JSON	Optional
overridable (anyOf 1)	boolean	Alternative	For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
overridable (anyOf 2)	null	Alternative
preference	string	Required within parent	The account's display preference. Known values: none, off, on
value	string	Required within parent	The effective display preference value. Known values: off, on