Integration for offline stores

Integration plan

  1. Ensure stable mobile internet connectivity is available on the premises of your offline store so customers can proceed to payment.

  2. Submit an application in your account and wait for the activation email for the test environment.

  3. On the store backend, set up the transfer of payment parameters via the /orders method call:

    Parameter examples
    Parameter Description
    availablePaymentMethods Payment methods available to the customer
    cart Cart properties, including the item codes and names
    managerId Specifies the merchant ID
    branchId Specifies the store ID

  4. Test the service in the test environment:

    1. In the top-right corner of the Settings page, enable the Test data option.
    2. Fill in the field Callback URL Test if you want Yandex Split to send notifications via the Merchant API.
    3. Set up message decoding.
    4. Run a test.

  5. After you receive a notification saying that the service has been activated, switch the environment from the test to the production:

    1. Go to Settings and hide the test settings by disabling the Test data option.
    2. Fill in the Callback URL field.
    3. Issue an API key.

  6. Don't forget about fiscalization. You can accept payments now.

Payment methods available for offline stores

Payment methods

Your store's customers can pay for their purchases with any bank card linked to their Yandex ID account.

Payment methods

Payments in offline stores where the Yandex Split has been activated can be made via a direct QR code.

A direct QR code is a payment method in which the user scans a dynamic QR code displayed on the merchant’s surfaces, such as monitors, managers' phone screens, receipts, price tags, and other media.

The purchase payment process includes several stages.

  1. Generating a direct QR code.

    1. The user selects items to buy.

    2. The merchant adds items to the cart in their POS system.

      When the customer is ready to pay, the seller selects the payment type and clicks the create order button.

    3. After the payment button is clicked on the partner side, the shopping cart is locked and an order is created, which is passed to Yandex Split through the store's backend by calling the /orders method. A response with a link to the Yandex Split payment form is returned for the customer to complete payment.

      Alert

      When calling the /orders method, pass the managerId and the branchId of the store where the payment takes place. The seller also sends the payment options available for the order.

    4. Using the received payment link, generate a QR code and display it on a medium available to the customer for scanning with a phone camera or in the Yandex Split app:

      • Screens and displays.
      • A receipt or QR code printout.

      You can use a third-party service to generate a QR code based on the payment link. For example, QR Code Generator.

  2. User payment.

    1. The user scans the QR code generated by the seller with their phone or in the Yandex Split app:

      • If the user has no Yandex Split app installed, the payment process is carried out in the user's browser after they follow the link or scan the QR code.
      • If the user has the Yandex Split app installed, after they follow the link or scan the QR code, the payment process is carried out in the app.

    2. The user is redirected to the Yandex Split payment form that shows the cart and payment amount.

    3. The user chooses how to pay (in parts using Split) and clicks the pay button.

      When paying in parts, the user selects the number of payments and makes the first payment using a bank card saved in Yandex.

  3. Completing the payment.

    1. Yandex Split completes the payment by debiting funds from the bank card the user selected.

    2. Yandex Split notifies the store's backend of the payment status by calling /webhook if the Callback URL has been set up.

      The store's backend can independently request the order status via the /orders/{order_id} request.

      Payment statuses

      • PENDING: Payment in progress, request the payment status later. This status is not sent in a notification.

        The merchant can roll back payments using the /orders/{orderId}/rollback method in one of the following cases:

        • The user chooses not to make a purchase.
        • There's a need to cancel the purchase.
        • The cash register software hangs.

      • FAILED: Payment failed. Terminal failure status.

      • CAPTURED: Payment completed, print out a receipt. Terminal success status.

    3. Print a receipt using your POS software. Purchase completed.

The next business day, the full amount of the purchase will be credited to the offline store's bank account.

Payment workflow

Making a refund

A refund can be made in two ways:

  • In the personal account, the Payments section.
  • By making API requests.
Previous
Payment refunds
Next
Testing