Core Resources
Payment Methods
Products
Product Catalog
Commerce
Agentic Commerce
Checkout
Payment Links
Billing
Capital
Connect
Reserves
Fraud
Issuing
Terminal
Treasury for Platforms
Payment Records
Account Evaluation
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Forwarding
Privacy
Webhooks

Payment Method Configurations v1

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:

Was this section helpful?YesNo
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 v1

Attributes

  • idstringretrievable with publishable key

    Unique identifier for the object.

  • objectstring, value is "payment_method_configuration"

    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

  • almanullable object

  • amazon_paynullable object

  • apple_paynullable object

  • au_becs_debitnullable object

  • bacs_debitnullable object

  • bancontactnullable object

  • billienullable object

  • bizumnullable object

  • bliknullable object

  • boletonullable object

  • cardnullable object

  • cartes_bancairesnullable object

  • cashappnullable object

  • cryptonullable object

  • customer_balancenullable object

  • epsnullable object

  • fpxnullable object

  • giropaynullable object

  • google_paynullable object

  • grabpaynullable object

  • idealnullable object

  • jcbnullable object

  • kakao_paynullable object

  • klarnanullable object

  • konbininullable object

  • kr_cardnullable object

  • linknullable object

  • livemodeboolean

  • mb_waynullable object

  • mobilepaynullable object

  • multibanconullable object

  • naver_paynullable object

  • nz_bank_accountnullable object

  • oxxonullable object

  • p24nullable object

  • pay_by_banknullable object

  • payconullable object

  • paynownullable object

  • paypalnullable object

  • paypaynullable object

  • paytonullable object

  • pixnullable object

  • promptpaynullable object

  • revolut_paynullable object

  • samsung_paynullable object

  • satispaynullable object

  • scalapaynullable object

  • sepa_debitnullable object

  • sequranullable objectPreview feature

  • sofortnullable object

  • sunbitnullable object

  • swishnullable object

  • twintnullable object

  • upinullable 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 v1

POST /v1/payment_method_configurations

Creates a payment method configuration

Parameters

  • namestringRequired unless parent is provided

    Configuration name.

    The maximum length is 100 characters.

  • parentstringRequired unless name is provided

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

    The maximum length is 100 characters.

More parameters

  • acss_debitobject

  • affirmobject

  • afterpay_clearpayobject

  • alipayobject

  • almaobject

  • amazon_payobject

  • apple_payobject

  • apple_pay_laterobject

  • au_becs_debitobject

  • bacs_debitobject

  • bancontactobject

  • billieobject

  • bizumobject

  • blikobject

  • boletoobject

  • cardobject

  • cartes_bancairesobject

  • cashappobject

  • cryptoobject

  • customer_balanceobject

  • epsobject

  • fpxobject

  • fr_meal_voucher_conecsobject

  • giropayobject

  • google_payobject

  • grabpayobject

  • idealobject

  • jcbobject

  • kakao_payobject

  • klarnaobject

  • konbiniobject

  • kr_cardobject

  • linkobject

  • mb_wayobject

  • mobilepayobject

  • multibancoobject

  • naver_payobject

  • nz_bank_accountobject

  • oxxoobject

  • p24object

  • pay_by_bankobject

  • paycoobject

  • paynowobject

  • paypalobject

  • paypayobject

  • paytoobject

  • pixobject

  • promptpayobject

  • revolut_payobject

  • samsung_payobject

  • satispayobject

  • scalapayobject

  • sepa_debitobject

  • sequraobjectPreview feature

  • sofortobject

  • sunbitobject

  • swishobject

  • twintobject

  • upiobject

  • us_bank_accountobject

  • wechat_payobject

  • zipobject

Returns

Returns the payment method configuration object

curl https://api.stripe.com/v1/payment_method_configurations \
  -u "sk_test_BQokikJOvBiI2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -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"
    }
  }
}