Привязкой карты называется созданная в банковской процессинговой сети ассоциация с определённой картой, позволяющая списывать в любое время с привязанной карты любую сумму и зачислять её определённому абоненту. Данная возможность оказывается особенно полезной, когда нельзя точно или заранее определить, какую сумму и когда нужно будет списать с карты плательщика. Примером могут быть службы такси и сервисы аренды оборудования.
Первый платёж по карте, которую нужно привязать, будет проходить в обычном режиме с вводом реквизитов карты. Поэтому для создания привязки можно провести транзакцию на любую сумму (в том числе на 1 рубль). Последующие платежи по этой карте можно будет выполнять без явного участия плательщика, безакцептно. Тем не менее, если нужно выполнить платёж с привязанной карты по расписанию без явного действия со стороны абонента, мы настоятельно рекомендуем уведомлять абонента заранее перед очередным списанием.
Для создания привязки необходимо при инициализации платежа методом HTML-формы передать следующие параметры:
| Параметр | Назначение | Обязательный | |
| 1 | Параметр:sum | Назначение:Сумма списания в рублях. | Обязательный:Да |
| 2 | Параметр:msgtype | Назначение:Тип операции, для создания привязки карты принимает значение createbinding. | Обязательный:Да |
| 3 | Параметр:clientid | Назначение:Идентификатор клиента. | Обязательный:Да |
Остальные параметры принимаются и обрабатываются так же, как и при обычной инициализации платежа методом HTML-формы.
Пример формы для создания привязки карты:
|
1 2 3 4 5 6 |
<form method='POST' action='http://demo.paykeeper.ru/create/' > Идентификатор абонента: <input type='text' name='clientid' value='123456'/> <br /> Сумма: <input type='text' name='sum' value='1'/> <br /> <input type='submit' value='Создать привязку' /> <input type='hidden' name='msgtype' value='createbinding'/> </form> |
Пример, как будет отображаться данная форма:
Более подробно о создании HTML-формы можно прочитать в разделе методы интеграции.
В параметрах проведённого платежа будет содержаться полe bank_id, это уникальный идентификатор привязки в системе банка. В POST-оповещение по такому платежу будет добавлено полe bank_id. Оно позволит в дальнейшем проводить безакцептные списания с использованной в данном платеже карты.
В настоящее время JSON API поддерживает следующие методы для работы с привязками карт:
| URI | Назначение | |
|---|---|---|
| 9.1 | URI:/info/binding/autopayment-by-id/ | Назначение:Автоплатеж по его id |
| 9.2 | URI:/info/binding/autopayments-by-bank-id/?bank_id= | Назначение:Все автоплатежи по bank_id |
| 9.3 | URI:/info/binding/binding-by-bank-id | Назначение:Подписка по bank_id |
| 9.4 | URI:/info/binding/autopayments-all | Назначение:Все автоплатежи |
| 9.5 | URI:/info/binding/autopayments-count | Назначение:Количество автоплатежей |
| 9.6 | URI:/change/binding/execute/ | Назначение:Безакцептное выполнение платежа по имени привязки bank_id. |
| 9.7 | URI:/info/binding/autopayment-statistic/ | Назначение:Статистика по автоплатежу |
| 9.8 | URI:/info/binding/bindings-by-status-all/ | Назначение:Привязки по статусу |
| 9.9 | URI:/info/binding/bindings-by-status-count | Назначение:Количество привязок-подписок по статусу |
| 9.10 | URI:/info/binding/bindings-all/ | Назначение:Все привязки |
| 9.11 | URI:/info/binding/bindings-count | Назначение:Количество привязок-подписок |
| 9.12 | URI:/info/binding/autopayments-by-status-all | Назначение:Автоплатежи по статусам |
| 9.13 | URI:/info/binding/autopayments-by-status-count/?status[]=active&status[]=deleted &status[]=finished |
Назначение:Количество автоплатежей по статусам |
| 9.14 | URI:/info/binding/schedule-by-autopayment | Назначение:Расписание или график списаний |
| 9.15 | URI:/info/binding/schedule-by-autopayment-by-status | Назначение:Расписание или график списаний по статусам |
| 9.16 | URI:/info/binding/schedule-attemps | Назначение:Попытки списания |
| 9.17 | URI:/info/binding/schedule-attemps-count | Назначение:Количество попыток списания |
| 9.18 | URI:RESERVED | Назначение:RESERVED |
| 9.19 | URI:RESERVED | Назначение:RESERVED |
| 9.20 | URI:RESERVED | Назначение:RESERVED |
| URI | Назначение | |
|---|---|---|
| 9.21 | URI:/create | Назначение:Новый автоплатеж с оплатой |
| 9.22 | URI:/change/binding/create-new-from-binding | Назначение:Новый автоплатежплатеж по существующей привязке |
| 9.23 | URI:/change/binding/capture | Назначение:Списать платежи вручную |
| 9.24 | URI:/change/binding/capture-next | Назначение:Списать следующий по графику платеж |
При помощи этого запроса можно выполнить автоплатеж по его id. Формат запроса:
Таблица 9.1.1. Параметры запроса
| Тип | Формат запроса | |
| Тип:GET | Формат запроса:/info/binding/autopayment-by-id/ | |
| Параметр | Назначение | |
| 1. | Параметр:id | Назначение:Уникальный идентификатор автоплатежа |
Если списание произведено успешно, то возвращается объект вида:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 |
[ { "id": 0, "binding_id": 0, "start_datetime": "2019-08-24 14:15:22", "expire_date": "2019-08-24", "frequency": "[9 0 * */2 1,3]", "title": "", "client_email": "user@example.com", "client_phone": "+79161234567", "cart": "", "max_queued_payments_allowed": 1, "on_max_queued_set_status": "cancel", "status": "creating" } ] |
В случае ошибки поле result ответа будет содержать описание ошибки:
|
1 2 3 4 5 6 |
[ { "result":"fail", "msg":"Example cannot be created for this schema TypeError: Cannot read properties of undefined (reading 'value')" } ] |
При помощи этого запроса можно посмотреть все автоплатеж по его bank_id. Формат запроса:
Таблица 9.2.1. Параметры запроса
| Тип | Формат запроса | |
| Тип:GET | Формат запроса:/info/binding/autopayments-by-bank-id/?bank_id= | |
| Параметр | Назначение | |
| 1. | Параметр:bank_id | Назначение:Идентификатор привязки у ТСП |
Если запрос пройдет успешно, то возвращается объект вида:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 |
[ { "id": 1, "start_datetime": "2019-08-24 14:15:22", "expire_date": "2019-08-24", "frequency": "[9 0 * */2 1,3]", "title": "", "client_email": "user@example.com", "client_phone": "+79161234567", "cart": "", "max_queued_payments_allowed": 1, "on_max_queued_set_status": "cancel", "status": "creating" }, { "id": 5, "start_datetime": "2019-08-24 14:15:22", "expire_date": "2020-08-24", "frequency": "[10 0 * * 5]", "title": "", "client_email": "user@example.com", "client_phone": "+79161234567", "cart": "", "max_queued_payments_allowed": 1, "on_max_queued_set_status": "cancel", "status": "active" } ] |
В случае ошибки поле result ответа будет содержать описание ошибки:
|
1 2 3 4 5 6 |
[ { "result": "fail", "msg": "Нет такого автоплатежа" } ] |
При помощи этого запроса можно посмотреть подписку по его bank_id. Формат запроса:
Таблица 9.3.1. Параметры запроса
| Тип | Формат запроса | |
| Тип:GET | Формат запроса:/info/binding/binding-by-bank-id/?bank_id= | |
| Параметр | Назначение | |
| 1. | Параметр:bank_id | Назначение:Идентификатор привязки |
Если запрос пройдет успешно, то возвращается объект вида:
|
1 2 3 4 5 6 7 8 9 10 11 |
[ { "bank_id": "121121212", "ps_type": "card", "install_payment_id": 23, "install_datetime": "2019-08-24 14:15:22", "masked_pan": "411*****1", "status": "creating", "title": "Подписка для Иванова А.А. от 2020-09-08" } ] |
В случае ошибки поле result ответа будет содержать описание ошибки:
|
1 2 3 4 5 6 |
[ { "result": "fail", "msg": "Нет такой привязки" } ] |
При помощи этого запроса можно все автоплатежи. Формат запроса:
Таблица 9.4.1. Параметры запроса
| Тип | Формат запроса | |
| Тип:GET | Формат запроса:/info/binding/autopayments-all/?from=&limit= | |
| Параметр | Назначение | |
| 1. | Параметр:from | Назначение:Смещение (начало) |
| 2. | Параметр:limit | Назначение:количество |
Если запрос пройдет успешно, то возвращается объект вида:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 |
[ { "id": 1, "start_datetime": "2019-08-24 14:15:22", "expire_date": "2019-08-24", "frequency": "[9 0 * */2 1,3]", "title": "", "client_email": "user@example.com", "client_phone": "+79161234567", "cart": "", "max_queued_payments_allowed": 1, "on_max_queued_set_status": "cancel", "status": "creating" }, { "id": 2, "start_datetime": "2019-08-24 14:15:22", "expire_date": "2019-08-24", "frequency": "[9 0 * */2 1,3]", "title": "", "client_email": "user@example.com", "client_phone": "+79161234567", "cart": "", "max_queued_payments_allowed": 1, "on_max_queued_set_status": "cancel", "status": "creating" } ] |
В случае ошибки поле result ответа будет содержать описание ошибки:
|
1 2 3 4 5 6 |
[ { "result": "fail", "msg": "Нет разрешения для работы с автоплатежами" } ] |
При помощи этого запроса можно количество автоплатежей. Формат запроса:
Таблица 9.5.1. Параметры запроса
| Тип | Формат запроса | |
| Тип:GET | Формат запроса:/info/binding/autopayments-count | |
Если запрос пройдет успешно, то возвращается объект вида:
|
1 2 3 4 5 |
[ { "count": "100" } ] |
В случае ошибки поле result ответа будет содержать описание ошибки:
|
1 2 3 4 5 6 |
[ { "result": "fail", "msg": "Текст ошибки" } ] |
При помощи этого запроса можно выполнить списание по привязанной ранее карте. Формат запроса:
Таблица 9.6.1. Параметры запроса
| Тип | Формат запроса | |
| Тип:POST | Формат запроса:/change/binding/execute/ | |
| Параметр | Назначение | |
| 1. | Параметр:bank_id | Назначение:Банковский уникальный идентификатор привязки, по которому необходимо произвести списание. |
| 2. | Параметр:clientid | Назначение:Идентификатор клиента в системе магазина, указанный при создании привязки. |
| 3. | Параметр:orderid | Назначение:Номер заказа в системе магазина. |
| 4. | Параметр:token | Назначение:Токен безопасности. |
| 5. | Параметр:sum | Назначение:Сумма платежа. |
| Параметр:… | Назначение:Остальные параметры инициализации платежа, которые поддерживает метод HTML-формы. |
Обратите внимание, что выполняемому платежу будет присвоен bank_id, такой же, как и у первого платежа, по которому выполнялась привязка карты. Если списание произведено успешно, то возвращается объект вида:
|
1 2 3 4 5 6 |
[ { "result":"success", "payment_id":"1582" } ] |
В поле payment_id этого объекта будет содержаться номер совершённого платежа. Информацию о нём можно получить с помощью запроса 2.3 или дождавшись POST-уведомления.
В случае ошибки поле result ответа будет содержать описание ошибки:
|
1 2 3 4 5 6 |
[ { "result":"fail", "msg":"runtime error during template execution" } ] |
POST-оповещение по безакцептному платежу, выполненному с помощью привязки карты с идентификатором bank_id, будет содержать такое же значение в поле bank_id.
При помощи этого запроса можно посмотреть статистику по автоплатежу. Формат запроса:
Таблица 9.7.1. Параметры запроса
| Тип | Формат запроса | |
| Тип:GET | Формат запроса:/info/binding/autopayment-statistic | |
| Параметр | Назначение | |
| 1. | Параметр:id | Назначение:Идентификатор автоплатежа |
Если запрос пройдет успешно, то возвращается объект вида:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
[ { "status": "not_started", "count": "23" }, { "status": "active", "count": "1" }, { "status": "paid", "count": "6" } ] |
В случае ошибки поле result ответа будет содержать описание ошибки:
|
1 2 3 4 5 6 |
[ { "result": "fail", "msg": "Что-то пошло не так" } ] |
При помощи этого запроса можно посмотреть привязки по статусу. Формат запроса:
Таблица 9.8.1. Параметры запроса
| Тип | Формат запроса | |
| Тип:GET | Формат запроса:/info/binding/bindings-by-status-all/ | |
| Параметр | Назначение | |
| 1. | Параметр:from | Назначение:Смещение |
| 2. | Параметр:limit | Назначение:Количество |
| 3. | Параметр:status | Назначение:Статус |
Если запрос пройдет успешно, то возвращается объект вида:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 |
[ { "bank_id": "003d45cf27974786b59605f762c06a30", "ps_type": "card", "install_payment_id": "280483", "install_datetime": "2025-05-30 15:58:23", "masked_pan": "", "status": "creating", "title": "null" }, { "bank_id": "059b0957d3d64edf8961475c91f96b52", "ps_type": "card", "install_payment_id": "280537", "install_datetime": "2025-05-30 17:47:36", "masked_pan": "null", "status": "creating", "title": "Подписка для за от 2025-05-30" }, { "bank_id": "1e7fb181bb3544fd818667e910433f4e", "ps_type": "card", "install_payment_id": "280533", "install_datetime": "2025-05-30 15:58:23", "masked_pan": "null", "status": "creating", "title": "Подписка для за от 2025-05-30" } ] |
В случае ошибки поле result ответа будет содержать описание ошибки:
|
1 2 3 4 5 6 |
[ { "result": "fail", "msg": "Ошибочка вышла" } ] |
При помощи этого запроса можно посмотреть количество привязок-подписок по статусу. Формат запроса:
Таблица 9.9.1. Параметры запроса
| Тип | Формат запроса | |
| Тип:GET | Формат запроса:/info/binding/bindings-by-status-all/ | |
| Параметр | Назначение | |
| 1. | Параметр:status | Назначение:Статус подписки |
Если запрос пройдет успешно, то возвращается объект вида:
|
1 2 3 4 5 6 7 |
[ [ { "count": "230" } ] ] |
В случае ошибки поле result ответа будет содержать описание ошибки:
|
1 2 3 4 5 6 |
[ { "result": "fail", "msg": "Какая то ошибка" } ] |
При помощи этого запроса можно посмотреть все привязки. Формат запроса:
Таблица 9.10.1. Параметры запроса
| Тип | Формат запроса | |
| Тип:GET | Формат запроса:/info/binding/bindings-all | |
| Параметр | Назначение | |
| 1. | Параметр:from | Назначение:Смещение |
| 2. | Параметр:limit | Назначение:Количество |
| 3. | Параметр:status | Назначение:Статус подписки |
Если запрос пройдет успешно, то возвращается объект вида:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 |
[ { "bank_id": "003d45cf27974786b59605f762c06a30", "ps_type": "card", "install_payment_id": "280483", "install_datetime": "2025-05-30 15:58:23", "masked_pan": "", "status": "creating", "title": "null" }, { "bank_id": "059b0957d3d64edf8961475c91f96b52", "ps_type": "card", "install_payment_id": "280537", "install_datetime": "2025-05-30 17:47:36", "masked_pan": "null", "status": "creating", "title": "Подписка для за от 2025-05-30" }, { "bank_id": "1e7fb181bb3544fd818667e910433f4e", "ps_type": "card", "install_payment_id": "280533", "install_datetime": "2025-05-30 15:58:23", "masked_pan": "null", "status": "creating", "title": "Подписка для за от 2025-05-30" } ] |
В случае ошибки поле result ответа будет содержать описание ошибки:
|
1 2 3 4 5 6 |
[ { "result": "fail", "msg": "Ошибочка вышла" } ] |
При помощи этого запроса можно посмотреть количество привязок-подписок. Формат запроса:
Таблица 9.11.1. Параметры запроса
| Тип | Формат запроса | |
| Тип:GET | Формат запроса:/info/binding/bindings-count | |
| Параметр | Назначение | |
| 1. | Параметр:status | Назначение:Статус подписки |
Если запрос пройдет успешно, то возвращается объект вида:
|
1 2 3 4 5 |
[ { "count": "230" } ] |
В случае ошибки поле result ответа будет содержать описание ошибки:
|
1 2 3 4 5 6 |
[ { "result": "fail", "msg": "Какая то ошибка" } ] |
При помощи этого запроса можно посмотреть автоплатежи по статусам. Формат запроса:
Таблица 9.12.1. Параметры запроса
| Тип | Формат запроса | |
| Тип:GET | Формат запроса:/info/binding/autopayments-by-status-all | |
| Параметр | Назначение | |
| 1. | Параметр:from | Назначение:Смещение |
| 2. | Параметр:limit | Назначение:Количество |
| 3. | Параметр:status | Назначение:Статус подписки |
Если запрос пройдет успешно, то возвращается объект вида:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
[ { "id": "1", "binding_id": "200", "pay_amount": "125.00", "start_datetime": "2025-09-18 16:48:39", "expire_date": "2025-09-20", "frequency": "[\"0 9 * * 1,3,5\"]", "title": "", "client_email": "", "client_phone": "", "cart": "", "max_queued_payments_allowed": "1", "on_max_queued_set_status": "cancel", "status": "finished" }, { "id": "7", "binding_id": "212", "pay_amount": "125.00", "start_datetime": "2025-10-02 12:49:30", "expire_date": "2025-12-09", "frequency": "[\"0 9 * * 1,3,5\"]", "title": "", "client_email": "", "client_phone": "", "cart": "", "max_queued_payments_allowed": "20", "on_max_queued_set_status": "cancel", "status": "active" }, { "id": "8", "binding_id": "230", "pay_amount": "125.00", "start_datetime": "2025-10-08 15:23:29", "expire_date": "2026-01-01", "frequency": "[\"0 9 * * 1,3,5\"]", "title": "", "client_email": "", "client_phone": "", "cart": "", "max_queued_payments_allowed": "1", "on_max_queued_set_status": "cancel", "status": "active" } ] |
В случае ошибки поле result ответа будет содержать описание ошибки:
|
1 2 3 4 5 6 |
[ { "result": "fail", "msg": "Нет разрешения для работы с автоплатежами" } ] |
При помощи этого запроса можно посмотреть автоплатежи по статусам. Формат запроса:
Таблица 9.13.1. Параметры запроса
| Тип | Формат запроса | |
| Тип:GET | Формат запроса:/info/binding/autopayments-by-status-count/?status[]=active&status[]=deleted&status[]=finished | |
| Параметр | Назначение | |
| 1. | Параметр:status | Назначение:Статус подписки |
Если запрос пройдет успешно, то возвращается объект вида:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
[ { "count": "5", "status": "deleted" }, { "count": "1", "status": "finished" }, { "count": "6", "status": "active" } ] |
При помощи этого запроса можно посмотреть расписание или график списаний. Формат запроса:
Таблица 9.14.1. Параметры запроса
| Тип | Формат запроса | |
| Тип:GET | Формат запроса:/info/binding/schedule-by-autopayment | |
| Параметр | Назначение | |
| 1. | Параметр:autopayment_id | Назначение:Идентификатор автоплатежа |
| 2. | Параметр:from | Назначение:Смещение |
| 3. | Параметр:limit | Назначение:Количесвто |
Если запрос пройдет успешно, то возвращается объект вида:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 |
[ { "id": "8", "autopayment_id": "7", "start_datetime": "2025-10-02 12:49:00", "counter": "1", "status": "paid" }, { "id": "9", "autopayment_id": "7", "start_datetime": "2025-10-03 09:00:00", "counter": "1", "status": "active" }, { "id": "10", "autopayment_id": "7", "start_datetime": "2025-10-06 09:00:00", "counter": "1", "status": "paid" } ] |
В случае ошибки поле result ответа будет содержать описание ошибки:
|
1 2 3 4 5 6 |
[ { "result": "fail", "msg": "Что-то не так" } ] |
При помощи этого запроса можно посмотреть расписание или график списаний по статусам. Формат запроса:
Таблица 9.15.1. Параметры запроса
| Тип | Формат запроса | |
| Тип:GET | Формат запроса:/info/binding/schedule-by-autopayment-by-status | |
| Параметр | Назначение | |
| 1. | Параметр:autopayment_id | Назначение:Идентификатор автоплатежа |
| 2. | Параметр:from | Назначение:Смещение |
| 3. | Параметр:limit | Назначение:Количесвто |
| 4. | Параметр:status | Назначение:Статус расписания |
Если запрос пройдет успешно, то возвращается объект вида:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 |
[ { "id": "8", "autopayment_id": "7", "start_datetime": "2025-10-02 12:49:00", "counter": "1", "status": "paid" }, { "id": "10", "autopayment_id": "7", "start_datetime": "2025-10-06 09:00:00", "counter": "1", "status": "paid" }, { "id": "11", "autopayment_id": "7", "start_datetime": "2025-10-08 09:00:00", "counter": "1", "status": "paid" } ] |
В случае ошибки поле result ответа будет содержать описание ошибки:
|
1 2 3 4 5 6 |
[ { "result": "fail", "msg": "Нет такого автоплатежа" } ] |
При помощи этого запроса можно посмотреть попытки списания. Формат запроса:
Таблица 9.16.1. Параметры запроса
| Тип | Формат запроса | |
| Тип:GET | Формат запроса:/info/binding/schedule-attemps | |
| Параметр | Назначение | |
| 1. | Параметр:from | Назначение:Смещение |
| 2. | Параметр:limit | Назначение:Количесвто |
| 3. | Параметр:schedule_id | Назначение:Идентификатор расписания |
Если запрос пройдет успешно, то возвращается объект вида:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 |
[ { "id": "7", "schedule_id": "7", "payment_id": "282477", "is_manual": "0", "status": "failed" }, { "id": "8", "schedule_id": "7", "payment_id": "282478", "is_manual": "0", "status": "paid" } ] |
В случае ошибки поле result ответа будет содержать описание ошибки:
|
1 2 3 4 5 6 |
[ { "result": "fail", "msg": "Error tex" } ] |
При помощи этого запроса можно посмотреть количество попыток списания. Формат запроса:
Таблица 9.17.1. Параметры запроса
| Тип | Формат запроса | |
| Тип:GET | Формат запроса:/info/binding/schedule-attemps-count | |
| Параметр | Назначение | 1. | Параметр:schedule_id | Назначение:Идентификатор расписания |
Если запрос пройдет успешно, то возвращается объект вида:
|
1 2 3 4 5 |
[ { "count": "5" } ] |
В случае ошибки поле result ответа будет содержать описание ошибки:
|
1 2 3 4 5 6 |
[ { "result": "fail", "msg": "Ошибка" } ] |
Обычный create запрос на создание платежа с дополнительными аттрибутами для автоплатежа. Формат запроса:
Таблица 9.21.1. Параметры запроса
| Тип | Формат запроса | |
| Тип:POST | Формат запроса:/create | |
| Параметр | Назначение | Обязательный | |
| 1. | Параметр:pstype | Назначение:Наименование платежной системы | Обязательный:Да |
| 2. | Параметр:expire_date | Назначение:Срок действия автоплатежа (дата после, которой запрещены любые списания) Пример: 2025-12-31 |
Обязательный:Да |
| 3. | Параметр:sum | Назначение:Сумма периодического платежа | Обязательный:Да |
| 4. | Параметр:clientid | Назначение:Идентификатор клиента | Обязательный:Да |
| 5. | Параметр:msgtype | Назначение:Обязательный параметр для автоплатежа. Допустимое значение: createautopayment. По умолчанию: createautopayment |
Обязательный:Да |
| 6. | Параметр:frequency | Назначение:Периодичность автоплатежа, указанная в json по формату cron. Пример: [9 0 * */2 1,3] | Обязательный:Да |
| 7. | Параметр:service_name | Назначение:Наименование автоплатежа, для последующих оплат (service_name) | Обязательный:Да |
| 8. | Параметр:on_max_queued_set_status | Назначение:Статус автоплатежа после окончания попыток неуспешного списания (когда переполнилась очередь — предыдущий параметр). Допустимое значение: cancel, active. По умолчанию: cancel | Обязательный:Да |
| 9. | Параметр:client_email | Назначение:Email клиента для которого создан автоплатеж | Обязательный:Нет |
| 10. | Параметр:client_phone | Назначение:Телефон клиента для которого создан автоплатеж | Обязательный:Нет |
| 11. | Параметр:cart | Назначение:Корзина автоплатежа | Обязательный:Нет |
| 12. | Параметр:max_queued_payments_allowed | Назначение:Максимальное число неудачных попыток списать автоплатеж в очереди (сколько платежей может быть несписано по данному платежу) | Обязательный:Нет |
| 13. | Параметр:json | Назначение:Необязательный параметр, используется только для СБП чтобы вернулся QR код, для ИЭ всегда ответ платежная страница | Обязательный:Нет |
Если запрос пройдет успешно, то возвращается объект вида:
|
1 2 3 4 5 |
[ { "result": "success" } ] |
Обычный POST запрос на создание платежа, тут перечислены только дополнительные параметры автоплатежа, всякие другие специфические — нет. BASIC Авторизация НЕ НУЖНА. Формат запроса:
Таблица 9.22.1. Параметры запроса
| Тип | Формат запроса | |
| Тип:POST | Формат запроса:/change/binding/create-new-from-binding | |
| Параметр | Назначение | ||
| 1. | Параметр:bank_id | Назначение:Идентификатор привязки | |
| 2. | Параметр:expire_date | Назначение:Срок действия автоплатежа (дата после, которой запрещены любые списания) Пример: 2025-12-31 |
|
| 3. | Параметр:sum | Назначение:Сумма периодического платежа | |
| 4. | Параметр:frequency | Назначение:Периодичность автоплатежа, указанная в json по формату cron. Пример: [9 0 * */2 1,3] | |
| 5. | Параметр:service_name | Назначение:Наименование автоплатежа, для последующих оплат (service_name) | |
| 6. | Параметр:on_max_queued_set_status | Назначение:статус автоплатежа после окончания попыток неуспешного списания (когда переполнилась очередь — предыдущий параметр). Допустимое значение: cancel, active. По умолчанию: cancel | |
| 7. | Параметр:token | Назначение:Обычный CSRF токен для всех апи | |
| 8. | Параметр:client_email | Назначение:Email клиента для которого создан автоплатеж | Обязательный:Нет |
| 9. | Параметр:client_phone | Назначение:Телефон клиента для которого создан автоплатеж | Обязательный:Нет |
| 10. | Параметр:cart | Назначение:Корзина автоплатежа | Обязательный:Нет |
| 11. | Параметр:max_queued_payments_allowed | Назначение:Максимальное число неудачных попыток списать автоплатеж в очереди (сколько платежей может быть несписано по данному платежу) | Обязательный:Нет |
Если запрос пройдет успешно, то возвращается объект вида:
|
1 2 3 4 5 |
[ { "result": "success" } ] |
Списание вручную платежей, не по cron скрипту а вручную, спишет даже если сегодня была попытка и попытка завершилась неудачей. Формат запроса:
Таблица 9.23.1. Параметры запроса
| Тип | Формат запроса | |
| Тип:POST | Формат запроса:/change/binding/capture | |
| Параметр | Назначение | |
| 1. | Параметр:autopayment_id | Назначение:Идентификатор автоплатежа (id в модели autopayment) |
| 2. | Параметр:token | Назначение:Обычный CSRF токен для всех апи |
Если запрос пройдет успешно, то возвращается объект вида:
|
1 2 3 4 5 |
[ { "result": "success" } ] |
В случае ошибки поле result ответа будет содержать описание ошибки:
|
1 2 3 4 5 6 |
[ { "result": "fail", "msg": "Нет такого автоплатежа" } ] |
При помощи этого запроса можно списать следующий по графику платеж. Формат запроса:
Таблица 9.24.1. Параметры запроса
| Тип | Формат запроса | |
| Тип:POST | Формат запроса:/change/binding/capture-next | |
| Параметр | Назначение | |
| 1. | Параметр:autopayment_id | Назначение:Идентификатор автоплатежа (id в модели autopayment) |
| 2. | Параметр:token | Назначение:Обычный CSRF токен для всех апи |
Если запрос пройдет успешно, то возвращается объект вида:
|
1 2 3 4 5 |
[ { "result": "success" } ] |
В случае ошибки поле result ответа будет содержать описание ошибки:
|
1 2 3 4 5 6 |
[ { "result": "fail", "msg": "Нет такого автоплатежа" } ] |
Менеджер перезвонит вам и расскажет про детали подключения