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

api/change-rec - Изменение параметров регулярного заказа

  • HTTP‑метод: POST
  • URL: /api/change-rec
  • Форма взаимодействия: Сервер-сервер
  • Формат тела запроса: application/json
  • Назначение: изменение параметров регулярного (рекуррентного) заказа.

URL

1
https://gateway-docs.wallet.kvell.group/api/change-rec

1
/api/change-rec

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

Поле Тип Обяз. Описание
terminal str ✔ Уникальный идентификатор учетной записи ТСП в ПЦ.
order_id int ✔ Уникальный идентификатор Заказа в ПЦ, полученный по результатам Запроса api/register. Только если ранее при регистрации Заказа был передан параметр period=0.
amount int ✔ Сумма Операции в минимальных единицах валюты. Для рублей - копейки.
currency int ✔ Код валюты по ISO4217 (643 для RUB; 978 для EUR; 840 для USD).
recurrent object ✔ Параметры регулярного платежа (см. ниже). Вложенные поля period, retry_period, retry_count обязательны.
signature str ✔ Цифровая подпись запроса. Алгоритм расчёта — см. Формирование подписи.
Необязательные параметры
fee int Эквайринговая комиссия в минимальных единицах валюты. Для рублей – копейки. Взимается с Плательщика дополнительно к основной сумме Заказа.
remind_days_before int Количество дней, за которое Плательщику отсылается уведомление на электронную почту об очередном платеже. Может принимать значения от 1 до 10. (по умолчанию 0)
payer object Данные Плательщика. Значимое поле (см. структуру payer/receiver): email — адрес для отправки уведомлений о результатах проводимых в рамках Заказа Операций. Перезаписывает значение email, присвоенное при регистрации заказа.

Вложенный объект recurrent

Поле Тип Обяз. Описание
period int ✔ Код периода для регулярных платежей
retry_period int ✔ Период времени в сутках, через который необходимо повторить попытку выполнить регулярный платёж при неуспешном предыдущем. По умолчанию — 1 сутки.
retry_count int ✔ Количество попыток повторного выполнения регулярного платежа при неуспешном предыдущем, с интервалом из параметра retry_period. После исчерпания попыток регулярный Заказ аннулируется. По умолчанию равно 3.
is_retry bool Поведение после исчерпания retry_count: false (по умолчанию) — остановить все последующие списания; true — пропустить текущий платёж и продолжить по графику.
start_date str Дата начала действия регулярного платежа в формате: yyyy.MM.dd HH:mm:ss
end_date str Дата окончания действия регулярного платежа в формате: yyyy.MM.dd HH:mm:ss

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

Поле Тип Обяз. Описание
status str ✔ Всегда "ok".

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

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

{
    "status": "ok"
}

{
    "error_code": "TERMINAL_NOT_FOUND",
    "technical_message": "Terminal not found",
    "timestamp": 1751976000,
    "details": null,
    "request_id": "b3b3c1f0-4b3a-4f3a-9b1a-1234567890ab"
}