Skip to main content

Добавить вебхук

/api/v1/webhook

POST

https://business.tbank.ru/openapi/api/v1/webhook

Метод создает вебхук для получения уведомлений о событиях определенного типа. Уведомления будут приходить на указанный URL.

Авторизация

Security

RPS

Ограничение — 10 запросов в секунду

Scopes

Управление вебхукамиУправление вебхуками

Запрос

Header parameters

X-Request-Id

String<uuid>

Уникальный идентификатор для трассировки запроса. Не влияет на логику его исполнения.

Query parameters

Required

eventType

String (EventType736809848)

Requirements: [nonacceptance-debits-agreement-updates, ndfl3, oper-feed-operation, payment-requests-updates, payment-status, example, sbp-qr-status-changed, invoice-status-changed, partner-messages-new-message, sme-qds-partner-order-changed, bank-guarantee-order-status-changed]

Тип события.

Request body schema application/json

Required

hasSignature

Boolean

Флаг подписи.

authType

String (AuthType736809848)

Requirements: [Basic, Bearer]

Тип авторизации вебхука.

authSecret

String

Requirements: <= 256 characters

Ключ авторизации.

Required

email

String<email>

Requirements: <= 256 characters

Электронная почта для уведомлений.

Required

url

String<uri>

Requirements: <= 2048 characters

Адрес вебхука

Ответ

200

Вебхук успешно создан

400

Некорректный запрос

401

Ошибка аутентификации

403

Ошибка авторизации

422

Ошибка создания вебхука

429

Слишком много запросов

500

Ошибка сервера

502

Bad Gateway

503

Service Unavailable

504

Gateway Timeout

Это полезный материал?

Loading...

openapi@tbank.ru

АО «ТБанк» использует файлы «cookie» с целью персонализации сервисов и повышения удобства пользования веб-сайтом. «Cookie» представляют собой небольшие файлы, содержащие информацию о предыдущих посещениях веб-сайта. Если вы не хотите использовать файлы «cookie», измените настройки браузера.