Перейти к содержанию

webapi/Register - Регистрация заказа

Описание

  • HTTP‑метод: POST
  • URL: /webapi/Register/
  • Форма взаимодействия: Сервер-сервер
  • Формат тела запроса: application/x-www-form-urlencoded
  • Назначение: регистрация заказа в ПЦ.

URL

1
https://b2p.wallet.kvell.group/webapi/Register/
1
/webapi/Register/

Структура запроса

Поле Тип Обяз. Описание
sector str Уникальный идентификатор учётной записи ТСП в ПЦ.
amount int Сумма заказа в минимальных единицах валюты (для RUB — копейки).
currency int Код валюты по ISO 4217 (643 — RUB, 978 — EUR, 840 — USD).
reference str Номер заказа на стороне ТСП.
description str Описание платежа.
signature str Цифровая подпись (sector, amount, currency, password).
Условно-обязательные параметры
sd_ref str Идентификатор Кубышки.
Необязательные параметры
fee int Эквайринговая комиссия в минимальных единицах валюты. Взимается с Плательщика дополнительно к основной сумме Заказа
url URL URL, на который пользователь будет перенаправлен после операции. ПЦ также передает на url идентификаторы Заказа (id) и Операции (operation) в виде GET-параметров.
failurl URL URL для перенаправления в случае ошибки. ПЦ также передает на url идентификаторы Заказа (id) и Операции (operation) в виде GET-параметров.
life_period str Время жизни заказа в секундах.
fiscalData str Фискальные данные в соответствии с документацией по фискализации.
acc_number str Номер счёта получателя денежных средств.
contract str Номер договора получателя денежных средств.
payer_id str Идентификатор клиента на стороне ТСП.
email str Email Плательщика для уведомлений.
phone str Телефон Плательщика в формате 7XXXXXXXXXX.
email2 str Email Получателя денежных средств.
phone2 str Телефон Получателя денежных средств в формате 7XXXXXXXXXX.
back_deep_link str Deep‑link для возврата в мобильное приложение после оплаты.
mode int Режим ответа: 0 — полный XML, 1 — только id.
notify_url url URL для callback‑уведомлений.
address str Адрес Плательщика. Общий формат: название улицы, номер дома, номер квартиры/офиса.
city str Название населённого пункта Плательщика (города, посёлка и т.д.).
country str Двухсимвольных код страны Плательщика в соответствии с ISO 3166-1.
region str Название региона (области, края) Плательщика.
post_code str Индекс Плательщика (ZIP code)
lang str Язык платёжных страниц (Поддерживается только RU).
comment str Комментарий к заказу.
bank_name str Название банка Плательщика.
first_name str Имя Плательщика.
last_name str Фамилия Плательщика.
patronymic str Отчество Плательщика.
fio str Фамилия Имя Отчество Получателя денежных средств.
ps int Платёжная система. Возможные значения параметра: 0 (по умолчанию) — не установлена; 1 — Visa; 2 — MasterCard; 8 — Maestro; 10 – MIR; 11 — СБП; 12 — Uzcard; 13 — JCB; 14 — оплата со счёта мобильного телефона; 16 — HUMO; 17 — CHUP.
receipt_type int Номер шаблона уведомления, отправляемого на email Плательщику. По умолчанию используется первый (стандартный) шаблон
notify_customer int Признак отправки email‑уведомления о заказе. 0 — уведомление не отправляется; 1 — требуется отправить уведомление
month int Месяц срока действия Карты Плательщика. Используется для упрощения ввода параметров Карты в режиме оплаты через IVR.
year int Год срока действия Карты Плательщика. Используется для упрощения ввода параметров Карты в режиме оплаты через IVR.
originator int ID Операции в ПЦ (webapi/Purchase, webapi/Authorize), на основании которой был получен токен карты. Наличие данного параметра увеличивает конверсию регулярных платежей и требуется при возникновении претензий со стороны Плательщиков.
notify_sms bool Опция, отвечающая за необходимость отправки sms-уведомления (счета) со ссылкой на оплату. Возможные значения: false (значение по умолчанию) — не отправлять sms; true — отправить sms.
P008-1 str Наименование Плательщика.
P008-2 str Адрес Плательщика.
P014 int БИК получателя (ровно 9 цифр).
P015 int Корр. счёт банка получателя. Номер банковского счёта, входящего в состав единого казначейского счёта (ровно 20 цифр).
P016 str Наименование Получателя.
P017 int Счет получателя (ровно 20 цифр).
P018 int Вид операции. Возможные значения: 01 — платежное поручение; 06 — инкассовое поручение; 02 — платежное требование.
P020 int Назначение платежа. Заполняется при указании банка. Возможные значения: 1 — Заработная плата, премии, больничные листы и дивиденды сотрудникам (возможно удержание не более 50%); 2 — Периодические выплаты, алименты (удержания отсутствуют); 3 — Компенсация вреда здоровью (удержание только на оплату алиментов); 4 — Разовые выплаты: командировочные, выплаты на погребение (удержание 0%); 5 — Разовый доход (удержания в пользу алиментов, возмещения вреда здоровью или потери кормильца).
P021 int Очередность платежа. Отражает порядок перечисления платежей и зависит от их характера. Возможные значения: 1 — Алименты и платежи по судебным решениям о возмещении вреда жизни и здоровью; 2 — Авторские права, заработная плата и выходные пособия сотрудникам; 3 — Заработная плата, налоговые обязательства и погашение задолженностей по налогам и взносам в фонды; 4 — Средства по остальным исполнительным документам судебных приставов; 5 — Средства прочим контрагентам в соответствии с порядком очерёдности.
P022 int УИН (20 или 25 цифр). Если отсутствует — проставьте 0.
P024 str Назначение платежа.
P060 int ИНН Плательщика (10 или 12 цифр). Если отсутствует — проставьте 0.
P061 int ИНН Получателя (10 или 12 цифр). Если отсутствует — проставьте 0.
P101 int Статус Плательщика.
P102 int КПП Плательщика (9 цифр). Если отсутствует —проставьте 0.
P103 int КПП Получателя (9 цифр). Если отсутствует — проставьте 0.
P104 int КБК Получателя.
P105 int ОКТМО (8 или 11 цифр).
P106 str Основание платежа.
P107 str Налоговый период.
P108 str Номер документа, который является основанием платежа, либо 0.
P109 str Дата документа (формат yyyy.MM.dd). Если отсутствует — проставьте 0.
P110 str Тип документа.
recurring_period int Код периода для Рекуррентных платежей
multipaymentData str(JSON) Значение для передачи данных обо всех дополнительных платежах в формате JSON- объекта с ключом payments. Для каждого из платежей должны быть указаны: Обязательно: • paymentNum - уникальное значение партнёра для сплитования платежа; • amount – сумма; • fee - комиссия;• currency - валюта; • description – описание. При наличии: • reference – референс; • fiscalPositions - фискальные позиции; • fiscalData - данные для регистрации по кассе (в base64url).
error_period int Интервал времени в днях, через который необходимо повторить попытку выполнить Рекуррентный платёж при неуспешной предыдущей. По умолчанию равен 1.
error_number int Допустимое количество неуспешных попыток выполнения Операции списания Рекуррентного платежа. После достижения счетчиком неуспешных попыток значения error_number, попытки списать этот платеж прекращаются. По умолчанию равно 3 (если recurring_period отличен от 0).
continuing_recurring bool Опция, действующая совместно с error_number. По умолчанию равна false. После достижения счетчиком неуспешных попыток значения error_number: • Если continuing_recurring = false, текущий и все предстоящие Рекуррентные платежи Заказа перестают списываться; • Если continuing_recurring = true, текущий (неуспешный)Рекуррентный платеж пропускается, счетчик неуспешных попыток обнуляется, ПЦ ожидает наступления следующего по графику Рекуррентного платежа Заказа.
remind_days_before int Количество дней до списания Рекуррентного платежа, когда необходимо отправить Плательщику уведомление на электронную почту с напоминанием о предстоящем списании. Принимает значения от 0 до 10. По умолчанию равен 0 (не уведомлять).
start_date str Дата начала периода действия Рекуррентного платежа в формате: yyyy.MM.dd HH:mm:ss Если значение не указано, оно будет считаться равным 00:00:00 дня, следующего за днем совершения первой успешной Операции Заказа.
end_date str Дата окончания периода действия Рекуррентного платежа в формате: yyyy.MM.dd HH:mm:ss Если значение не указано, оно будет считаться равным 00:00:00 дня, следующего за днем совершения первой успешной Операции Заказа.

Структура ответа

Элемент Тип Описание
id int Идентификатор заказа в ПЦ.
state str Статус заказа
inprogress int Признак «выполняется ли ещё заказ» (0/1).
date datetime Дата и время регистрации заказа (YYYY.MM.DD HH:MM:SS).
amount int Сумма заказа в минимальных единицах валюты (для RUB — копейки).
currency int Код валюты (ISO 4217).
email str Email плательщика.
phone str Телефон плательщика.
reference str Внутренний идентификатор заказа на стороне ТСП.
description str Описание платежа.
url str URL возврата плательщика.
parameters parameters Массив параметров заказа (см. ниже).
signature str Цифровая подпись ответа ПЦ.

Параметры заказа

Элемент parameters содержит:

Атрибут / Элемент Тип Описание
number (атрибут) int Количество параметров.
parameter[] массив Список параметров.

Каждый parameter имеет:

Элемент Тип Описание
name str Имя параметра (например, mode).
value str Значение параметра.

Пример ответов

<?xml version="1.0" encoding="UTF-8"?>
<order>
    <id>5587788</id>
    <state>REGISTERED</state>
    <inprogress>0</inprogress>
    <date>2024.01.28 00:23:19</date>
    <amount>111</amount>
    <currency>643</currency>
    <email>mail@somesite.com</email>
    <phone>79219999999</phone>
    <reference>12345ABC</reference>
    <description>notebook</description>
    <url>http://www.somesite.com/Accept.jsp</url>
    <parameters number="1">
        <parameter>
            <name>mode</name>
            <value>1</value>
        </parameter>
    </parameters>
    <signature>Y2Y0ZjllMGI3NDc0YjhjYTU2Yzk1ZTg1NGMxMmI1MDQ=</signature>
</order>
<?xml version="1.0" encoding="UTF-8"?>
<error>
    <description>Sector not found</description>
    <code>105</code>
</error>