Контакт-центр 8 (800) 707-82-75 бесплатно по России
Москва +7 (495) 984-87-51
Санкт-Петербург +7 (812) 385-75-57

9. Привязка карты

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

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

Для создания привязки необходимо при инициализации платежа методом HTML-формы передать следующие параметры:

  Параметр Назначение Обязательный
1 Параметр:sum Назначение:Сумма списания в рублях. Обязательный:Да
2 Параметр:msgtype Назначение:Тип операции, для создания привязки карты принимает значение createbinding. Обязательный:Да
3 Параметр:clientid Назначение:Идентификатор клиента. Обязательный:Да

Остальные параметры принимаются и обрабатываются так же, как и при обычной инициализации платежа методом HTML-формы.

Пример формы для создания привязки карты:

Пример, как будет отображаться данная форма:

Идентификатор абонента:
Сумма:

 
Более подробно о создании 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 Назначение:Списать следующий по графику платеж

9.1. Автоплатеж по его id /info/binding/autopayment-by-id/

При помощи этого запроса можно выполнить автоплатеж по его id. Формат запроса:

Таблица 9.1.1. Параметры запроса

Тип Формат запроса
Тип:GET Формат запроса:/info/binding/autopayment-by-id/
Параметр Назначение
1. Параметр:id Назначение:Уникальный идентификатор автоплатежа

Если списание произведено успешно, то возвращается объект вида:

В случае ошибки поле result ответа будет содержать описание ошибки:

9.2. Все автоплатежи по bank_id /info/binding/autopayments-by-bank-id/?bank_id=

При помощи этого запроса можно посмотреть все автоплатеж по его bank_id. Формат запроса:

Таблица 9.2.1. Параметры запроса

Тип Формат запроса
Тип:GET Формат запроса:/info/binding/autopayments-by-bank-id/?bank_id=
Параметр Назначение
1. Параметр:bank_id Назначение:Идентификатор привязки у ТСП

Если запрос пройдет успешно, то возвращается объект вида:

В случае ошибки поле result ответа будет содержать описание ошибки:

9.3. Подписка по bank_id /info/binding/binding-by-bank-id

При помощи этого запроса можно посмотреть подписку по его bank_id. Формат запроса:

Таблица 9.3.1. Параметры запроса

Тип Формат запроса
Тип:GET Формат запроса:/info/binding/binding-by-bank-id/?bank_id=
Параметр Назначение
1. Параметр:bank_id Назначение:Идентификатор привязки

Если запрос пройдет успешно, то возвращается объект вида:

В случае ошибки поле result ответа будет содержать описание ошибки:

9.4. Все автоплатежи /info/binding/autopayments-all

При помощи этого запроса можно все автоплатежи. Формат запроса:

Таблица 9.4.1. Параметры запроса

Тип Формат запроса
Тип:GET Формат запроса:/info/binding/autopayments-all/?from=&limit=
Параметр Назначение
1. Параметр:from Назначение:Смещение (начало)
2. Параметр:limit Назначение:количество

Если запрос пройдет успешно, то возвращается объект вида:

В случае ошибки поле result ответа будет содержать описание ошибки:

9.5. Количество автоплатежей /info/binding/autopayments-count

При помощи этого запроса можно количество автоплатежей. Формат запроса:

Таблица 9.5.1. Параметры запроса

Тип Формат запроса
Тип:GET Формат запроса:/info/binding/autopayments-count

Если запрос пройдет успешно, то возвращается объект вида:

В случае ошибки поле result ответа будет содержать описание ошибки:

9.6. Безакцептное списание по имени связки /change/binding/execute/

При помощи этого запроса можно выполнить списание по привязанной ранее карте. Формат запроса:

Таблица 9.6.1. Параметры запроса

Тип Формат запроса
Тип:POST Формат запроса:/change/binding/execute/
Параметр Назначение
1. Параметр:bank_id Назначение:Банковский уникальный идентификатор привязки, по которому необходимо произвести списание.
2. Параметр:clientid Назначение:Идентификатор клиента в системе магазина, указанный при создании привязки.
3. Параметр:orderid Назначение:Номер заказа в системе магазина.
4. Параметр:token Назначение:Токен безопасности.
5. Параметр:sum Назначение:Сумма платежа.
  Параметр:… Назначение:Остальные параметры инициализации платежа, которые поддерживает метод HTML-формы.

Обратите внимание, что выполняемому платежу будет присвоен bank_id, такой же, как и у первого платежа, по которому выполнялась привязка карты. Если списание произведено успешно, то возвращается объект вида:

В поле payment_id этого объекта будет содержаться номер совершённого платежа. Информацию о нём можно получить с помощью запроса 2.3 или дождавшись POST-уведомления.

В случае ошибки поле result ответа будет содержать описание ошибки:

POST-оповещение по безакцептному платежу, выполненному с помощью привязки карты с идентификатором bank_id, будет содержать такое же значение в поле bank_id.

9.7. Статистика по автоплатежу /info/binding/autopayment-statistic

При помощи этого запроса можно посмотреть статистику по автоплатежу. Формат запроса:

Таблица 9.7.1. Параметры запроса

Тип Формат запроса
Тип:GET Формат запроса:/info/binding/autopayment-statistic
Параметр Назначение
1. Параметр:id Назначение:Идентификатор автоплатежа

Если запрос пройдет успешно, то возвращается объект вида:

В случае ошибки поле result ответа будет содержать описание ошибки:

9.8.Привязки по статусу /info/binding/bindings-by-status-all/

При помощи этого запроса можно посмотреть привязки по статусу. Формат запроса:

Таблица 9.8.1. Параметры запроса

Тип Формат запроса
Тип:GET Формат запроса:/info/binding/bindings-by-status-all/
Параметр Назначение
1. Параметр:from Назначение:Смещение
2. Параметр:limit Назначение:Количество
3. Параметр:status Назначение:Статус

Если запрос пройдет успешно, то возвращается объект вида:

В случае ошибки поле result ответа будет содержать описание ошибки:

9.9.Количество привязок-подписок по статусу /info/binding/bindings-by-status-count

При помощи этого запроса можно посмотреть количество привязок-подписок по статусу. Формат запроса:

Таблица 9.9.1. Параметры запроса

Тип Формат запроса
Тип:GET Формат запроса:/info/binding/bindings-by-status-all/
Параметр Назначение
1. Параметр:status Назначение:Статус подписки

Если запрос пройдет успешно, то возвращается объект вида:

В случае ошибки поле result ответа будет содержать описание ошибки:

9.10.Все привязки /info/binding/bindings-all/

При помощи этого запроса можно посмотреть все привязки. Формат запроса:

Таблица 9.10.1. Параметры запроса

Тип Формат запроса
Тип:GET Формат запроса:/info/binding/bindings-all
Параметр Назначение
1. Параметр:from Назначение:Смещение
2. Параметр:limit Назначение:Количество
3. Параметр:status Назначение:Статус подписки

Если запрос пройдет успешно, то возвращается объект вида:

В случае ошибки поле result ответа будет содержать описание ошибки:

9.11.Количество привязок-подписок /info/binding/bindings-count

При помощи этого запроса можно посмотреть количество привязок-подписок. Формат запроса:

Таблица 9.11.1. Параметры запроса

Тип Формат запроса
Тип:GET Формат запроса:/info/binding/bindings-count
Параметр Назначение
1. Параметр:status Назначение:Статус подписки

Если запрос пройдет успешно, то возвращается объект вида:

В случае ошибки поле result ответа будет содержать описание ошибки:

9.12.Автоплатежи по статусам /info/binding/autopayments-by-status-all

При помощи этого запроса можно посмотреть автоплатежи по статусам. Формат запроса:

Таблица 9.12.1. Параметры запроса

Тип Формат запроса
Тип:GET Формат запроса:/info/binding/autopayments-by-status-all
Параметр Назначение
1. Параметр:from Назначение:Смещение
2. Параметр:limit Назначение:Количество
3. Параметр:status Назначение:Статус подписки

Если запрос пройдет успешно, то возвращается объект вида:

В случае ошибки поле result ответа будет содержать описание ошибки:

9.13.Количество автоплатежей по статусам /info/binding/autopayments-by-status-count/?status[]=active&status[]=deleted
&status[]=finished

При помощи этого запроса можно посмотреть автоплатежи по статусам. Формат запроса:

Таблица 9.13.1. Параметры запроса

Тип Формат запроса
Тип:GET Формат запроса:/info/binding/autopayments-by-status-count/?status[]=active&status[]=deleted&status[]=finished
Параметр Назначение
1. Параметр:status Назначение:Статус подписки

Если запрос пройдет успешно, то возвращается объект вида:

9.14.Расписание или график списаний /info/binding/schedule-by-autopayment

При помощи этого запроса можно посмотреть расписание или график списаний. Формат запроса:

Таблица 9.14.1. Параметры запроса

Тип Формат запроса
Тип:GET Формат запроса:/info/binding/schedule-by-autopayment
Параметр Назначение
1. Параметр:autopayment_id Назначение:Идентификатор автоплатежа
2. Параметр:from Назначение:Смещение
3. Параметр:limit Назначение:Количесвто

Если запрос пройдет успешно, то возвращается объект вида:

В случае ошибки поле result ответа будет содержать описание ошибки:

9.15.Расписание или график списаний по статусам /info/binding/schedule-by-autopayment-by-status

При помощи этого запроса можно посмотреть расписание или график списаний по статусам. Формат запроса:

Таблица 9.15.1. Параметры запроса

Тип Формат запроса
Тип:GET Формат запроса:/info/binding/schedule-by-autopayment-by-status
Параметр Назначение
1. Параметр:autopayment_id Назначение:Идентификатор автоплатежа
2. Параметр:from Назначение:Смещение
3. Параметр:limit Назначение:Количесвто
4. Параметр:status Назначение:Статус расписания

Если запрос пройдет успешно, то возвращается объект вида:

В случае ошибки поле result ответа будет содержать описание ошибки:

9.16.Попытки списания /info/binding/schedule-attemps

При помощи этого запроса можно посмотреть попытки списания. Формат запроса:

Таблица 9.16.1. Параметры запроса

Тип Формат запроса
Тип:GET Формат запроса:/info/binding/schedule-attemps
Параметр Назначение
1. Параметр:from Назначение:Смещение
2. Параметр:limit Назначение:Количесвто
3. Параметр:schedule_id Назначение:Идентификатор расписания

Если запрос пройдет успешно, то возвращается объект вида:

В случае ошибки поле result ответа будет содержать описание ошибки:

9.17.Количество попыток списания /info/binding/schedule-attemps-count

При помощи этого запроса можно посмотреть количество попыток списания. Формат запроса:

Таблица 9.17.1. Параметры запроса

Тип Формат запроса
Тип:GET Формат запроса:/info/binding/schedule-attemps-count
Параметр Назначение
1. Параметр:schedule_id Назначение:Идентификатор расписания

Если запрос пройдет успешно, то возвращается объект вида:

В случае ошибки поле result ответа будет содержать описание ошибки:

9.21. Новый автоплатеж с оплатой /create

Обычный 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 код, для ИЭ всегда ответ платежная страница Обязательный:Нет

Если запрос пройдет успешно, то возвращается объект вида:

9.22. Новый автоплатежплатеж по существующей привязке /change/binding/create-new-from-binding

Обычный 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 Назначение:Максимальное число неудачных попыток списать автоплатеж в очереди (сколько платежей может быть несписано по данному платежу) Обязательный:Нет

Если запрос пройдет успешно, то возвращается объект вида:

9.23. Списать платежи вручную /change/binding/capture

Списание вручную платежей, не по cron скрипту а вручную, спишет даже если сегодня была попытка и попытка завершилась неудачей. Формат запроса:

Таблица 9.23.1. Параметры запроса

Тип Формат запроса
Тип:POST Формат запроса:/change/binding/capture
Параметр Назначение
1. Параметр:autopayment_id Назначение:Идентификатор автоплатежа (id в модели autopayment)
2. Параметр:token Назначение:Обычный CSRF токен для всех апи

Если запрос пройдет успешно, то возвращается объект вида:

В случае ошибки поле result ответа будет содержать описание ошибки:

9.24. Списать следующий по графику платеж /change/binding/capture-next

При помощи этого запроса можно списать следующий по графику платеж. Формат запроса:

Таблица 9.24.1. Параметры запроса

Тип Формат запроса
Тип:POST Формат запроса:/change/binding/capture-next
Параметр Назначение
1. Параметр:autopayment_id Назначение:Идентификатор автоплатежа (id в модели autopayment)
2. Параметр:token Назначение:Обычный CSRF токен для всех апи

Если запрос пройдет успешно, то возвращается объект вида:

В случае ошибки поле result ответа будет содержать описание ошибки:

Оставьте заявку

Менеджер перезвонит вам и расскажет про детали подключения