API

  1. Home
  2. API
  3. Рекуррентные платежи
  4. Расписание рекуррентного платежа

Расписание рекуррентного платежа

Для рекуррентного профиля можно указать расписание платежей. В этом случае платежи будут совершаться по указанному расписанию автоматически. Указать расписание можно либо в виде шаблона, либо в виде простого списка дат.

Создание расписания

Для указания расписания необходимо отправить запрос на URL https://platron.ru/index.php/api/recurring/set-schedule, параметры передаются одним из методов прямого запроса (см. Способы прямого взаимодействия между магазином и Platronом)

Параметр (обязательные поля выделены жирным) Описание
pg_merchant_id Идентификатор продавца
pg_recurring_profile Идентификатор рекуррентного профиля
pg_amount Сумма рекуррентного платежа
pg_template* Данные шаблона (описание параметров шаблона см. ниже)
pg_dates* Список дат в формате YYYY-MM-DD HH:MM:SS
pg_salt Случайная строка
pg_sig Подпись

*Для создания расписания необходимо указать либо данные шаблона, либо список дат. Если одновременно будут указаны данные шаблона и список дат, для создания расписания будет использован список дат.

Параметры шаблона:

Параметр (обязательные поля выделены жирным) Описание
pg_start_date Дата и время первого платежа в формате YYYY-MM-DD HH:MM:SS
pg_interval * Интервал. Возможные значения: day, week, month
pg_period * Период.
pg_max_periods Максимальной кол-во платежей.

*Период используется в сочетании с интервалом. Например, 1 month означает раз в месяц, 2 week означает раз в две недели.

Пример GET запроса с указанием шаблона.

Для лучшей читаемости в примере не экранированы служебные символы.

https://platron.ru/index.php/api/recurring/set-schedule?pg_merchant_id=82&pg_recurring_profile=337146&pg_amount=21.23&pg_template[pg_start_date]=2018-08-15 15:30:00&pg_template[pg_interval]=week&pg_template[pg_period]=2&pg_template[pg_max_periods]=5&pg_salt=salt&pg_sig=5036eda9b1a31d5d8ed825c5d658ad43

Пример XML запроса с указанием шаблона

<?xml version="1.0" encoding="UTF-8"?>
<request>
    <pg_merchant_id>82</pg_merchant_id>
    <pg_recurring_profile>337146</pg_recurring_profile>
    <pg_amount>12.41</pg_amount>
    <pg_template>
        <pg_start_date>2018-08-15 15:30:00</pg_start_date>
        <pg_interval>week</pg_interval>
        <pg_period>2</pg_period>
        <pg_max_periods>5</pg_max_periods>
    </pg_template>
    <pg_salt>salt</pg_salt>
    <pg_sig>458a8161df06e21bcc6967c44e9965qw</pg_sig>
</request>

Пример GET запроса со списком дат.

Для лучшей читаемости в примере не экранированы служебные символы.

https://platron.ru/index.php/api/recurring/set-schedule?pg_merchant_id=82&pg_recurring_profile=337146&pg_amount=21.23&pg_dates[]=2018-08-15 14:00:00&pg_dates[]=2018-08-15 14:30:00&pg_dates[]=2018-08-15 15:00:00&pg_salt=salt&pg_sig=0d32e1bfb8795a7c2a7ff86973vct5er

Пример XML запроса со списком дат.

<?xml version="1.0" encoding="UTF-8"?>
<request>
    <pg_merchant_id>82</pg_merchant_id>
    <pg_recurring_profile>337146</pg_recurring_profile>
    <pg_amount>12.41</pg_amount>
    <pg_dates>2018-08-15 14:00:00</pg_dates>
    <pg_dates>2018-08-15 14:30:00</pg_dates>
    <pg_dates>2018-08-15 15:00:00</pg_dates>
    <pg_salt>salt</pg_salt>
    <pg_sig>b71988a7cc47ae411d9292a0933944ac</pg_sig>
</request>

Ответ при удачном создании расписания.

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <pg_status>ok</pg_status>
    <pg_recurring_profile>337146</pg_recurring_profile>
    <pg_salt>salt</pg_salt>
    <pg_sig>a764fb36af2e607ee2e841989adr65ty</pg_sig>
</response>

Получение расписания.

Для получения расписания по рекуррентному профилю необходимо отправить запрос на URL https://platron.ru/index.php/api/recurring/get-schedule, параметры передаются одним из методов прямого запроса (см. Способы прямого взаимодействия между магазином и Platronом)

Параметры запроса

Параметр (обязательные поля выделены жирным) Описание
pg_merchant_id Идентификатор продавца
pg_recurring_profile Идентификатор рекуррентного профиля
pg_salt Случайная строка
pg_sig Подпись

Пример ответа с расписанием в виде шаблона.

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <pg_status>ok</pg_status>
    <pg_recurring_profile>337146</pg_recurring_profile>
    <pg_amount>11.23</pg_amount>
    <pg_start_date>2018-08-15 14:30:00</pg_start_date>
    <pg_interval>week</pg_interval>
    <pg_period>2</pg_period>
    <pg_max_periods>5</pg_max_periods>
    <pg_salt>salt</pg_salt>
    <pg_sig>ab8148000df497a47f18bdee2d0a04af</pg_sig>
</response>

Пример ответа с расписанием со списком дат

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <pg_status>ok</pg_status>
    <pg_recurring_profile>337146</pg_recurring_profile>
    <pg_amount>21.23</pg_amount>
    <pg_dates>2018-08-15 14:00:00</pg_dates>
    <pg_dates>2018-08-15 14:30:00</pg_dates>
    <pg_dates>2018-08-15 15:00:00</pg_dates>
    <pg_salt>salt</pg_salt>
    <pg_sig>ab8148000df497a47f18bdee2d0a04af</pg_sig>
</response>

Пример ответа если расписание не указано

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <pg_status>error</pg_status>
    <pg_recurring_profile>337146</pg_recurring_profile>
    <pg_error_code>200</pg_error_code>
    <pg_error_description>Расписание не указано</pg_error_description>
    <pg_salt>salt</pg_salt>
    <pg_sig>ab8148000df497a47f18bdee2d0a04af</pg_sig>
</response>

Удаление расписания.

Для удаления расписания по рекуррентному профилю необходимо отправить запрос на URL https://platron.ru/index.php/api/recurring/clear-schedule, параметры передаются одним из методов прямого запроса (см. Способы прямого взаимодействия между магазином и Platronом)

Параметры запроса

Параметр (обязательные поля выделены жирным) Описание
pg_merchant_id Идентификатор продавца
pg_recurring_profile Идентификатор рекуррентного профиля
pg_salt Случайная строка
pg_sig Подпись

Пример ответа при удачном удалении расписания.

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <pg_status>ok</pg_status>
    <pg_recurring_profile>337146</pg_recurring_profile>
    <pg_salt>salt</pg_salt>
    <pg_sig>9622e7bbf624cd65ea437a413f060582</pg_sig>
</response>