Рекуррентные платежи¶
Поставщики услуг, которые интегрируется к системе PAYMO по API (глубокая интеграция) имеют возможность настроить рекуррентные платежи. Рекуррентные платежи позволяют установить на карте периодическое автосписание определенной суммы в счет оплаты услуг Поставщика.
- Процесс подключения рекурретного платежа:
Система Поставщика услуг создает планировщик автоплатежа путем вызова метода
scheduler/create.Система PAYMO высылает одноразовый пароль (OTP) по SMS владельцу карты для подтверждения автоплатежа.
Система Поставщика услуг подтверждает создание планировщика автоплатежа путем вызова сервиса
scheduler/confirm.
Механизм авторизации для вызова методов API указан в разделе Авторизация в API.
В запросах ко всем методам имеется поле lang, в котором необходимо передать язык ответного сообщения.
Во всех ответах передается объект result с полями code – код и description – описание результата запроса.
Далее в документации поля lang и result будут опущены для упрощения описания методов.
Метод pay-scheduler/create¶
Метод создает планировщик для автоплатежа в определенный день месяца, с возможностью повтора операции с заданным интервалом или списания с других карт, при условии, если на счету недостаточно средств. Перед вызовом данного метода необходимо зарегистрировать карту путем вызова метода partner/bind-card
Адрес: POST https://api.paymo.uz/pay-scheduler/create
Входящее сообщение:
# |
Поле |
Описание |
Откуда получить |
|---|---|---|---|
1 |
payments |
объект с информацией об автоплатеже |
– |
2 |
–date_start |
Дата начала планировщика формат (YYYY-MM-DD) (обязательное) |
клиент |
3 |
–login |
Логин пользователя(плательщика)/Номер телефона (обязательное) |
клиент |
4 |
–pay_day |
Календарный день оплаты. От 1 до 28 и last. «last» - означает последний день месяца (обязательное) |
клиент |
5 |
–pay_time |
Время оплаты в заданный день. Формат HH24:MI. Без секунд, например, 15:22 (обязательное) |
клиент |
6 |
–ext_id |
Персональный счет клиента в биллинге поставщика (обязательное) |
клиент |
7 |
–repeat_low_balance |
Флаг(boolean) - повторять ли, в случае, если на балансе недостаточно средств (обязательное) |
клиент |
8 |
–amount |
Сумма списания в тийинах (обязательное) |
клиент |
9 |
–cards |
Список карт, с которых можно осуществлять списание. Сначала проверяется первая карта - если денег достаточно, то списывается. Если денег недостаточно, то проверяется вторая карта (обяз.) |
клиент |
10 |
–store_id |
Идентификатор поставщика (обязательное) |
ATMOS |
11 |
–account |
Идентификатор услуги в биллинге поставщика, который пользователь будет оплачивать. (обязательное) |
клиент |
Ответное сообщение:
# |
Поле |
Описание |
1 |
result |
Объект, содержащий ответ от сервера |
2 |
–code |
Статус ответа сервера |
3 |
–description |
Описание к статусу ответа |
4 |
sheduler_id |
Идентификатор созданного планировщика |
Метод pay-scheduler/confrim¶
Метод подтверждает и активирует созданный планировщик.
Адрес: POST https://api.paymo.uz/pay-scheduler/confirm
Входящее сообщение:
# |
Поле |
Описание |
Откуда получить |
1 |
sheduler_id |
Идентификатор созданного планировщика (обязательное) |
/pay-scheduler/create |
2 |
otp |
Одноразовый пароль, высланный владельцу карты по SMS (обязательное) |
клиент |
Ответное сообщение:
# |
Поле |
Описание |
1 |
result |
Объект, содержащий ответ от сервера |
2 |
–code |
Статус ответа сервера |
3 |
–description |
Описание к статусу ответа |
Метод pay-scheduler/change¶
Удаляет или вносит изменения в созданный планировщик.
Адрес: POST https://api.paymo.uz/pay-scheduler/change
Входящее сообщение:
# |
Поле |
Описание |
Откуда получить |
|---|---|---|---|
1 |
sheduler_id |
Идентификатор записи планировщика (обязательное) |
/pay-scheduler/create |
2 |
delete |
Флаг(boolean), если true, удаляет запись (необязательное) |
клиент |
3 |
–payments |
объект с информацией об автоплатеже |
– |
4 |
– –date_start |
Дата начала планировщика формат (YYYY-MM-DD) (обязательное) |
клиент |
5 |
– –login |
Логин пользователя(плательщика)/Номер телефона (обязательное) |
клиент |
6 |
– –pay_day |
Календарный день оплаты. От 1 до 28 и last. «last» - означает последний день месяца (обязательное) |
клиент |
7 |
– –pay_time |
Время оплаты в заданный день. Формат HH24:MI. Без секунд, например, 15:22 (обязательное) |
клиент |
8 |
– –ext_id |
Персональный счет клиента в биллинге поставщика (обязательное) |
клиент |
9 |
– –repeat_low_balance |
Флаг(boolean) - повторять ли, в случае, если на балансе недостаточно средств (обязательное) |
клиент |
10 |
– –amount |
Сумма списания в тийинах(обязательное) |
клиент |
11 |
– –cards |
Список карт, с которых можно осуществлять списание. Сначала проверяется первая карта - если денег достаточно, то списывается. Если денег недостаточно, то проверяется вторая карта (обяз.) |
клиент |
12 |
– –store_id |
Идентификатор поставщика (обязательное) |
ATMOS |
13 |
– –account |
Идентификатор услуги в биллинге поставщика, который пользователь будет оплачивать. (обязательное) |
клиент |
Ответное сообщение:
# |
Поле |
Описание |
1 |
result |
Объект, содержащий ответ от сервера |
2 |
–code |
Статус ответа сервера |
3 |
–description |
Описание к статусу ответа |
4 |
sheduler_id |
Идентификатор записи планировщика |