Параметры подключения

Attention. Это старая версия API. Переходите на API Яндекс.Кассы.
Для работы с протоколом необходимо указать основные настройки в личном кабинете Яндекс.Кассы (доступ к нему обычно появляется сразу после подачи заявки на подключение). Если нет доступа в личный кабинет — напишите менеджеру Кассы на merchants@yamoney.ru.

Набор параметров зависит от способа подключения.

Общие параметры

Параметр

Ограничение

Комментарий

Название магазина

От 3 до 128 символов

Название магазина, которое увидит пользователь в процессе платежа.

Адрес сайта

До 50 символов

Адрес сайта магазина, заполняется в заявке на подключение.

URL в формате http://site.com/

shopSuccessUrl

До 250 символов

URL страницы, на которую пользователь может перейти после платежа по ссылке Вернуться в магазин.

Если эти URL не будут меняться, их можно указать в личном кабинете в разделе Настройки в полях shopSuccessUrl и shopFailUrl.

Чтобы изменять эти URL динамически (для каждого платежа), необходимо:

  1. Добавить в платежную форму параметры:
    • shopSuccessUrl — для страницы успешного платежа;
    • shopFailUrl — для страницы ошибки при платеже.
  2. В личном кабинете Яндекс.Кассы поставть галочку Использовать страницы успеха и ошибки с динамическими адресами (раздел Настройки, блок Параметры для платежей).

Необходимо передавать оба адреса.

Note.
  • При переходе Яндекс.Касса добавляет к URL магазина параметр action со значением PaymentSuccess или PaymentFail (в зависимости от результата платежа), а также все параметры платежной формы. Переход происходит методом GET (исключение — неуспех оплаты из кошелька в Яндекс.Деньгах, в этом случае переход происходит методом POST).

  • При неопределенном статусе платежа ссылка ведет на адрес сайта магазина (URL берется из настроек, параметр Адрес сайта). В этом случае дополнительные параметры к ссылке не добавляются.
  • Если вы собираетесь отображать персональную информацию для конкретного пользователя, необходимо авторизовать такого пользователя собственными средствами. Это может быть стандартная авторизация на сайте магазина (через cookies и т. п.) или через сессионные ключи магазина, которые можно добавить в платежную форму.
  • При оплате наличными через терминал и при платеже со счета мобильного телефона ссылка ведет на главную страницу сайта магазина, дополнительные параметры в URL не передаются.
  • При оплате из кошелька в системе WebMoney пользователь переходит на сайт магазина прямо из системы WebMoney. При этом WebMoney могут добавлять в URL для перехода собственные дополнительные параметры.
  • При оплате через Сбербанк: оплата по смс или Сбербанк Онлайн, Альфа-Клик, интернет-банк Промсвязьбанка, КупиВкредит (Тинькофф Банк) пользователь не видит ссылку на сайт магазина.
shopFailUrl

До 250 символов

Email для реестров

По формату

Адрес для получения реестров принятых переводов.

Параметр

Ограничение

Комментарий

Название магазина

От 3 до 128 символов

Название магазина, которое увидит пользователь в процессе платежа.

Адрес сайта

До 50 символов

Адрес сайта магазина, заполняется в заявке на подключение.

URL в формате http://site.com/

shopSuccessUrl

До 250 символов

URL страницы, на которую пользователь может перейти после платежа по ссылке Вернуться в магазин.

Если эти URL не будут меняться, их можно указать в личном кабинете в разделе Настройки в полях shopSuccessUrl и shopFailUrl.

Чтобы изменять эти URL динамически (для каждого платежа), необходимо:

  1. Добавить в платежную форму параметры:
    • shopSuccessUrl — для страницы успешного платежа;
    • shopFailUrl — для страницы ошибки при платеже.
  2. В личном кабинете Яндекс.Кассы поставть галочку Использовать страницы успеха и ошибки с динамическими адресами (раздел Настройки, блок Параметры для платежей).

Необходимо передавать оба адреса.

Note.
  • При переходе Яндекс.Касса добавляет к URL магазина параметр action со значением PaymentSuccess или PaymentFail (в зависимости от результата платежа), а также все параметры платежной формы. Переход происходит методом GET (исключение — неуспех оплаты из кошелька в Яндекс.Деньгах, в этом случае переход происходит методом POST).

  • При неопределенном статусе платежа ссылка ведет на адрес сайта магазина (URL берется из настроек, параметр Адрес сайта). В этом случае дополнительные параметры к ссылке не добавляются.
  • Если вы собираетесь отображать персональную информацию для конкретного пользователя, необходимо авторизовать такого пользователя собственными средствами. Это может быть стандартная авторизация на сайте магазина (через cookies и т. п.) или через сессионные ключи магазина, которые можно добавить в платежную форму.
  • При оплате наличными через терминал и при платеже со счета мобильного телефона ссылка ведет на главную страницу сайта магазина, дополнительные параметры в URL не передаются.
  • При оплате из кошелька в системе WebMoney пользователь переходит на сайт магазина прямо из системы WebMoney. При этом WebMoney могут добавлять в URL для перехода собственные дополнительные параметры.
  • При оплате через Сбербанк: оплата по смс или Сбербанк Онлайн, Альфа-Клик, интернет-банк Промсвязьбанка, КупиВкредит (Тинькофф Банк) пользователь не видит ссылку на сайт магазина.
shopFailUrl

До 250 символов

Email для реестров

По формату

Адрес для получения реестров принятых переводов.

Дополнительные параметры при выборе способов подключения HTTP-протокол или Платежный модуль

Параметр

Ограничение

Комментарий

checkUrl

До 200 символов

URL, по которому Яндекс.Касса будет отправлять магазину запрос Проверка заказа (checkOrder) и Уведомление об отмене заказа (сancelOrder).

Restriction. Для взаимодействия необходимо использовать протокол HTTPS.
Нужно два разных URL:
  • для тестирования;
  • для реальных платежей.
Note.

Если платежный модуль в вашей системе не поддерживает работу в тестовом режиме, эти адреса могут быть одинаковыми.

avisoUrl

До 200 символов

URL, по которому Яндекс.Касса будет отправлять магазину запрос Уведомление о переводе (paymentAviso).

Restriction. Для взаимодействия необходимо использовать протокол HTTPS.
Нужно два разных URL:
  • для тестирования;
  • для реальных платежей.

shopPassword

До 20 символов

Секретное слово. Необходимо для формирования md5-хэша, который передается в запросах Проверка заказа, Уведомление о переводе и Уведомление об отмене заказа (сancelOrder).

Рекомендуется использовать случайно сгенерированный набор символов.

Параметр

Ограничение

Комментарий

checkUrl

До 200 символов

URL, по которому Яндекс.Касса будет отправлять магазину запрос Проверка заказа (checkOrder) и Уведомление об отмене заказа (сancelOrder).

Restriction. Для взаимодействия необходимо использовать протокол HTTPS.
Нужно два разных URL:
  • для тестирования;
  • для реальных платежей.
Note.

Если платежный модуль в вашей системе не поддерживает работу в тестовом режиме, эти адреса могут быть одинаковыми.

avisoUrl

До 200 символов

URL, по которому Яндекс.Касса будет отправлять магазину запрос Уведомление о переводе (paymentAviso).

Restriction. Для взаимодействия необходимо использовать протокол HTTPS.
Нужно два разных URL:
  • для тестирования;
  • для реальных платежей.

shopPassword

До 20 символов

Секретное слово. Необходимо для формирования md5-хэша, который передается в запросах Проверка заказа, Уведомление о переводе и Уведомление об отмене заказа (сancelOrder).

Рекомендуется использовать случайно сгенерированный набор символов.

Дополнительные параметры при выборе способа подключения Email-протокол

Параметр

Комментарий

Email для уведомлений о платежах

Адрес для получения уведомлений.

Параметр

Комментарий

Email для уведомлений о платежах

Адрес для получения уведомлений.

Смотрите также

Подключение магазина

Платежная форма