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:

The Payment Method Configuration object

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

  • affirmnullable object

  • afterpay_clearpaynullable object

  • alipaynullable object

  • amazon_paynullable object

  • apple_paynullable object

  • au_becs_debitnullable object

  • bacs_debitnullable object

  • bancontactnullable object

  • bliknullable object

  • boletonullable object

  • cardnullable object

  • cartes_bancairesnullable object

  • cashappnullable object

  • customer_balancenullable object

  • epsnullable object

  • fpxnullable object

  • giropaynullable object

  • google_paynullable object

  • grabpaynullable object

  • idealnullable object

  • jcbnullable object

  • klarnanullable object

  • konbininullable object

  • linknullable object

  • livemodeboolean

  • oxxonullable object

  • p24nullable object

  • paynownullable object

  • paypalnullable object

  • promptpaynullable object

  • revolut_paynullable object

  • sepa_debitnullable object

  • sofortnullable object

  • us_bank_accountnullable object

  • wechat_paynullable object

  • zipnullable 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

Creates a payment method configuration

Parameters

  • namestring

    Configuration name.

  • parentstring

    Configuration’s parent configuration. Specify to create a child configuration.

More parameters

  • acss_debitobject

  • affirmobject

  • afterpay_clearpayobject

  • alipayobject

  • amazon_payobject

  • apple_payobject

  • apple_pay_laterobject

  • au_becs_debitobject

  • bacs_debitobject

  • bancontactobject

  • blikobject

  • boletoobject

  • cardobject

  • cartes_bancairesobject

  • cashappobject

  • customer_balanceobject

  • epsobject

  • fpxobject

  • giropayobject

  • google_payobject

  • grabpayobject

  • idealobject

  • jcbobject

  • klarnaobject

  • konbiniobject

  • linkobject

  • oxxoobject

  • p24object

  • paynowobject

  • paypalobject

  • promptpayobject

  • revolut_payobject

  • sepa_debitobject

  • sofortobject

  • us_bank_accountobject

  • wechat_payobject

  • zipobject

Returns

Returns the payment method configuration object

POST /v1/payment_method_configurations
curl https://api.stripe.com/v1/payment_method_configurations \
-u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:" \
-d name="Buy Now Pay Laters"
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

Update payment method configuration

Parameters

  • activeboolean

    Whether the configuration can be used for new payments.

  • namestring

    Configuration name.

More parameters

  • acss_debitobject

  • affirmobject

  • afterpay_clearpayobject

  • alipayobject

  • amazon_payobject

  • apple_payobject

  • apple_pay_laterobject

  • au_becs_debitobject

  • bacs_debitobject

  • bancontactobject

  • blikobject

  • boletoobject

  • cardobject

  • cartes_bancairesobject

  • cashappobject

  • customer_balanceobject

  • epsobject

  • fpxobject

  • giropayobject

  • google_payobject

  • grabpayobject

  • idealobject

  • jcbobject

  • klarnaobject

  • konbiniobject

  • linkobject

  • oxxoobject

  • p24object

  • paynowobject

  • paypalobject

  • promptpayobject

  • revolut_payobject

  • sepa_debitobject

  • sofortobject

  • us_bank_accountobject

  • wechat_payobject

  • zipobject

Returns

An object with the updated account payment method configuration

POST /v1/payment_method_configurations/:id
curl https://api.stripe.com/v1/payment_method_configurations/pmc_abcdef \
-u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:" \
-d "acss_debit[display_preference][preference]"=on
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

Retrieve payment method configuration

Parameters

No parameters.

Returns

A payment method configuration object.

GET /v1/payment_method_configurations/:id
curl https://api.stripe.com/v1/payment_method_configurations/pmc_abcdef \
-u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:"
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"
}
}
}
Stripe Shell
Test mode
Welcome to the Stripe Shell! Stripe Shell is a browser-based shell with the Stripe CLI pre-installed. Log in to your Stripe account and press Control + Backtick (`) on your keyboard to start managing your Stripe resources in test mode. - View supported Stripe commands: - Find webhook events: - Listen for webhook events: - Call Stripe APIs: stripe [api resource] [operation] (e.g., )
The Stripe Shell is best experienced on desktop.
$