Scope
scope события, на которое подписываетесь.
Допустимые значения scope можно посмотреть здесь.
Параметры запроса
Bearer {access_token}, полученный по Authorization Code Flow / Authorization Code Flow H2H
application/json
application/json
Объект/сущность, на которую партнёр API хочет подписаться. Возможные значения:
-
•
ul_transaction_default- получение выписки по счетам юридических лиц
Смещение в результатах поиска
Количество элементов
1curl -X GET https://baas.alfabank.ru/api/v1/webhooks?offset=20&limit=10&object=ul_transaction_default \
2 -H 'Authorization: Bearer {token}' \
3 -H 'Accept: application/json' \
4 -H 'Content-Type: application/json'Параметры ответа
1{
2 "pagination": {
3 "limit": 10,
4 "offset": 45,
5 "totalCount": 100
6 },
7 "items": [
8 {
9 "id": "f9f8c674-7a2a-4297-bdb8-ddd3013de3a3",
10 "object": "ul_transaction_default",
11 "enabled": true,
12 "data": {
13 "accounts": [
14 "40702810800000000001",
15 "40702810800000000004",
16 "40702810800000000007"
17 ]
18 },
19 "callbackUri": "https://webhook.partner.ru/api/v1/webhook-events",
20 "version": 1
21 },
22 {
23 "id": "f9f8c674-7a2a-4297-bdb8-ddd3013de222",
24 "object": "ul_transaction_default",
25 "enabled": true,
26 "data": {
27 "accounts": [
28 "40702810800000000001",
29 "40702810800000000004",
30 "40702810800000000007"
31 ]
32 },
33 "callbackUri": "https://webhook.partner.ru/api/v1/webhook-events",
34 "version": 1
35 }
36 ]
37}Данные пагинации
Количество объектов на одной странице
Количество объектов в списке, которые необходимо пропустить
Общее количество записей
Массив объектов результата
Идентификатор записи
Объект/сущность, на которую партнёр API хочет подписаться. Принимает возможные значения:
-
•
ul_transaction_default- получение выписки по счетам юридических лиц
Статус вебхука. Принимает возможные значения: true - вебхук включён; false - вебхук выключен
Дополнительные данные по вебхукам. Список полей зависит от события, на которое подписываетесь
Список счетов. Опционально поле, заполняется при object: ul_transaction_default
URL партнёра, на который был отправлен вебхук
Версия формата получаемых данных. Для object: ul_transaction_default доступное значение - 1
1{
2 "pagination": {
3 "limit": 10,
4 "offset": 45,
5 "totalCount": 100
6 },
7 "items": [
8 {
9 "id": "f9f8c674-7a2a-4297-bdb8-ddd3013de3a3",
10 "object": "ul_transaction_default",
11 "enabled": true,
12 "data": {
13 "accounts": [
14 "40702810800000000001",
15 "40702810800000000004",
16 "40702810800000000007"
17 ]
18 },
19 "callbackUri": "https://webhook.partner.ru/api/v1/webhook-events",
20 "version": 1
21 },
22 {
23 "id": "f9f8c674-7a2a-4297-bdb8-ddd3013de222",
24 "object": "ul_transaction_default",
25 "enabled": true,
26 "data": {
27 "accounts": [
28 "40702810800000000001",
29 "40702810800000000004",
30 "40702810800000000007"
31 ]
32 },
33 "callbackUri": "https://webhook.partner.ru/api/v1/webhook-events",
34 "version": 1
35 }
36 ]
37}Код ошибки. Принимает возможные значения: invalid_request - неверные входные параметры запроса
Описание ошибки
1{
2 "error": "invalid_request",
3 "error_description": "Authorization header is not present in request headers"
4}Код ошибки. Принимает возможные значения: invalid_token - предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам. При истечении срока жизни токена необходимо обновить его с помощью refresh_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 - при запросе кода авторизации не были переданы все необходимые scopes. Необходимо переподписать договор согласия, повторно отправив запрос на получение кода авторизации с указанием всех доступных scopes и параметра prompt=consent
Описание ошибки
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}Значения параметров ошибок могут изменяться. Рекомендуем предусмотреть стандартную обработку ошибок, не описанных в текущей версии документации.