О сервисе
С помощью API банка вы можете работать с интернет-банком прямо из своего сервиса:
- Получать список счетов, подключённых к аккаунту
- Получать выписки по счёту
- Создавать черновики платёжек на подпись
- Получать вебхуки о входящих и исходящих платежах
- Подписывать платежи из интегрированного сервиса
- Регистрироваться в Системе быстрых платежей (СБП), создавать QR-коды, отслеживать оплаты по ним и делать возвраты
- Получать балансы счетов
- Создавать счета и закрывающие документы
- Создавать платёжные ссылки для приёма оплаты по карте и/или СБП
- Выберите способ авторизации: JWT-токен — если хотите создать интеграцию для личного использования, OAuth 2.0 — если хотите создать интеграцию для других клиентов Точка Банка.
- Получите токен и передавайте его в заголовке каждого запроса:
Authorization: Bearer <токен>. - Узнайте
customerCodeсвоей компании — метод Get Customers List. - Узнайте
accountIdнужного счёта — метод Get Accounts List. - Вызывайте нужные методы: баланс, выписки, платежи, QR-коды.
- Подпишитесь на вебхуки, чтобы сразу узнавать о поступлениях, а не опрашивать банк.
Опробовать запросы на тестовых данных можно в Песочнице. Она повторяет структуру боевых методов, но работает с тестовыми данными, поэтому в ней можно безопасно попробовать различные запросы.
Разделы документации
| Раздел | Что внутри |
|---|---|
| Терминология | Основные понятия и идентификаторы: customerCode, accountId, merchantId, типы QR-кодов, форматы дат и сумм |
| Авторизация по OAuth 2.0 | Пошаговый сценарий, если вы обращаетесь к API от имени других компаний с их согласия |
| Авторизация по JWT-токену | Как сгенерировать ключ в интернет-банке, если интеграция нужна только вашей компании |
| Коллекция запросов | Готовая коллекция для Postman — попробовать запросы без написания кода |
| Описание методов | Как устроены сервисы и в каком порядке вызывать методы: балансы, выписки, платежи, СБП, эквайринг, вебхуки |
| Методы | Справочник всех методов: адреса, параметры, примеры запросов и ответов, коды ошибок |
| Как интегрировать API интернет-эквайринга | Полный путь подключения эквайринга: заявка, выбор авторизации, тестирование, сроки зачисления денег |
| Песочница | Тестовый слой API: адрес, токен и тестовые данные для отладки |
| Обновления API | Что изменилось в API: новые методы и поля |
| Вопросы и ошибки | Частые вопросы и разбор популярных ошибок |
Чем «Описание методов» отличается от «Методов»
Это два разных слоя документации, и они дополняют друг друга.
Описание методов отвечает на вопрос «зачем и как». Здесь по-человечески рассказано, как устроен сервис, какие методы вызывать и в каком порядке, какие есть ограничения и особенности. Например, что выписка формируется асинхронно: сначала её нужно заказать, а потом забрать готовую.
Методы отвечает на вопрос «что именно передать». Это технический справочник: адрес метода, все поля с типами и допустимыми значениями, готовые примеры запроса на curl, PHP, Python, Java и Go, примеры ответов и коды ошибок.
Обычно порядок такой: сначала читаете «Описание методов», чтобы понять логику сервиса, а потом открываете «Методы», чтобы собрать конкретный запрос.