Форма для HTTP-уведомлений

Attention. Это старая версия API. Переходите на API Яндекс.Кассы.

Адрес для отправки формы

https://money.yandex.ru/eshop.xml

Параметры формы

ПараметрТипОграничениеОписание
Обязательные параметры

shopId

long

Идентификатор магазина, выдается при подключении к Яндекс.Кассе.

scid

long

Идентификатор витрины магазина, выдается при подключении к Яндекс.Кассе.

sum

CurrencyAmount

Сумма заказа.

Note.

Сумма заказа может не передаваться только в одном случае: при оплате наличными через терминалы, по коду платежа (paymentType=GP). Тогда код платежа становится многоразовым. При каждом платеже по этому коду магазину перечисляется сумма, внесенная пользователем в терминал.

customerNumber

normalizedString

128 символов

Идентификатор плательщика в системе магазина. В качестве идентификатора может использоваться номер договора плательщика, логин плательщика и т. п.

Допустимы повторные оплаты по одному и тому же идентификатору плательщика.

Допустимые символы:

  • цифры от 0 до 9,
  • латинские буквы,
  • буквы русского алфавита,
  • символы ~!@#$%^&*()_+{}|:"<>?-=[]\;./!"№;%:?*()_+/
  • пробелы (пробелы в начале и в конце недопустимы).
Необязательные параметры

orderNumber

normalizedString

64 символа

Уникальный номер заказа в системе магазина. Уникальность контролируется Яндекс.Кассой в сочетании с параметром shopId.

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

shopArticleId

long

Идентификатор товара, выдается при подключении к Яндекс.Кассе. Применяется, если магазин использует несколько платежных форм для разных товаров.

shopSuccessURL

string, URL path

250 символов

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

  • задается в личном кабинете (в разделе Настройки в поле successURL),
  • передается динамически.

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

shopFailURL

string, URL path

250 символов

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

В зависимости от настроек магазина:

  • задается в личном кабинете (в разделе Настройки в поле fail URL),
  • передается динамически.

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

shopDefaultUrlstring, URL path250 символов

URL, на который будет вести ссылка Вернуться в магазин, когда процесс платежа на стороне Яндекс.Кассы завершен, но для завершения оплаты необходимы дополнительные действия пользователя.

Страницы, на которых отображается эта ссылка:

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

Если shopDefaultUrl не задан, эта ссылка ведет на Адрес сайта из настроек.

cps_email

string

100 символов

Адрес электронной почты плательщика. Если он передан, то соответствующее поле на странице подтверждения платежа будет предзаполнено (шаг 3 на схеме платежа).

Допустимо передавать только адрес электронной почты (проверяется соответствие).

Restriction.

Этот параметр не передается в запросах checkOrder и paymentAviso.

cps_phone

string

15 символов, только цифры

Номер мобильного телефона плательщика. Если он передан, то соответствующее поле на странице подтверждения платежа будет предзаполнено (шаг 3 на схеме платежа).

Restriction.

Этот параметр не передается в запросах checkOrder и paymentAviso.

paymentType

normalizedString5 символов

Способ оплаты. Рекомендуем передавать в этом поле пустое значение, в этом случае выбор способа оплаты будет происходить на стороне Яндекс.Кассы.

Примеры:

  • PC - оплата из кошелька в Яндекс.Деньгах;
  • AC - оплата с произвольной банковской карты.

Полный список значений

Restriction.

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

ym_merchant_receiptstring

Данные для формирования чека в формате JSON.

Параметр передается и является обязательным, если вы настроили взаимодействие со своей онлайн-кассой через Яндекс.Кассу и передаете в платежной форме данные для формирования чека.

См. Параметры для формирования чека
Note. Для B2B- платежей (paymentType=2S) данные для чека передавать не нужно.
Дополнительные параметры для B2B-платежей (paymentType=2S)
payment_purposestring210 символовНазначение платежа.
vatTypestringТип НДС. Возможные значения:
  • calculated — облагается налогом;
  • untaxed — не облагается.
vatRatestring

Ставка НДС. Обязательно, если vatType=calculated.

Возможные значения:

  • 0 — ставка НДС 0%;
  • 7 — ставка 7%;
  • 10 — ставка 10%;
  • 18 — ставка 18%.
vatSumCurrencyAmountСумма НДС. Обязательно, если vatType=calculated. Вам необходимо самостоятельно подсчитывать точную сумму НДС и передавать в запросе на оплату. А также в поле sum передавать полную сумму, которую заплатит покупатель, вместе с НДС.
Параметры, которые может добавить магазин (необязательно)
custom_fieldstring

Используется для передачи дополнительных параметров. Например, при оплате по QR-коду передается значение qrpayment.

Любые названия, отличные от перечисленных вышеstring

4096 символов (суммарная длина всех параметров)

Параметры, добавленные магазином в платежную форму, будут сохранены и переданы магазину в запросах checkOrder и paymentAviso.

Restriction.

В названиях добавленных параметров можно использовать буквы латинского алфавита в любом регистре, цифры, символ подчеркивания и дефис. Нельзя использовать пробел, точку и квадратные скобки [ ].

Название должно начинаться с буквы, но нельзя использовать в начале сочетание xml.

ПараметрТипОграничениеОписание
Обязательные параметры

shopId

long

Идентификатор магазина, выдается при подключении к Яндекс.Кассе.

scid

long

Идентификатор витрины магазина, выдается при подключении к Яндекс.Кассе.

sum

CurrencyAmount

Сумма заказа.

Note.

Сумма заказа может не передаваться только в одном случае: при оплате наличными через терминалы, по коду платежа (paymentType=GP). Тогда код платежа становится многоразовым. При каждом платеже по этому коду магазину перечисляется сумма, внесенная пользователем в терминал.

customerNumber

normalizedString

128 символов

Идентификатор плательщика в системе магазина. В качестве идентификатора может использоваться номер договора плательщика, логин плательщика и т. п.

Допустимы повторные оплаты по одному и тому же идентификатору плательщика.

Допустимые символы:

  • цифры от 0 до 9,
  • латинские буквы,
  • буквы русского алфавита,
  • символы ~!@#$%^&*()_+{}|:"<>?-=[]\;./!"№;%:?*()_+/
  • пробелы (пробелы в начале и в конце недопустимы).
Необязательные параметры

orderNumber

normalizedString

64 символа

Уникальный номер заказа в системе магазина. Уникальность контролируется Яндекс.Кассой в сочетании с параметром shopId.

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

shopArticleId

long

Идентификатор товара, выдается при подключении к Яндекс.Кассе. Применяется, если магазин использует несколько платежных форм для разных товаров.

shopSuccessURL

string, URL path

250 символов

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

  • задается в личном кабинете (в разделе Настройки в поле successURL),
  • передается динамически.

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

shopFailURL

string, URL path

250 символов

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

В зависимости от настроек магазина:

  • задается в личном кабинете (в разделе Настройки в поле fail URL),
  • передается динамически.

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

shopDefaultUrlstring, URL path250 символов

URL, на который будет вести ссылка Вернуться в магазин, когда процесс платежа на стороне Яндекс.Кассы завершен, но для завершения оплаты необходимы дополнительные действия пользователя.

Страницы, на которых отображается эта ссылка:

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

Если shopDefaultUrl не задан, эта ссылка ведет на Адрес сайта из настроек.

cps_email

string

100 символов

Адрес электронной почты плательщика. Если он передан, то соответствующее поле на странице подтверждения платежа будет предзаполнено (шаг 3 на схеме платежа).

Допустимо передавать только адрес электронной почты (проверяется соответствие).

Restriction.

Этот параметр не передается в запросах checkOrder и paymentAviso.

cps_phone

string

15 символов, только цифры

Номер мобильного телефона плательщика. Если он передан, то соответствующее поле на странице подтверждения платежа будет предзаполнено (шаг 3 на схеме платежа).

Restriction.

Этот параметр не передается в запросах checkOrder и paymentAviso.

paymentType

normalizedString5 символов

Способ оплаты. Рекомендуем передавать в этом поле пустое значение, в этом случае выбор способа оплаты будет происходить на стороне Яндекс.Кассы.

Примеры:

  • PC - оплата из кошелька в Яндекс.Деньгах;
  • AC - оплата с произвольной банковской карты.

Полный список значений

Restriction.

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

ym_merchant_receiptstring

Данные для формирования чека в формате JSON.

Параметр передается и является обязательным, если вы настроили взаимодействие со своей онлайн-кассой через Яндекс.Кассу и передаете в платежной форме данные для формирования чека.

См. Параметры для формирования чека
Note. Для B2B- платежей (paymentType=2S) данные для чека передавать не нужно.
Дополнительные параметры для B2B-платежей (paymentType=2S)
payment_purposestring210 символовНазначение платежа.
vatTypestringТип НДС. Возможные значения:
  • calculated — облагается налогом;
  • untaxed — не облагается.
vatRatestring

Ставка НДС. Обязательно, если vatType=calculated.

Возможные значения:

  • 0 — ставка НДС 0%;
  • 7 — ставка 7%;
  • 10 — ставка 10%;
  • 18 — ставка 18%.
vatSumCurrencyAmountСумма НДС. Обязательно, если vatType=calculated. Вам необходимо самостоятельно подсчитывать точную сумму НДС и передавать в запросе на оплату. А также в поле sum передавать полную сумму, которую заплатит покупатель, вместе с НДС.
Параметры, которые может добавить магазин (необязательно)
custom_fieldstring

Используется для передачи дополнительных параметров. Например, при оплате по QR-коду передается значение qrpayment.

Любые названия, отличные от перечисленных вышеstring

4096 символов (суммарная длина всех параметров)

Параметры, добавленные магазином в платежную форму, будут сохранены и переданы магазину в запросах checkOrder и paymentAviso.

Restriction.

В названиях добавленных параметров можно использовать буквы латинского алфавита в любом регистре, цифры, символ подчеркивания и дефис. Нельзя использовать пробел, точку и квадратные скобки [ ].

Название должно начинаться с буквы, но нельзя использовать в начале сочетание xml.

Пример платежной формы

<form action="https://money.yandex.ru/eshop.xml" method="post">
    <input name="shopId" value="1234" type="hidden"/>
    <input name="scid" value="4321" type="hidden"/>
    <input name="sum" value="100.50" type="hidden">
    <input name="customerNumber" value="abc000" type="hidden"/>
    <input name="paymentType" value="AC" type="hidden"/>
    <input name="orderNumber" value="abc1111111" type="hidden"/>
    <input name="cps_phone" value="79110000000" type="hidden"/>
    <input name="cps_email" value="user@domain.com" type="hidden"/>
  <input type="submit" value="Заплатить"/>
</form>

Пример платежной формы с параметрами для B2B-платежей

<form action="https://money.yandex.ru/eshop.xml" method="post">
        <input name="shopId" value="1234" type="hidden"/>
        <input name="scid" value="4321" type="hidden"/>
        <input name="sum" value="50.00" type="hidden">
        <input name="customerNumber" value="abc000" type="hidden"/>
        <input name="paymentType" value="2S" type="hidden"/>
        <input name="orderNumber" value="abc1111111" type="hidden"/>
        <input name="cps_phone" value="79110000000" type="hidden"/>
        <input name="cps_email" value="user@domain.com" type="hidden"/>
        <input name="payment_purpose" value="Оплата заказа №2134О" type="hidden"/>
        <input name="vatType" value="calculated" type="hidden"/>
        <input name="vatRate" value="18" type="hidden"/>
        <input name="vatSum" value="9.00" type="hidden"/>
        <input type="submit" value="Заплатить"/>
        </form>

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

Тестирование оплаты