YooKassa (New protocol)

To add YooKassa, you need to configure the settings on the payment gateway side and add the module in BILLmanager.

This module uses the new protocol, and we recommend that all new users configure it to accept payments from customers. 

Payment methods support
Bank cards	Cash	E-wallets	Mobile payments	Online banking
Visa, Mastercard, Maestro, Mir, JCB.	Terminals, ATMs, bank cash desks.	YooMoney.	Beeline, Megafon, MTS, Tele2.	Alpha-Click, Sberbank Online, Fast money transfer system.
Supported features
Payments return		Recurring payments		Subscriptions*

* — to enable your clients to create subscriptions, when configuring integration with this payment method, choose Bank Card and/or YooMoney as the payment method. Subscriptions will not work for other payment methods.

Configuring the payment method

To configure YooKassa:

1. Enter the client area or register at YooKassa website. Read more about how to register in YooKassa documentation.

2. In the client area, enter the section Integration → Ready-made solutions.
   
   

   Note:

   To be able to select integration with BILLmanager in this section, specify the address of BILLmanager in the section Contract → Payments acceptance.

3. Select BILLmanager from "Your system" list and press Save.
   
   

The parameters required for integration with BILLmanager will appear in your client area:

• in the section Settings → Store — shopId;
• in the section Integration → API keys — secret key.

ShopId — the unique store ID in YooKassa system used to configure integration on BILLmanager side.

Secret key — the secret key of the store used to configure integration on BILLmanager side.

Configuring recurring payments on the Yookassa side

To set up recurring payments in Yookassa, you need to:

1. Write a message to the Yookassa manager from your Client area. To do this, click on the operator icon in the upper right corner.
2. In the Problem solving section, write a message. For example: "I want to connect recurring payments. How do I do it?"
3. The answer from the Yookassa manager with instructions for further action will be sent to your email.

Configuring BILLmanager

To create a payment module, enter Provider → Payment methods → click Add. The payment module adding wizard consists of the following steps:

1. Select a payment methods: "YooKassa".
2. Integration settings. Specify the data for integration:
   Activate the Add New Client option to display a link to register with the handler's system.
   Complete the form using the details of an existing client in the handler's system:
   
   1. Shop id — enter your ShopId.
   2. Secret key — enter your Secret Key.
   3. Payment method — select one or more payment methods available for this payment module;
   4. Recurring payments — select the check box to enable recurring payments. Recurring payments are used in BILLmanager for  Account automatic replenishment or to create Subscriptions, auto-renewal. If the flag is active, specify the following:
      • Return page for a successful auto payment — a link to return from your YooKassa client area after a successful configuration of auto payment. Use the BILLmanager page https://domain.com/billmgr?func=payment.recurring.success or an arbitrary page;
      • Return page for an unsuccessful auto payment — a link to return from your YooKassa client area after an unsuccessful configuration of auto payment. Use the BILLmanager page https://domain.com/billmgr?func=payment.recurring.fail or a discretionary page;

      • Return page for an auto payment configuration in progress — a link to return from your YooKassa client area the configuration of the auto payment is in progress. Use the BILLmanager page https://domain.com/billmgr?func=payment.pending or a discretionary page.

        Comments

        domain.com — domain name or public IP address of the server with BILLmanager.
      • On the edit form of the newly created payment gateway you can check the Allow refund box to enable refunds.  
3. Payment method settings. Configure internal (within BILLmanager) parameters of the service payment module. For more details, see How to add a payment gateway module.

Redirecting after payment

This payment method supports the function for redirecting the customer after payment to a discretionary page. Use different pages depending on the success of the payment. For example, BILLmanager pages:

• for a successful payment: https://domain.com/billmgr?func=payment.success;
• for an unsuccessful payment: https://domain.com/billmgr?func=payment.fail;

• for payments in progress: https://domain.com/billmgr?func=payment.pending.  

  Comments

  domain.com — domain name or public IP address of the server with BILLmanager.

To specify return pages when creating a payment method, go to step three and fill in the fields Successful payment return page ,  Failed payment return page and Pending payment return page . You can also specify them after creating the payment method in Provider → Payment methods → Edit → Settings block.

Payments refunds

To permit refund of payments:

1. Complete the creation of the payment method.
2. Enter Provider → Payment methods → Edit → Refunds block.
3. Enable the Allow payment refunds option and press Ok to save your settings.

Logging

YooKassa has the following log files:

• /usr/local/mgr5/var/pmyandexcheckout.log — configuration details of the payment method;
• /usr/local/mgr5/var/ycpayment.log — payment log;
• /usr/local/mgr5/var/ycrecurring.log — recurring payments;
• /usr/local/mgr5/var/ycresult.log — responses from the payment gateway.