Skip to main content
Version: 2.0.0

Settings

Open Stripe → Settings. As of 1.4.0 the settings page is split into five sections (previously a single page), sharing the same tabbed layout and action buttons (Save, Save & Continue Editing, Test Credentials) used by other yStore payment gateways.

General

FieldDescription
Display NameThe payment method name shown to the customer at checkout. Default: Stripe.
Select button nameThe label of the button used to select this payment method. Default: Select.
InstructionsOptional text shown alongside the payment method at checkout.
Default currencyThe currency used for Checkout Session line items (ISO 4217 alphabetic code). Default: EUR.
Default languageThe Stripe Checkout locale. If not set, the customer's browser preference is used.

Credentials

FieldDescription
Merchant number (mid)Optional merchant identification number.
Publishable keyThe Stripe publishable key. Required when the plugin is enabled.
Secret keyThe Stripe secret key, used server-side for every Stripe API call. Required when the plugin is enabled.
E-shop IDOptional store identification number.
KeyOptional gateway key field.
Webhook signing secretThe signing secret (whsec_...) from the Stripe Dashboard's Webhooks → your endpoint page. Required for the webhook endpoint to accept events.

Use Test Credentials (action button) to verify the Secret key is valid -- it calls ApiService::testCredentials(), which lists payment methods on the Stripe account.

The Credentials page displays the exact endpoint URL to configure in the Stripe Dashboard: {siteUrl}stripe/webhook. Enable at least checkout.session.completed, payment_intent.succeeded, payment_intent.payment_failed, charge.refunded, and charge.dispute.created -- see Developer API for the full list of events the plugin understands.

Pricing

Fields shared with other yStore payment gateways via BasePaymentSettingsModel:

FieldDescription
PriceFee charged for using this payment method. 0 makes it free.
Free Payment ThresholdOrder subtotal from which the fee is waived. Empty or 0 always charges it.
Tax RateThe tax rate applied to the payment fee.
Cash roundingRounds this method's totals to Cash rounding step instead of inheriting the store setting.
Cash rounding stepRounding step applied when Cash rounding is on (e.g. 0.05).

Invoice Options

FieldDescription
Shipping Method as itemAdds the order's shipping method as its own Checkout Session line item. Default: on.
Payment Method as itemAdds the order's payment method as its own Checkout Session line item. Default: on.

Buy Now Pay Later (BNPL)

FieldDescription
Enable BNPLWhen on, offers BNPL methods alongside card payments at Checkout. Requires the selected methods to also be activated in the Stripe Dashboard. Default: off.
BNPL MethodsShown only when BNPL is enabled. Multi-select: Klarna (SK/EU) or Afterpay / Clearpay (limited EU). Affirm is US/CA/UK-only and not offered here.

Enabling BNPL switches the Checkout Session from Stripe's automatic_payment_methods to an explicit payment_method_types list (card plus the selected BNPL methods), since the two are mutually exclusive on the Stripe API.

Restrictions

Also shared via BasePaymentSettingsModel:

FieldDescription
Visible From / Visible ToOptional date range during which the payment method is offered.
Minimum order total / Maximum order totalHide this method outside the order total range. Empty means no limit.
Minimum weight (kg) / Maximum weight (kg)Hide this method outside the cart weight range. Empty means no limit.
Available in storesMulti-select of stores (site + currency) where Stripe is offered. Default: all stores.
Available in countriesMulti-select of countries where Stripe is offered. Default: all countries.

Test cards

Its own section as of 1.4.0 (previously part of the single settings page). Shown at all times, but only useful while Sandbox Mode is on -- an inline notice reminds you when it's off. Lists Stripe's test card numbers (e.g. 4242 4242 4242 4242 for a successful Visa payment) to rehearse checkout without a live Stripe account.

Details sidebar

Shown on every section:

FieldDescription
Enable StripeShows the payment method at checkout when on.
Sandbox ModeWhen on, no real transactions are processed; use with the Stripe Dashboard's test API keys. Default: on.

Not exposed in the CP

The following Settings model fields have code-level defaults but no form control on any section; set them through a custom migration, console script, or by saving the plugin settings programmatically -- see Developer API:

  • Customer Portal feature flags (portalInvoiceHistory, portalPaymentMethodUpdate, portalSubscriptionCancel, portalSubscriptionUpdate) -- control which sections of the Stripe Customer Portal are available. Invoice history and payment method update default to on; subscription cancel and update default to off.
  • portalConfigurationId -- cached automatically the first time a Customer Portal session is created from non-default feature flags; clear it to force the plugin to rebuild the Stripe Billing Portal configuration.

Where this is used

  • Secret key is used for every Stripe API call: Checkout Session creation, refunds, subscription operations, dispute evidence, the Customer Portal, and the dashboard's live balance -- see the Developer API.
  • Default currency, Shipping/Payment Method as item, and Enable BNPL/BNPL Methods affect how the Checkout Session line items are built, both for the storefront flow and the order-edit Pay by link button.
  • Webhook signing secret gates the public stripe/webhook endpoint -- without it, incoming events are rejected with a 400 response instead of being processed.
  • Price, Free Payment Threshold, Tax Rate, Cash rounding, and the Restrictions fields behave the same as on any other yStore payment gateway that uses BasePaymentSettingsModel.
  • See the Stripe overview for how these settings fit into the checkout flow, dashboard, and Customer Portal.