Форма для HTTP-уведомлений — [Архив] Протокол приема платежей через ЮKassa

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

Это старая версия API. Переходите на API ЮKassa.

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

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

https://yoomoney.ru/eshop.xml

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

Параметр	Тип	Описание
Обязательные параметры
shopId	long	Идентификатор магазина, выдается при подключении к ЮKassa.
scid	long	Идентификатор витрины магазина, выдается при подключении к ЮKassa.
sum	CurrencyAmount	Сумма заказа.
customerNumber	normalizedString, 128 символов	Идентификатор плательщика в системе магазина. В качестве идентификатора может использоваться номер договора плательщика, логин плательщика и т. п. Допустимы повторные оплаты по одному и тому же идентификатору плательщика. Допустимые символы: цифры от 0 до 9, латинские буквы, буквы русского алфавита, символы `~!@#$%^&()_+{}\|:"<>?-=[]\;./!"№;%:?()_+/` пробелы (пробелы в начале и в конце недопустимы).
Необязательные параметры
orderNumber	normalizedString, 64 символа	Уникальный номер заказа в системе магазина. Уникальность контролируется ЮKassa в сочетании с параметром `shopId`. Если платеж с таким номер заказа уже был успешно проведен или в процессе платежа возникла ошибка, то повторные попытки оплаты будут отвергнуты ЮKassa.
shopArticleId	long	Идентификатор товара, выдается при подключении к ЮKassa. Применяется, если магазин использует несколько платежных форм для разных товаров.
shopSuccessURL	string, URL path, 250 символов	URL, на который будет вести ссылка Вернуться в магазин со страницы успешного платежа. В зависимости от настроек магазина: задается в личном кабинете (в разделе Настройки в поле `successURL`), передается динамически. См. Параметры подключения
shopFailURL	string, URL path, 250 символов	URL, на который будет вести ссылка Вернуться в магазин со страницы ошибки платежа. В зависимости от настроек магазина: задается в личном кабинете (в разделе Настройки в поле `successURL`), передается динамически. См. Параметры подключения
shopDefaultUrl	string, URL path, 250 символов	URL, на который будет вести ссылка Вернуться в магазин, когда процесс платежа на стороне ЮKassa завершен, но для завершения оплаты необходимы дополнительные действия пользователя. Страницы, на которых отображается эта ссылка: страница с кодом платежа при оплате наличными; страница с инструкцией подтверждения платежа при оплате по смс. Если этот параметр задан, то на этот же URL будет вести ссылка Вернуться в магазин со страницы подтверждения оплаты. Если `shopDefaultUrl` не задан, эта ссылка ведет на Адрес сайта из настроек.
cps_email	string, 100 символов	Адрес электронной почты плательщика. Если он передан, то соответствующее поле на странице подтверждения платежа будет предзаполнено (шаг 3 на схеме платежа). Допустимо передавать только адрес электронной почты (проверяется соответствие). Этот параметр не передается в запросах checkOrder и paymentAviso.
cps_phone	string, 15 символов, только цифры	Номер мобильного телефона плательщика. Если он передан, то соответствующее поле на странице подтверждения платежа будет предзаполнено (шаг 3 на схеме платежа). Этот параметр не передается в запросах checkOrder и paymentAviso.
paymentType	normalizedString, 5 символов	Способ оплаты. Рекомендуем передавать в этом поле пустое значение, в этом случае выбор способа оплаты будет происходить на стороне ЮKassa. Примеры: `PC` — оплата из кошелька ЮMoney; `AC` — оплата с произвольной банковской карты или через Mir Pay (при оплате с мобильного устройства на Android). Полный список значений Если в платежной форме указан способ оплаты, который не разрешен для магазина, плательщик не сможет совершить платеж.
ym_merchant_receipt	string	Данные для формирования чека в формате JSON. Параметр передается и является обязательным, если вы настроили взаимодействие со своей онлайн-кассой через ЮKassa и передаете в платежной форме данные для формирования чека. См. Параметры для формирования чека Для B2B-платежей (`paymentType=2S`) данные для чека передавать не нужно.
Дополнительные параметры для B2B-платежей (paymentType=2S)
payment_purpose	string, 210 символов	Назначение платежа. Обязательный параметр.
vatType	string	Тип НДС. Возможные значения: `calculated` — облагается налогом, у всех товаров одинаковая ставка; `untaxed` — не облагается; `mixed` — товары в платеже облагаются налогом по-разному.
vatRate	string	Ставка НДС. Обязательно, если `vatType=calculated`. Возможные значения: `0` — ставка НДС 0%; `7` — ставка 7%; `10` — ставка 10%; `18` — ставка 18%; `20` — ставка 20%.
vatSum	CurrencyAmount	Сумма НДС. Обязательно, если `vatType=calculated` или `vatType=mixed`. Вам необходимо самостоятельно подсчитывать точную сумму НДС и передавать в запросе на оплату. А также в поле sum передавать полную сумму, которую заплатит покупатель, вместе с НДС.
Параметры, которые может добавить магазин (необязательно)
custom_field	string	Используется для передачи дополнительных параметров.
Любые названия, отличные от перечисленных выше	string, 4096 символов (суммарная длина всех параметров)	Параметры, добавленные магазином в платежную форму, будут сохранены и переданы магазину в запросах checkOrder и paymentAviso. Требования к названиям параметров: В названиях добавленных параметров можно использовать буквы латинского алфавита в любом регистре, цифры, символ подчеркивания и дефис. Нельзя использовать пробел, точку и квадратные скобки `[]`. Название должно начинаться с буквы, но нельзя использовать в начале сочетание xml.

Примеры

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

HTML
<form action="https://yoomoney.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-платежей

HTML
<form action="https://yoomoney.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>

Что почитать еще

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