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:
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 and are not available in this API.
Related guides:
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 map - affirmnullable map
- afterpay_
clearpaynullable map - alipaynullable map
- almanullable map
- amazon_
paynullable map - apple_
paynullable map - au_
becs_ debitnullable map - bacs_
debitnullable map - bancontactnullable map
- billienullable map
- bliknullable map
- boletonullable map
- cardnullable map
- cartes_
bancairesnullable map - cashappnullable map
- customer_
balancenullable map - epsnullable map
- fpxnullable map
- giropaynullable map
- google_
paynullable map - grabpaynullable map
- idealnullable map
- jcbnullable map
- kakao_
paynullable map - klarnanullable map
- konbininullable map
- kr_
cardnullable map - linknullable map
- livemodeboolean
- mobilepaynullable map
- multibanconullable map
- naver_
paynullable map - nz_
bank_ accountnullable map - oxxonullable map
- p24nullable map
- pay_
by_ banknullable map - payconullable map
- paynownullable map
- paypalnullable map
- pixnullable map
- promptpaynullable map
- revolut_
paynullable map - samsung_
paynullable map - satispaynullable map
- sepa_
debitnullable map - sofortnullable map
- swishnullable map
- twintnullable map
- us_
bank_ accountnullable map - wechat_
paynullable map - zipnullable map
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" } }}Creates a payment method configuration
Parameters
- namestringRequired unless parent is provided
Configuration name.
- parentstringRequired unless name is provided
Configuration’s parent configuration. Specify to create a child configuration.
More parameters
- acss_
debitmap - affirmmap
- afterpay_
clearpaymap - alipaymap
- almamap
- amazon_
paymap - apple_
paymap - apple_
pay_ latermap - au_
becs_ debitmap - bacs_
debitmap - bancontactmap
- billiemap
- blikmap
- boletomap
- cardmap
- cartes_
bancairesmap - cashappmap
- customer_
balancemap - epsmap
- fpxmap
- giropaymap
- google_
paymap - grabpaymap
- idealmap
- jcbmap
- kakao_
paymap - klarnamap
- konbinimap
- kr_
cardmap - linkmap
- mobilepaymap
- multibancomap
- naver_
paymap - nz_
bank_ accountmap - oxxomap
- p24map
- pay_
by_ bankmap - paycomap
- paynowmap
- paypalmap
- pixmap
- promptpaymap
- revolut_
paymap - samsung_
paymap - satispaymap
- sepa_
debitmap - sofortmap
- swishmap
- twintmap
- us_
bank_ accountmap - wechat_
paymap - zipmap
Returns
Returns the payment method configuration object
Response
{ "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" } }}Update payment method configuration
Parameters
- activeboolean
Whether the configuration can be used for new payments.
- namestring
Configuration name.
More parameters
- acss_
debitmap - affirmmap
- afterpay_
clearpaymap - alipaymap
- almamap
- amazon_
paymap - apple_
paymap - apple_
pay_ latermap - au_
becs_ debitmap - bacs_
debitmap - bancontactmap
- billiemap
- blikmap
- boletomap
- cardmap
- cartes_
bancairesmap - cashappmap
- customer_
balancemap - epsmap
- fpxmap
- giropaymap
- google_
paymap - grabpaymap
- idealmap
- jcbmap
- kakao_
paymap - klarnamap
- konbinimap
- kr_
cardmap - linkmap
- mobilepaymap
- multibancomap
- naver_
paymap - nz_
bank_ accountmap - oxxomap
- p24map
- pay_
by_ bankmap - paycomap
- paynowmap
- paypalmap
- pixmap
- promptpaymap
- revolut_
paymap - samsung_
paymap - satispaymap
- sepa_
debitmap - sofortmap
- swishmap
- twintmap
- us_
bank_ accountmap - wechat_
paymap - zipmap
Returns
An object with the updated account payment method configuration
Response
{ "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" } }}Retrieve payment method configuration
Parameters
No parameters.
Returns
A payment method configuration object.
Response
{ "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" } }}- Need help? Contact Support.
- Join our early access program.
- Check out our changelog.
- Questions? Contact Sales.
- LLM? Read llms.txt.
- Powered by Markdoc