webapi/Recurring - Повторное (Автоматическое) списание по карте:
- HTTP‑метод:
POST
- URL:
/webapi/Recurring/
- Форма взаимодействия: Сервер-сервер
- Формат тела запроса:
application/x-www-form-urlencoded
- Назначение: выполнение рекуррентной (автоматической) операции
RECURRING по ранее зарегистрированному заказу.
- Дополнительно: метод подразумевает ведение графика Рекуррентных платежей на стороне ТСП. Новые платежи создаются как операции в рамках одного и того же заказа.
URL
Структура запроса
| Поле |
Тип |
Обяз. |
Описание |
sector |
str |
✔ |
Уникальный идентификатор учётной записи ТСП в ПЦ. |
id |
int |
✔ |
Идентификатор заказа в ПЦ, полученный из webapi/Register. |
amount |
int |
✔ |
Сумма заказа в минимальных единицах валюты (для RUB — копейки). |
currency |
int |
✔ |
Код валюты по ISO 4217 (643 — RUB, 978 — EUR, 840 — USD). |
signature |
str |
✔ |
Цифровая подпись (sector, id, amount, currency, password) или (sector, id, amount, fee, currency, password) |
| Необязательные параметры |
fee |
int |
|
Эквайринговая комиссия в минимальных единицах валюты. Взимается с Плательщика дополнительно к основной сумме Заказа |
Структура ответа
| Элемент |
Тип |
Описание |
order_id |
int |
Идентификатор заказа в ПЦ. |
order_state |
str |
Статус заказа |
reference |
str |
Номер заказа на стороне ТСП. |
id |
int |
Идентификатор операции в ПЦ |
date |
datetime |
Дата и время совершения операции в ПЦ (YYYY.MM.DD HH:MM:SS). |
type |
str |
Тип операции. |
state |
str |
Статус операции |
reason_code |
int |
Код ответа на операцию ПЦ |
message |
str |
Краткое описание кода ответа на операцию ПЦ |
name |
str |
Имя на банковской карте Плательщика |
pan |
str |
Маскированный номер банковской карты Плательщика |
email |
str |
Электронная почта Плательщика |
amount |
int |
Сумма заказа в минимальных единицах валюты (для RUB — копейки). |
curency |
int |
Код валюты по ISO 4217 (643 — RUB, 978 — EUR, 840 — USD). |
approval_code |
str |
Код авторизации, полученный в Банке на данную операцию. |
signature |
str |
Цифровая подпись сообщения. В подписи участвуют значения всех тегов в порядке их следования и пароль для расчёта цифровой подписи, предоставляемый ТСП после его регистрации в ПЦ. |
Пример ответов
Примечания
- Ответ может содержать ряд новых необязательных параметров, которые важно учесть при составлении подписи.
- Для лучшего разделения и структуры рекомендуется использовать операции по токенам, а не рекуррентные в рамках заказа.