Activation parameters

To work with the protocol, you must specify the main parameters in your Yandex.Checkout personal dashboard (which you should be able to access immediately after submitting your activation request.) If you can't access your personal dashboard, send an email to the Yandex.Checkout manager at merchants@yamoney.ru.

The set of parameters depends on the activation method.

General parameters

Parameter

Restrictions

Comments

Store name

From 3 to 128 characters

The store name that the user will see during the payment process.

URL

Maximum of 50 characters

The address of the store's website. Entered in the activation request form.

URL in http://site.com/ format

shopSuccessURL

Maximum of 200 characters

URL of the page the user returns to after payment by clicking the Back to store link.

If these URLs won't change, you can specify them in the Settings section of your personal dashboard (in the successURL and failURL fields).

If you want these URLs to change dynamically (for every payment), you must add the following parameters to the payment form:

  • shopSuccessUrl — For the successful payment page.

  • shopFailUrl — For the payment error page.

You must pass both addresses.

Note. 
  • When a user clicks the link, Yandex.Checkout adds the action parameter with the value PaymentSuccess or PaymentFail to the store's URL (depending on the payment result), along with all payment form parameters. The click-through uses the GET method (the exception is for an unsuccessful payment from a Yandex.Money Wallet, which uses a POST request).

  • When the payment status is unknown, the link goes to the store's website address (the URL is taken from the Site address parameter in settings). In this case, the additional parameters are not appended to the link.
  • If you intend to display personal information for a specific user, you must authenticate this user using your own methods. This could be standard authentication on the store's website (using cookies and so on), or using the store's session keys, which can be added to the payment form.
  • For cash payments via a payment kiosk or payments from a mobile phone balance, the link goes to the store's home page, and the additional parameters are not passed to the URL.
  • For payments from a WebMoney purse, the user goes to the store's website directly from the WebMoney system. In addition, WebMoney can append its own custom parameters to the URL.
  • When a user pays through Sberbank: payment via SMS or Sberbank online, Alfa-Click, Promsvyazbank online banking, QIWI Wallet, or KupiVkredit (Tinkoff Bank), they don't see a link to the store's site.
shopFailURL

Maximum of 200 characters

Email for sending reports

According to the format

Address for getting reports on accepted payments.

Additional parameters that apply to the HTTP Protocol or Payment Module activation methods

Parameter

Restrictions

Comments

checkUrl

Maximum of 200 characters

The URL that Yandex.Checkout will use to send the Order verification request (checkOrder) and Payment cancellation notification (cancelOrder).

Restriction. Interaction must occur over HTTPS.
You need two different URLs:
  • For testing.
  • For actual payments.
Note. 

If the payment module in your system does not support testing mode, these addresses may be the same.

avisoUrl

Maximum of 200 characters

The URL that Yandex.Checkout will use to send the store the Notification of transfer request (paymentAviso).

Restriction. Interaction must occur over HTTPS.
You need two different URLs:
  • For testing.
  • For actual payments.

shopPassword

Maximum of 20 characters

Secret word. Required for forming the MD5 hash that is passed in the Order verification, Payment notification, and Payment cancellation notification (cancelOrder) requests.

We recommend using a randomly generated set of characters.

Additional parameters when selecting the email protocol activation method

Parameter

Comments

Email for payment notifications

The address for receiving notifications.

See also

Activating a store

Payment form