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