Рекуррентные платежи

Поставщики услуг, которые интегрируется к системе PAYMO по API (глубокая интеграция) имеют возможность настроить рекуррентные платежи. Рекуррентные платежи позволяют установить на карте периодическое автосписание определенной суммы в счет оплаты услуг Поставщика.

Процесс подключения рекурретного платежа:
  1. Система Поставщика услуг регистрирует карту пользователя путем вызова метода partner/add-card.
  2. Система Поставщика услуг создает планировщик автоплатежа путем вызова метода scheduler/create.
  3. Система PAYMO высылает одноразовый пароль (OTP) по SMS владельцу карты для подтверждения автоплатежа.
  4. Система Поставщика услуг подтверждает создание планировщика автоплатежа путем вызова сервиса scheduler/confirm.

Механизм авторизации для вызова методов API указан в разделе Авторизация в API.

В запросах ко всем методам имеется поле lang, в котором необходимо передать язык ответного сообщения. Во всех ответах передается объект result с полями code – код и description – описание результата запроса. Далее в документации поля lang и result будут опущены для упрощения описания методов.

Метод partner/add-card

Метод регистрирует карту пользователя в приложении Поставщика.

Адрес: https://api.pays.uz:8243/partner/

Входящее сообщение:

Поле Описание
card_number Номер карты
expiry Дата истечения карты

Метод pay-scheduler/create

Метод создает планировщик для автоплатежа. Перед вызовом данного метода необходимо зарегистрировать карту путем вызова метода partner/add-card

Адрес: https://api.pays.uz:8243/pay-scheduler/create

Входящее сообщение:

# Поле Описание
1 payment объект с информацией об автоплатеже
2 –date_start Дата начала планировщика в формате YYYY-mm-dd H:m:i
3 –date_finish Дата завершения планировщика (null - если неограниченное)
4 –amount Сумма платежа в тийинах
5 –account Идентификатор пользователя в биллинге Поставщика
6 –cards Массив со списком идентификаторов (ID) карт
7 –pay_day Календарный день оплаты
8 –pay_time Время оплаты в формате HH:mm

Ответное сообщение:

# Поле Описание
1 sheduler_id Идентификатор созданного планировщика

Метод pay-scheduler/confrim

Метод подтверждает и активирует созданный планировщик.

Адрес: https://api.pays.uz:8243/pay-scheduler/confirm

Входящее сообщение:

# Поле Описание
1 sheduler_id Идентификатор созданного планировщика
2 otp Одноразовый пароль, высланный владельцу карты по SMS

Ответное сообщение:

# Поле Описание
1    

Метод pay-scheduler/change

Удаляет созданный планировщик.

Адрес: https://api.pays.uz:8243/pay-scheduler/change

Входящее сообщение:

# Поле Описание
1 sheduler_id Идентификатор созданного планировщика
2 delete Флаг удаления (передать true)

Ответное сообщение:

# Поле Описание
1