webapi/ChangeRec - Изменение параметров регулярного заказа
- HTTP‑метод:
POST
- URL:
/webapi/ChangeRec/
- Форма взаимодействия: Сервер-сервер
- Формат тела запроса:
application/x-www-form-urlencoded
- Назначение: изменение параметров регулярного (рекуррентного) заказа.
URL
Структура запроса
| Поле |
Тип |
Обяз. |
Описание |
sector |
str |
✔ |
Уникальный идентификатор учётной записи ТСП в ПЦ. |
id |
int |
✔ |
Идентификатор заказа в ПЦ, полученный из webapi/Register. |
amount |
int |
✔ |
Сумма операции в минимальных единицах валюты (для RUB — копейки). |
currency |
int |
✔ |
Код валюты по ISO 4217 (643 — RUB, 978 — EUR, 840 — USD). |
recurring_period |
int |
✔ |
Код периода для Рекуррентных платежей |
error_period |
int |
✔ |
Интервал времени в днях, через который необходимо повторить попытку выполнить Рекуррентный платёж при неуспешной предыдущей. По умолчанию равен 1. |
error_number |
int |
✔ |
Допустимое количество неуспешных попыток выполнения Операции списания Рекуррентного платежа. После достижения счетчиком неуспешных попыток значения error_number, попытки списать этот платеж прекращаются. По умолчанию равно 3 (если recurring_period отличен от 0). |
signature |
str |
✔ |
Подпись по sector, id, amount, currency, password. |
| Необязательные параметры |
fee |
int |
|
Эквайринговая комиссия в минимальных единицах валюты. Взимается с Плательщика дополнительно к основной сумме Заказа |
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 дня, следующего за днем совершения первой успешной Операции Заказа. |
email |
str |
|
Email Плательщика для уведомлений. |
Структура ответа
В ответ на этот Запрос ПЦ присылает сообщение “ok” в формате text/plain. Если результат положительный, то данные в регулярном заказе меняются на те, которые переданы в Запросе.
Пример ответов