Skip to content
msp3YooKassa
YooKassa payments for MiniShop3 — one- and two-stage payments, webhooks, 54-FZ receipts
  1. Extras
  2. msp3YooKassa
  3. System settings

msp3YooKassa system settings

Install order: Quick start.

All settings use the msp3yookassa namespace. In modSystemSetting and in getOption(), the key is underscore-separated: msp3yookassa_shop_id, msp3yookassa_secret_key, etc. Older dotted names (msp3yookassa.shop_id) are migrated on package upgrade. Below are the current keys.

Required

KeyTypeDescription
msp3yookassa_shop_idtextShop ID from the merchant profile. For a test shop, use the test shop ID from the dashboard.
msp3yookassa_secret_keypasswordSecret key (older merchant-API material may use “shop password” wording). YooKassa’s API uses Shop ID + Secret key. For testing, use a test_ key.

Without both values, payment creation fails with “Payment is not configured”. How keys are sent to the API: interaction format.

Buyer return URLs

KeyTypeDescription
msp3yookassa_success_urlURLAfter successful payment. Empty — MiniShop3 thanks page (ms3_order_redirect_thanks_id) with msorder=<uuid>.
msp3yookassa_fail_urlURLAfter failed payment. Empty — thanks page with payment_fail=1.

Fiscalization (54-FZ)

KeyTypeDescription
msp3yookassa_payment_receiptyes/noSend a receipt object in createPayment.
msp3yookassa_vat_codelistVAT code for receipt lines per YooKassa (codes 1–10, see receipt basics).

VAT codes (vat_code):

CodeMeaning
1No VAT
2VAT 0%
3VAT 10%
4VAT 20%
5Calculated VAT 10/110
6Calculated VAT 20/120
7VAT 5%
8VAT 7%
9Calculated VAT 5/105
10Calculated VAT 7/107

The customer must have an email in the order (properties.email or the user profile). With no address, the receipt block is not sent.

Service

KeyTypeDescription
msp3yookassa_debugyes/noWrite debug messages to the MODX log (LOG_LEVEL_DEBUG).
  • ms3_status_paid — “paid” status (webhook on succeeded, Capture processor after capture).
  • ms3_status_canceled — cancelled status (webhook on canceled).
  • ms3_order_redirect_thanks_id — thanks page resource when custom success/fail URLs are empty.

Check these under System Settings → minishop3 (or the MiniShop3 settings UI).