Skip to main content
Version: 2.0.0

Settings

This page explains every SimplePay setting and where to find it. Open settings in Craft CP:

Settings → Plugins → SimplePay (yui-simplepay/settings).

As of v1.3.0, settings are split into five separate CP pages/tabs — General, Credentials, Pricing, Restrictions, Test cards — matching the sectioned settings template shared with the 24pay and Barion plugins. yui-simplepay/settings itself redirects to General. An Enable SimplePay / Enable SandboxMode toggle pair sits in the details sidebar on every tab.

Enable / Sandbox toggles (sidebar)

  • Enable SimplePay: master switch. When off, SimplePay is not shown at checkout and no settings are required. When on, name, buttonName, defaultCurrency, merchantId, and secretKey all become required fields.
  • Enable SandboxMode: when on, the plugin builds transactions against SimplePay's sandbox environment and payments are never realized. Turning this on also reveals the SimplePay Test Cards reference table further up the page. Turn it off only once live credentials are entered and a sandbox test payment has succeeded.

General section

  • Display Name: the label shown for this payment method at checkout (for example "SimplePay" or "Card payment via SimplePay"). Required when the plugin is enabled.
  • Select button name: the text on the button/radio option the customer picks at checkout to choose this payment method. Defaults to Select. Required when the plugin is enabled.
  • Instructions: free-text instructions shown to the customer at checkout next to the payment method. Optional.

Restrictions section

  • Visible From / Visible To: optional date/time window. Outside this window, SimplePay is hidden from checkout even if enabled — useful for a planned SimplePay maintenance window or a temporary rollout freeze. Leave both blank to make SimplePay always visible.
  • Available in countries: a multi-select of store countries. Leave empty to make SimplePay available in all store countries. In this plugin version the underlying default option list only ships Hungary, so add any other store country you sell into before relying on this restriction.

Credentials section

  • Merchant ID (MID): the unique Merchant ID issued by SimplePay for your store. Required when the plugin is enabled.
  • API Secret Key: the secret key generated from the SimplePay merchant dashboard for the same MID. Required when the plugin is enabled. The plugin uses this single key/MID pair to build per-currency credentials at request time (see Developer → Currency configuration) — if SimplePay issued you separate keys per currency, confirm with SimplePay which one to use here, since this plugin version has only one field for each.

Pricing section

As of v1.3.0, currency and language live on their own tab, separate from Credentials:

  • Default currency: the three-letter ISO 4217 currency code used as a fallback when an order has no currency of its own. Offered options are CZK, EUR, HUF, USD. Required when the plugin is enabled.
  • Default language: the locale SimplePay's hosted payment page opens in. In this plugin version the option list only ships - (browser default) and Magyar (hu-HU) out of the box; the plugin's own fallback if nothing is selected is Slovak (sk-SK).

Test cards

Also its own tab as of v1.3.0 (previously part of Credentials). Shown only while Enable SandboxMode is on, this reference table lists a generic Visa test card so you can exercise the sandbox checkout flow without a real card:

Card TypeCard NumberExpiry DateCVCResult
Visa4908 3660 9990 042510/21579Successful payment

The listed expiry date is illustrative, not necessarily current — always verify current SimplePay sandbox test card numbers and expected results in SimplePay's own developer documentation or with SimplePay support before relying on this table for a specific test scenario.

Validation and save behavior

  • Display Name, Select button name, Default currency, Merchant ID, and API Secret Key are required only while Enable SimplePay is on — an unsaved/incomplete configuration can be left disabled without validation errors.
  • Saving redirects back to the settings page and shows a Craft success/error notice as usual.
  • A Test Credentials action button on the settings page checks that both Merchant ID and API Secret Key are filled in — it confirms the fields are present, not that SimplePay itself accepts them. A success or error flash message is shown after the check.
  • sandboxMode, secretKey, merchantId, selectedLanguage, and defaultCurrency are site-overridable: a multi-site install can set different values per site (via the site selector on the settings page), while other fields stay shared across all sites.
  1. Install the plugin, then open Credentials and enter the SimplePay Merchant ID and API Secret Key for SimplePay's sandbox environment, with Enable SandboxMode on.
  2. Set General (display name, select button label, instructions) and Default currency/Default language to match your store.
  3. Click Test Credentials to confirm both fields are filled in.
  4. Run a full test payment using a current SimplePay sandbox test card (see Test cards) and confirm the order is marked paid after returning from checkout.
  5. Only after the sandbox test payment behaves as expected, replace the Merchant ID and API Secret Key with the live SimplePay credentials and switch Enable SandboxMode off.
  6. Optionally configure Restrictions (countries, visibility window) to match when/where SimplePay should be offered.

Troubleshooting

"Test Credentials" reports the login information is incorrect

Merchant ID or API Secret Key is empty. This check only verifies both fields are filled in — it does not call SimplePay, so filling in any non-empty values makes it pass. A payment can still fail at SimplePay's side with invalid credentials; confirm the Merchant ID and Secret Key against the SimplePay merchant dashboard.

SimplePay doesn't appear at checkout even though it's enabled

Check the Restrictions tab: the order's country may be outside Available in countries, or the current time may be outside Visible From/Visible To. Both restrictions hide the payment method silently without an error.

A completed SimplePay payment isn't marked as paid in yStore

postValidate() only marks the order paid when SimplePay's returned notification status is exactly SUCCESS — statuses like FAIL, CANCEL, or TIMEOUT are valid SimplePay outcomes but are treated as a failed payment, not a paid order (see Developer → Return statuses). Check the payment's actual status in the SimplePay merchant admin.

API/signature errors aren't shown in detail to the customer

By design — signature validation failures and SimplePay error responses are written to the shared yStore error log under yui-simplepay-plugin:postValidate rather than surfaced verbatim at checkout. Check the yStore error log for the underlying error when a payment attempt fails unexpectedly.