Instructions for setting up the Y.CMS module for OpenCart 2/3

Y.CMS is the module for integrating your online store with Yandex's business services.

Yandex.Checkout: accept payments to settlement account and conduct refunds (by contract, for legal entities and private entrepreneurs).

Yandex.Money: accept payments to Yandex.Money wallet (without a contract, for everyone).

Yandex.Billing: accept payments to company's account (without a contract, for legal entities and private entrepreneurs).

Yandex.Metrica: collect user clicks and user behavior data.

Yandex.Market: post products at Yandex.Market and join the "Order at Yandex.Market" program.

Technical support and updates are provided by Yandex.Money.

Installing the module

Yandex.Checkout

Yandex.Money

Yandex.Billing

Yandex.Metrica

Yandex.Market

Installing the module

1. Download the archive containing the module.

For OpenCart 2.0.x — 2.1.x (.ZIP, 127 KB)

For OpenCart 2.2.x (.ZIP, 127 KB)

For OpenCart 2.3.x (.ZIP, 127 KB)

For OpenCart 3.x (.ZIP, 373 KB)

2. Select Modules — Installing extensions in the dashboard menu.

3. Click Upload and select the archive you downloaded. Once the uploading is finished, click Continue.

4. Select Modules in the dashboard, then Modifiers. Click Update (the blue square in the upper right corner) and wait for the "Update successful!" message.

5. Select Modules — Modules/Extensions in the left-side menu, then select Payment in Extension type. You will see a list of payment extensions: find Y.CMS 2.0 and click Activate (the green square on the right).

6. When the "Settings updated successfully" message appears, you can proceed with setting up the module.

Yandex.Checkout

How to set up payment acceptance

To set up payment acceptance using this manual, you need to sign up for Yandex.Checkout and get the shopId and Secret key parameters.

  • shopId will appear in your Merchant Profile by itself when you sign up for the service,
  • Secret key is issued independently and requires activation in Merchant Profile. More in Yandex.Checkout's help guide

Once you get both parameters, you can proceed with the configuration.

1. Click Modules — Modules/Extensions in the website's dashboard, |||UNTRANSLATED_CONTENT_START|||В списке Выберите тип расширения поставьте «Оплата».|||UNTRANSLATED_CONTENT_END|||

2. You will see a list of payment extensions: find Y.CMS 2.0 and click "Edit" (blue square with a pencil icon on the right side).

2. View the Yandex.Checkout tab and check the Enable payment acceptance via Yandex.Checkout box.

4. Fill out the shopId and Secret key fields: you can get both parameters in your Yandex.Checkout Merchant Profile.

5. Indicate the preferable scenario of selecting a payment method:

  • On Yandex.Checkout's side (you can view an example in Demo Store),
  • On the store's side.
The option of selecting the payment method on the store's side looks like this

6. If you selected the payment scenario to be played out on Yandex.Checkout's side, you can name the pay button "Pay via Yandex.Checkout" by checking the corresponding box.

If you selected the payment scenario to be played out on the store's side, check the boxes corresponding to payment methods indicated in your contract with Yandex.Money.

7. Indicate "Yandex.Checkout (bank cards, e-money, etc.)" in the Payment service name field.

8. If you configured the transmission of receipts to the Tax service via Yandex.Checkout partner services (in accordance with Federal Law No. 54-FZ), enable the transmission of receipt data, then indicate the VAT rate to be specified in the receipt.

  • The default rate will be indicated in the receipt for the products that you didn't previously indicate the VAT rate for,
  • The rates in your store have to be compared against the Yandex.Checkout rates.

Yandex.Checkout's guide for transmission of receipts in accordance with Federal Law No. 54-FZ

9. In the "Order status after the payment" field, select the status to be assigned to an order after it's been paid via Yandex.Checkout.

10. If required, enable "Invoicing via email" and create a template for the email. After that, you will be able to send invoices for orders made on your website in one click.

How to set up invoicing

Using the Yandex.Checkout module, you can send invoices for orders made on your website automatically. Customers will receive emails containing the total order amount, the "Pay" button, as well as all the payment methods you have enabled.

1. Create a template for the email:

Subject

By default, the subject is "Payment for order %order_id%", where the order's number (the %order_id% value) is added automatically. This text can be changed: if you want to add the store name, change the value to %shop_name% (as in the screenshot below), and the name will be added automatically.

Additional text

This text will be displayed for the customers under the amount and the "Pay" button. You can specify some important information there, for example, the support service's phone number. If you leave the field empty, the email will only contain the invoice.

2. Check the "Add the store's logo to email" box, so it will be easier for the customer to recognize you as the sender. Save the settings.

How to issue invoices

1. In the left-side menu of the dashboard, select the "Sales" section, then "Orders".

2. Find the required order (you can use the filter in the upper side) and click the green button near the order's number. Click "OK" in the confirmation window.

3. That's it! The invoice was sent to the email address indicated by the customer during checkout.

Example of an invoice:

4. After the customer pays on this invoice, the order status in the list will change.

11. When you're finished, scroll to the top of the page and click Save (the blue square with the floppy disc icon). That's it: you can test payment acceptance.

How to make refunds

1. In the left-side menu, select "Sales", then "Orders", then find the required order in the list (if the list is too long, use the filter at the top).

2. In the "Action" field click on the green "Order management" icon in the line containing the order.

3. Indicate the amount of the refund. Specify the reason behind the refund: this message will be displayed to the customer.

4. Click "Refund". If everything is done correctly, you will see the "Payment successfully refunded" message. If the refund was not successful, you will see an error notification.

How to use deferred payments (preauthorization)

If you have enabled deferred payments, bank card payments will be made in two steps:

  1. When the customer places an order on the website, the bank blocks the required amount on their card.
  2. The store captures the payment or returns the money to the customer.

In this case, if the order is canceled or the product is out of stock, the store can easily refund the money. No commission is charged for this refund.

How to enable holding

1. Navigate to Modules / Extensions section.

2. Select the "Payment" extension type in the drop-down list.

3. Find the Yandex.Money module in the list of extensions and click "Edit".

4. Check the box next to "Enable deferred payments" box in the module settings to enable the feature.

After that, orders will have new statuses: "Awaiting capture" and "Cancelled". You will need to configure the statuses in a form that appears after you enable deferred payments.

Don't forget to save the settings afterwards.

How to capture or cancel a payment

1. Navigate to Orders section.

2. Find an order waiting for capture in the list of orders: there is a "Capture payment" button next to it. Click it to proceed to the payment capture or cancellation form.

3. This form displays basic information about the payment. There are two buttons, "Capture payment" and "Cancel payment".

Click "Capture payment" to capture the payment.

Click "Cancel payment" to cancel the payment.

You will see the results immediately after clicking the button.

Yandex.Money

How to set up payment acceptance to a Yandex.Money wallet

Using this module, you can accept payments to your Yandex.Money wallet without a contract.

1. Click Modules — Modules/Extensions in the website's dashboard, |||UNTRANSLATED_CONTENT_START|||В списке Выберите тип расширения поставьте «Оплата».|||UNTRANSLATED_CONTENT_END|||

2. You will see a list of payment extensions: find Y.CMS 2.0 and click "Edit" (blue square with a pencil icon on the right side).

3. Open the "Yandex.Money" tab and check the "Enable payment acceptance to the Yandex.Money wallet" box.

4. Enter the number of the wallet for accepting the money in the "Wallet number" field.

5. You can get the "App ID" and "Code word" values on the Yandex.Money website

by following this link and filling out the fields:

  • "Name" is the name of your store, it will be shown to the user.
  • "URL" is the website where you will accept payments.
  • "Email address for contact" is your email address.
  • "Redirect URL" is RedirectURL in the module's settings (simply copy this link).
  • "Logo" is not required but it helps users to recognize your service.
  • Be sure to check the "Use app authentication" box.

When you fill out all the fields on the registration page, click "Confirm". The website will generate ID and the "Code word": copy and paste them into the module's settings.

6. Indicate "Yandex.Checkout (bank cards, e-money, etc.)" in the Payment service name field.

7. In the Order status after the payment field, select the status to be assigned to an order after it's been paid via Yandex.Checkout.

8. The rest of the settings are optional. When you're finished, scroll to the top of the page and click Save (the blue square with the floppy disc icon). That's it, now you can test payment acceptance.

Yandex.Billing

The configuration of payment acceptance via Yandex.Billing consists of three steps:

  1. Get the payment form settings at the Yandex.Billing website.
  2. Indicate these settings in the website's dashboard.
  3. Pay the fee for using the form.

How to get the payment form settings

1. Fill out the form template at the Yandex.Billing website: indicate "Payment for order" in the Name of product or service field. You don't need to fill out the Amount field, add other products, or additional fields, as this information is already included in your CMS.

What the form template looks like

2. Click Next and fill out the company questionnaire on the next page. You will need to indicate:

  • your company's legal name and INN (TIN),
  • account's banking details,
  • ​email address where you'd like to receive payment notifications,
  • URL of the website where you're going to accept payments via Yandex.Billing.​
What the company questionnaire looks like

3. Click Create form. Banking details, URL, and other provided information will be sent for verification. It will take a couple of minutes.

​4. If everything's in order, you will receive an email containing the form's parameters and banking details for paying the fee.​

Body of the email

How to configure settings in the dashboard

1. Click Modules — Modules/Extensions in the website's dashboard, |||UNTRANSLATED_CONTENT_START|||В списке Выберите тип расширения поставьте «Оплата».|||UNTRANSLATED_CONTENT_END|||

2. You will see a list of payment extensions: find Y.CMS 2.0 and click "Edit" (blue square with a pencil icon on the right side).

3. View the Yandex.Billing tab and check theEnable payment acceptance box.

4. Copy the Form ID parameter from the email you received from Yandex.Billing after setting up the form.

5. In the Payment purpose field, indicate everything that will help distinguish the payment made via Yandex.Billing. This parameter will be included in the payment order.

6. Indicate "Yandex.Billing (bank cards, Yandex.Money wallets)" in the Payment service name field.

7. In the Order status after the payment field, select the status that will be assigned to the order that was paid via Yandex.Billing. The status should indicate that the payment result is unknown: you can only find out whether the customer paid or not from the email notification.

8. The rest of the settings are optional. When you're finished, scroll to the top of the page and click Save (the blue square with the floppy disc icon). That's it, now you can test payment acceptance.

How to pay for the form

  1. Open the email containing the form's code and the banking details for paying a fee.
  2. Pay 3,000 rubles using the banking details from the settlement account that you will use for accepting payments (otherwise the fee will not be considered as paid).
  3. As soon as we receive the funds, we will activate the form and send you an email. The duration depends on your bank, but it shouldn't take more than 3 days.
  4. Make a test payment for a small amount: check that the form works properly, and the money can reach your account.

That's it, you can accept payments now.

Attention. One paid fee covers all the forms that you select for your company (we check by INN (TIN) indicated during the creation of the form). Limitations on quantity and amount of payments also apply to all forms at the same time.

Yandex.Metrica

How to get the parameters for setting up Yandex.Metrica

To set up the module to collect stats, you need to create an app to access Yandex.Metrica and get its ID and password. The new app is needed even if you've already created one for interacting with any other Yandex service.

1. Open the app creation page.

2. Fill out the form:

Name — the name that will be shown to the user.

Description — the text that will be shown in the list of apps allowed by the user to have access to their account.

Link to logo — the link to your website's logo. Optional.

Link to website — the link to your website.

Rights — select "Yandex.Metrica" and check these boxes:

  • "Receiving stats, reading parameters from your own and trusted counters",
  • "Creating counters, changing parameters of your own and trusted counters".

Callback URL — copy the URL from the Link for app field in the Yandex.Metrica tab (Y.CMS settings).

Attention. Don't click "Set the development URL", as the module will not work with it.

3. Click Save. Yandex will issue ID and password for the app: use them to set up the module for interacting with Yandex.Metrica.

How to set up the module to interact with Yandex.Metrica

1. Click Modules — Modules/Extensions in the website's dashboard, |||UNTRANSLATED_CONTENT_START|||В списке Выберите тип расширения поставьте «Оплата».|||UNTRANSLATED_CONTENT_END|||

2. You will see a list of payment extensions: find Y.CMS 2.0 and click "Edit" (blue square with a pencil icon on the right side).

3. View the Yandex.Metrica tab. Set Activity to "Enabled".

4. Specify the store's details:

  • Counter number that you received during creation of the counter at the Yandex.Metrica website.
  • App ID and App password are issued on the app creation page. instructions.
  • QAuth Token wil be filled automatically after you click the "Get the token to access Yandex.Metrica" link.

5. In "Settings", check the boxes with the Yandex.Metrica parameters that you need and the purposes for which you're going to collect the stats ("Collect stats for the following purposes").

6. Click Save. That's it: the module will collect the stats for your website.

Yandex.Market

How to upload products to Yandex.Market

Attention. before setting up the module, you need to register your store at Yandex.Market.

After you've registered the store, configure the product uploading process using to this manual.

1. Click Modules — Modules/Extensions in the website's dashboard, then select the "Payment" extension type in the drop-down list.

2. You will see a list of payment extensions: find Y.CMS 2.0 and click "Edit" (blue square with a pencil icon on the right side).

3. View the Yandex.Market tab to open the module settings.

4. Indicate your store's name in the top field and the full name of the company below it.

5. Select the main and additional currencies for your price list in the "Currency" section.

Yandex.Market accepts information about the prices in rubles (RUR, RUB), hrivnas (UAH), Belarusian rubles (BYN), tenge (KZT), dollars (USD), and euros (EUR) If any of the currencies are not available, it means they are not included in your CMS.

You can only use the rubles (RUR, RUB), Belarusian rubles (BYN), hryvnias (UAH), and Kazakhstani tenge (KZT) as the main currency.

Learn more about currencies.

You can also configure the Rates and Surcharge for additional currencies by hovering over the currency name and clicking the pencil icon.

Rates

Determine the exchange rates in relation to the rate of the main currency taken as a unit.

  • By the Opencart rate, which is the internal rate that you use.
  • By the rate of the Central Bank of Russia.
  • By the rate of the National Bank of Ukraine.
  • By the rate of the National Bank of Kazakhstan.
  • By the rate of the bank of the country where the store belongs by region (set in your Merchant Profile).
Surcharge The percentage you want to add to the value you set for the rate.

6. Select the categories of products to be uploaded to the price list.

Set All if you want to upload all categories.

If you want to upload only few of the categories, set Selected to open an additional field with a list of categories. Check the boxes next to the ones you want to upload.

7. If you offer courier delivery within your home region, add the delivery conditions in the this section.

You can configure several conditions for different cases by hovering over the condition and clicking the pencil icon.

More about delivery conditions.

Price Indicate the price of delivery within the home region. Main currency that you selected in section 5 will be added automatically.
Delivery time Indicate the period required for courier delivery within your home region.
For orders before... If the delivery time depends on when the order was placed, specify it here. For example, "12:00" if the specified delivery time is relevant for orders placed before noon. By default, Yandex.Market is set to "before 13: 00"

8. Select the offer format in the next section, Arbitrary or Simplified with offer name template.

Learn more about offer formats.

9. You can display different delivery methods for products with different Yandex.Market statuses in the "Product status and delivery methods" section.

Hover over the required status and click the pencil icon to open the settings.

  • Specify the status you want to be displayed for this product in Yandex.Market: In Stock or On Demand. Select Don't Upload if you don't want to upload a product with this status to Yandex.Market.
  • Select the delivery methods that are available in your store for a product with this status.

10. The VAT rate may differ for individual products in the general taxation system. You can set non-standard taxation rates for certain products in the "Tax rates" section.

It displays the rates provided in your CMS. Set the desired VAT rates and specify the corresponding rates in the product description.

Check the Add tax rates to offers box to upload these tax rates to Yandex.Market.

More about tax rates.

11. Identical products with varying options (i.e. different colors and sizes) can be uploaded to Yandex.Market as separate offers. If you have such products, indicate the available options and select the defining attributes.

12. Check the boxes if you want to upload all the product attributes and dimensions in a package to Yandex.Market.

13. In this block, you can apply additional conditions to product categories.

Condition name Indicate the name of this condition.
Tag The YML element to set the condition for.
Permanent value or Value from product description The value to be set for this element. You can select an existing one from the product description or use a new one.
Identical tags in offers How the identical tags will be displayed in a Yandex.Market offer.
For categories Select which categories to apply this condition to.

14. Click "Save". After the "Settings saved" message appears at the top, scroll down and copy the link from the "Link for uploading products to Yandex.Market" field.

15. View settings of your store at partner.market.yandex.ru, click "Assortment", then "Price list" and "Enter a link". Paste the copied link to the field and click "Import".

If Y.CMS settings are filled correctly, the price list will be sent to the Yandex.Market specialists for verification. If there are any errors, the Yandex.Market team will help you fix them.