Payment Method Configurations

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:

Payment Method Configurations API
Multiple configurations on dynamic payment methods
Multiple configurations for your Connect accounts

Was this section helpful? Yes No

Create a payment method configuration

POST / v1 / payment_method_configurations

Update payment method configuration

POST / v1 / payment_method_configurations /:id

Retrieve payment method configuration

GET / v1 / payment_method_configurations /:id

List payment method configurations

GET / v1 / payment_method_configurations

The Payment Method Configuration object

Attributes

id string retrievable with publishable key Unique identifier for the object.
object string, value is "payment_method_configuration" String representing the object’s type. Objects of the same type share the same value.
active boolean Whether the configuration can be used for new payments.
application nullable string For child configs, the Connect application associated with the configuration.
is _ default boolean The default configuration is used whenever a payment method configuration is not specified.
name string The configuration’s name.
parent nullable string For child configs, the configuration’s parent configuration.

More attributes

acss _ debit nullable object
affirm nullable object
afterpay _ clearpay nullable object
alipay nullable object
alma nullable object
amazon _ pay nullable object
apple _ pay nullable object
au _ becs _ debit nullable object
bacs _ debit nullable object
bancontact nullable object
billie nullable object
bizum nullable object
blik nullable object
boleto nullable object
card nullable object
cartes _ bancaires nullable object
cashapp nullable object
crypto nullable object
customer _ balance nullable object
eps nullable object
fpx nullable object
giropay nullable object
google _ pay nullable object
grabpay nullable object
ideal nullable object
jcb nullable object
kakao _ pay nullable object
klarna nullable object
konbini nullable object
kr _ card nullable object
link nullable object
livemode boolean
mb _ way nullable object
mobilepay nullable object
multibanco nullable object
naver _ pay nullable object
nz _ bank _ account nullable object
oxxo nullable object
p24 nullable object
pay _ by _ bank nullable object
payco nullable object
paynow nullable object
paypal nullable object
paypay nullable object
payto nullable object
pix nullable object
promptpay nullable object
revolut _ pay nullable object
samsung _ pay nullable object
satispay nullable object
scalapay nullable object
sepa _ debit nullable object
sofort nullable object
sunbit nullable object
swish nullable object
twint nullable object
upi nullable object
us _ bank _ account nullable object
wechat _ pay nullable object
zip nullable object

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" } }}

Create a payment method configuration

POST / v1 / payment_method_configurations

Creates a payment method configuration

Parameters

name string Required unless parent is provided Configuration name. The maximum length is 100 characters.
parent string Required unless name is provided Configuration’s parent configuration. Specify to create a child configuration. The maximum length is 100 characters.

More parameters

acss _ debit object
affirm object
afterpay _ clearpay object
alipay object
alma object
amazon _ pay object
apple _ pay object
apple _ pay _ later object
au _ becs _ debit object
bacs _ debit object
bancontact object
billie object
bizum object
blik object
boleto object
card object
cartes _ bancaires object
cashapp object
crypto object
customer _ balance object
eps object
fpx object
fr _ meal _ voucher _ conecs object
giropay object
google _ pay object
grabpay object
ideal object
jcb object
kakao _ pay object
klarna object
konbini object
kr _ card object
link object
mb _ way object
mobilepay object
multibanco object
naver _ pay object
nz _ bank _ account object
oxxo object
p24 object
pay _ by _ bank object
payco object
paynow object
paypal object
paypay object
payto object
pix object
promptpay object
revolut _ pay object
samsung _ pay object
satispay object
scalapay object
sepa _ debit object
sofort object
sunbit object
swish object
twint object
upi object
us _ bank _ account object
wechat _ pay object
zip object

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" } }}