Scope
scope события, на которое подписываетесь.
Допустимые значения scope можно посмотреть здесь.
Параметры запроса
Bearer {access_token}, полученный по Authorization Code Flow / Authorization Code Flow H2H
application/json
application/json
Объект/сущность, на который партнер API хочет подписаться. Возможные значения: ul_transaction_default - Получение выписки
Список счетов. Опционально поле, заполняется при object: ul_transaction_default. Если счета не переданы, то вебхук создаться на все доступные для вас счета
URL партнера, на который будет отправляться вебхук. В поле необходимо указывать хост, который указывали в качестве redirect_uriпри интеграции с Alfa ID. Проверка будет проводиться только на соответствие домена второго уровня
Версия формата получаемых данных. Для object: ul_transaction_default доступное значение - 1
1curl -X POST https://baas.alfabank.ru/api/v1/webhooks \
2 -H 'Authorization: Bearer {token}' \
3 -H 'Accept: application/json' \
4 -H 'Content-Type: application/json' \
5 -d '{
6 "object": "ul_transaction_default",
7 "data": {
8 "accounts": [
9 "40702810800000000001",
10 "40702810800000000004",
11 "40702810800000000007"
12 ]
13 },
14 "callbackUri": "https://webhook.partner.ru/api/v1/webhook-events",
15 "version": 1
16 }'Параметры ответа
1{
2 "id": "f9f8c674-7a2a-4297-bdb8-ddd3013de3a3",
3 "object": "ul_transaction_default",
4 "enabled": true,
5 "data": {
6 "accounts": [
7 "40702810800000000001",
8 "40702810800000000004",
9 "40702810800000000007"
10 ]
11 },
12 "callbackUri": "https://webhook.partner.ru/api/v1/webhook-events",
13 "version": 1
14}Идентификатор записи
Объект/сущность, на который клиент хочет подписаться. Принимает возможные значения: ul_transaction_default - Получение выписки
Статус вебхука. Принимает возможные значения: true - Вебхук включен; false - Вебхук выключен
Список счетов. Опционально поле, заполняется при object: ul_transaction_default
URL партнера, на который был отправлен вебхук
Версия формата получаемых данных. Для object: ul_transaction_default доступное значение - 1
1{
2 "id": "f9f8c674-7a2a-4297-bdb8-ddd3013de3a3",
3 "object": "ul_transaction_default",
4 "enabled": true,
5 "data": {
6 "accounts": [
7 "40702810800000000001",
8 "40702810800000000004",
9 "40702810800000000007"
10 ]
11 },
12 "callbackUri": "https://webhook.partner.ru/api/v1/webhook-events",
13 "version": 1
14}Код ошибки. Принимает возможные значения: invalid_request - Неверные входные параметры запроса
Описание ошибки
1{
2 "error": "invalid_request",
3 "error_description": "Authorization header is not present in request headers"
4}Код ошибки. Принимает возможные значения: invalid_token - Предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам
Описание ошибки
1{
2 "error": "invalid_token",
3 "error_description": "The access token provided is expired, revoked, malformed, or invalid for other reasons"
4}Код ошибки. Принимает возможные значения: insufficient_scope - У пользователя нет прав на использование запрашиваемого сервиса, доступ к которому не предусмотрен настройками scope
Описание ошибки
1{
2 "error": "insufficient_scope",
3 "error_description": "The request requires higher privileges than provided by the access token"
4}Код ошибки. Принимает возможные значения: unknown_route - Эндпоинт не найден или неактивен
Описание ошибки
1{
2 "error": "unknown_route",
3 "error_description": "Route is not found or not active"
4}Код ошибки. Принимает возможные значения: internal_error - Внутренняя ошибка сервиса при выполнении обработки запроса
Описание ошибки
1{
2 "error": "internal_error",
3 "error_description": "Internal server error"
4}Значения параметров ошибок могут изменяться. Рекомендуем предусмотреть стандартную обработку ошибок, не описанных в текущей версии документации.