Skip to main content
Version: 2.0.0

Settings

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

Settings → Plugins → Home Credit (homecredit/settings).

The settings form is split into four tabs — General, Restrictions, Calculator, Credentials — plus an Enable / Sandbox Mode toggle pair in the details sidebar. An Test Token action button in the page header calls Home Credit's authentication endpoint and reports whether the configured credentials obtain a token successfully.

Enable / Sandbox Mode toggles (sidebar)​

  • Enable: master switch for the financing payment method at checkout. When off, Home Credit is not offered at checkout. When on, username, password, and calculatorButtonText all become required fields.
  • Sandbox Mode: when on, the financing API talks to Home Credit's Test environment using Home Credit's own published sandbox credentials (024243tech / 024243tech) — the configured Username/Password are ignored while this is on. Turn it off only once live credentials are entered and a sandbox checkout has completed successfully.

This sandbox toggle only affects the financing/checkout API. The Calculator tab has its own, independent Enable Sandbox Mode toggle — see below.

General tab​

  • Display Name: the label shown for this payment method at checkout (for example "Home Credit" or "Pay in installments"). Defaults to Home Credit.
  • Select button name: the text on the button/radio option the customer picks at checkout to choose this payment method. Defaults to Select.
  • Price: a fixed fee price charged for using this payment method, shown to the customer and passed through to the checkout total as price in the gateway's payment method descriptor. Defaults to 0.
  • Instructions: free-text instructions shown to the customer at checkout next to the payment method (for example, a note about eligibility or required documents). Optional.

Restrictions tab​

  • Visible From / Visible To: date/time window fields intended to limit when Home Credit is offered at checkout.
  • Available in countries: a multi-select of store countries, intended to limit Home Credit to orders shipping to one of the selected countries. By default it is available in all countries.

Verify these fields' effect against the current yStore checkout payment method registry in your installed yui/craft-plugin version before relying on them in production — the equivalent tab in some other YUI payment plugins is saved but not yet enforced at checkout.

Calculator tab​

Controls the optional installment calculator widget rendered by hc.renderCalculator() in site templates (see README → Installment calculator on site pages).

  • Enable Calculator: when off, hc.renderCalculator() always renders an empty fragment instead of the widget; the "plugin or calculator is not enabled" reason is only logged to the browser console via console.error(), not shown to the customer.
  • Enable Sandbox Mode (calculator): when on, the widget uses Home Credit's published sandbox calculator credentials and base URL for the selected Language (calculator_test_key / product set code COCHCONL) instead of the configured Calculator API Key / Product Set Code. Independent of the sidebar's financing-API Sandbox Mode toggle — you can sandbox one without the other.
  • The calculator trigger button text: the label on the button that opens the calculator. Required whenever Enable (sidebar) is on, regardless of whether the calculator itself is enabled. Defaults to Choose an installment method.
  • Calculator API Key: Home Credit's calculator API key for the selected Language's live environment. Ignored while the calculator's Enable Sandbox Mode is on.
  • Product Set Code: the Home Credit product set code that determines which installment plans the calculator offers. Ignored while the calculator's Enable Sandbox Mode is on.
  • Minimal Price: if set, prices below this value (in minor currency units, matching Home Credit's API) show a translated price-error message instead of the calculator. Leave empty to disable this check.
  • Down Payment: a fixed down-payment amount (minor units) passed to the calculator widget.
  • Fix Down payment: when on, the customer cannot change the down payment in the calculator; when off, the calculator lets the customer choose an optional down payment.
  • Open in modal window: when on, the calculator opens in a modal overlay; when off, it renders inline in the element identified by the wrapper variable passed to hc.renderCalculator().
  • Show calculator header: when on, the calculator's logo and close icon are shown in its header. The underlying setting is stored as hideHeader, but the plugin negates it before passing it to the widget, so the CP toggle behaves exactly as labeled — on shows the header, off hides it.

Credentials tab​

  • Username / Password: the Home Credit partner credentials for the live financing API. Required whenever Enable (sidebar) is on. Ignored while the sidebar's Sandbox Mode is on (sandbox uses Home Credit's own test credentials instead).
  • Language: the locale the financing API and calculator run in — Slovak (sk-SK) or Czech (cs-CZ). Selects both the financing API base URL (apisk-test.homecredit.sk/api.homecredit.sk for Slovak, apicz-test.homecredit.cz/api.homecredit.cz for Czech) and, when the calculator is in sandbox mode, its sandbox base URL and test key. Defaults to sk-SK; if not provided, Czech is used as documented in the field's instructions text.

Validation and save behavior​

  • Username, Password, and The calculator trigger button text are required only while Enable 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.
  • The Test Token action button on the settings page calls Home Credit's authentication endpoint with the currently configured (or sandbox) credentials and shows a success/error flash message — this confirms the Username/Password pair (or, in sandbox mode, Home Credit's own test credentials) authenticates before you take a real financing application.
  1. Install the plugin, then open Credentials and set Language to match your store's primary market. Leave Sandbox Mode (sidebar) on.
  2. Set General (display name, select button label, instructions) and, if you want the calculator, fill in Calculator (button text is required whenever the plugin is enabled).
  3. Click Test Token to confirm the sandbox financing API authenticates.
  4. Run a full test checkout with Home Credit selected as the payment method in sandbox mode, and confirm the resulting payment transaction shows a Home Credit application status panel.
  5. If you use the calculator widget, also test it with the calculator's own Enable Sandbox Mode on before enabling it against live calculator credentials.
  6. Only after both the checkout flow and the calculator (if used) behave as expected, enter the live Username/Password and Calculator API Key/Product Set Code, and switch both Sandbox Mode toggles off.

Troubleshooting​

"Test Token" reports an error​

The configured Username/Password don't match Home Credit's live financing API, or Sandbox Mode is off but the account isn't yet activated for production. Confirm the credentials with Home Credit, and check the yStore error log under homecredit:api-service:getToken:response (and homecredit:api-service:request for the underlying HTTP call) for the underlying response.

Home Credit doesn't appear at checkout even though it's enabled​

Confirm Enable is on and that the required fields (Username, Password, The calculator trigger button text) are saved without validation errors. Also check the Restrictions tab isn't unintentionally excluding the customer's country or the current date/time.

The calculator shows a "plugin or Calculator is not enabled" message​

Both Enable (sidebar) and Enable Calculator (Calculator tab) must be on for hc.renderCalculator() to render the widget instead of this error.

The calculator shows a price-error message instead of the widget​

The price passed to hc.renderCalculator() (converted to minor units) is below the configured Minimal Price. Either lower Minimal Price or don't call the calculator for items under that threshold.

A completed Home Credit application isn't reflected as paid in yStore​

postValidate() maps Home Credit's stateReason to a yStore payment status — see Developer → Application status mapping. Only a subset of statuses (READY_PAID, READY_DELIVERED, READY_SHIPPED, READY_TO_SHIP) mark the order's paid amount; earlier processing statuses (PROCESSING_*) are valid Home Credit states but don't yet count as paid. Check the payment transaction's Home Credit panel for the application's actual current status.