Quick start

What you need to go live (or to test) with YooKassa and MiniShop3.

Requirements

Requirement	Version
MODX Revolution	3.0+
PHP	8.2+
MiniShop3	installed
pdoTools	3.x
YooKassa account	Store in the merchant profile. To test without real money use a test shop and a test_ key. Pay with test card numbers.

Step 1: Install the package

1. Ensure MiniShop3 is installed.
2. Open Package Management (Extras → Installer).
3. Install msp3YooKassa (from ModStore).
4. Manage → Clear cache.

After install you should see plugin msp3yookassa_bootstrap (event OnMODXInit) — it loads autoloading for payment classes. Confirm the plugin is enabled.

Step 2: Store credentials in MODX

1. System Settings, filter namespace msp3yookassa.
2. Set:
   • msp3yookassa_shop_id — shop ID from the YooKassa dashboard.
   • msp3yookassa_secret_key — secret key (for testing use a test_ key).

Details: System settings.

Step 3: HTTP notifications in YooKassa

If this is empty or wrong, the order in MODX may stay “unpaid” even when YooKassa shows a successful charge.

1. Open the YooKassa merchant profile.
2. Configure HTTP notifications (see webhooks).
3. Set the URL to your domain with HTTPS (use only the msp3YooKassa path below):

https://your-domain.com/assets/components/msp3yookassa/webhook.php

Step 4: Payment method in MiniShop3

The package resolver creates two methods (if missing):

Method	When to use
YooKassa payment	normal sale — immediate capture
YooKassa payment (two-stage)	hold → confirm via Capture processor

1. In the MiniShop3 manager open Settings → Payments (or your MS3 equivalent).
2. Activate the method you need, or deactivate the other if you only want one.
3. Ensure checkout exposes that method to customers (delivery / template rules as in your shop).

Step 5: Test a payment

1. Place a test order for at least 0.01 RUB.
2. Choose YooKassa — you should redirect to YooKassa’s payment page.
3. Pay with a test card when test keys are in MODX. In a test shop, do not use a real bank card.
4. After success, the order in MODX should get ms3_status_paid (often ID 3 — verify in MiniShop3 settings).

If status does not update, check webhook URL, HTTPS, firewall, and keys.

Step 6: 54-FZ receipts (optional)

To send receipt data in the create-payment request:

1. Set msp3yookassa_payment_receipt to Yes.
2. Set msp3yookassa_vat_code (codes 1–10 — see the table in system settings).
3. Ensure the order has a customer email (order properties.email or user profile email).

In a test shop you can turn on YooKassa’s receipt check mode (kassa is simulated, no real OFD slip) — fine for integration checks. Use real kassa settings in your live shop before go-live.

Otherwise no receipt block is sent. See System settings and Integration.

Next steps

• System settings — msp3yookassa_success_url, msp3yookassa_fail_url, msp3yookassa_debug, VAT
• Integration — webhooks, two-stage flow, Capture processor, receipt line hook
• MiniShop3 — checkout — order snippet and on-site flow