Scope
scope события, на которое подписываетесь, с допустимыми значениями, которые можно посмотреть здесь.
Параметры запроса
Bearer {access_token}, полученный по Authorization Code Flow / Authorization Code Flow H2H
application/json
application/json
Объект/сущность, на которую партнёр API хочет подписаться. Возможные значения:
- •
ul_transaction_default- получение выписки по счетам юридических лиц; - •
jp_sbp_incoming_payments- получение входящих платежей по СБП для юридических лиц
Смещение в результатах поиска
Количество элементов
1curl -X GET https://baas.alfabank.ru/api/v2/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 "offset": 45,
4 "limit": 10,
5 "totalCount": 100
6 },
7 "items": [
8 {
9 "id": "f9f8c674-7a2a-4297-bdb8-ddd3013de3a3",
10 "object": "ul_transaction_default",
11 "enabled": true,
12 "organizationIdHash": "ff22df927f36344155f7075fae297541fcfca87e3dabef5aa9c951a21c4f072c",
13 "data": {
14 "accounts": [
15 "40702810800000000001",
16 "40702810800000000004",
17 "40702810800000000007"
18 ]
19 },
20 "callbackUri": "https://webhook.partner.ru/api/v1/webhook-events",
21 "version": 1,
22 "statusDescriptions": [
23 {
24 "cause": "Revocation of agreement",
25 "description": "The webhook is disabled due to the agreement being revoked in Alfa ID"
26 },
27 {
28 "cause": "Disabled by administrator",
29 "description": "Webhook disabled administrator"
30 }
31 ]
32 },
33 {
34 "id": "f9f8c674-7a2a-4297-bdb8-ddd3013de222",
35 "object": "ul_transaction_default",
36 "enabled": true,
37 "organizationIdHash": "ff22df927f36344155f7075fae297541fcfca87e3dabef5aa9c951a21c4f072c",
38 "data": {
39 "accounts": [
40 "40702810800000000001",
41 "40702810800000000004",
42 "40702810800000000007"
43 ]
44 },
45 "callbackUri": "https://webhook.partner.ru/api/v1/webhook-events",
46 "version": 1,
47 "statusDescriptions": [
48 {
49 "cause": "Revocation of agreement",
50 "description": "The webhook is disabled due to the agreement being revoked in Alfa ID"
51 },
52 {
53 "cause": "Disabled by administrator",
54 "description": "Webhook disabled administrator"
55 }
56 ]
57 }
58 ]
59}Данные пагинации
Количество объектов на одной странице
Количество объектов в списке, которые необходимо пропустить
Общее количество записей
Массив объектов результата
Идентификатор записи
Объект/сущность, на которую партнёр API хочет подписаться. Принимает возможные значения:
- •
ul_transaction_default- получение выписки по счетам юридических лиц; - •
jp_sbp_incoming_payments- получение входящих платежей по СБП для юридических лиц
Статус вебхука. Принимает возможные значения:
- •
true- вебхук включён; - •
false- вебхук выключен
Хэш идентификатора организации
Дополнительные данные по вебхукам. Список полей зависит от события, на которое подписываетесь
Список счетов. Опциональное поле, заполняется при object: ul_transaction_default
URL партнёра, на который был отправлен вебхук
Версия формата получаемых данных. Для объектов ul_transaction_default, jp_sbp_incoming_payments возможное значение - 1
Описание статуса выключения вебхука
Причина выключения вебхука
Описание причины
1{
2 "pagination": {
3 "offset": 45,
4 "limit": 10,
5 "totalCount": 100
6 },
7 "items": [
8 {
9 "id": "f9f8c674-7a2a-4297-bdb8-ddd3013de3a3",
10 "object": "ul_transaction_default",
11 "enabled": true,
12 "organizationIdHash": "ff22df927f36344155f7075fae297541fcfca87e3dabef5aa9c951a21c4f072c",
13 "data": {
14 "accounts": [
15 "40702810800000000001",
16 "40702810800000000004",
17 "40702810800000000007"
18 ]
19 },
20 "callbackUri": "https://webhook.partner.ru/api/v1/webhook-events",
21 "version": 1,
22 "statusDescriptions": [
23 {
24 "cause": "Revocation of agreement",
25 "description": "The webhook is disabled due to the agreement being revoked in Alfa ID"
26 },
27 {
28 "cause": "Disabled by administrator",
29 "description": "Webhook disabled administrator"
30 }
31 ]
32 },
33 {
34 "id": "f9f8c674-7a2a-4297-bdb8-ddd3013de222",
35 "object": "ul_transaction_default",
36 "enabled": true,
37 "organizationIdHash": "ff22df927f36344155f7075fae297541fcfca87e3dabef5aa9c951a21c4f072c",
38 "data": {
39 "accounts": [
40 "40702810800000000001",
41 "40702810800000000004",
42 "40702810800000000007"
43 ]
44 },
45 "callbackUri": "https://webhook.partner.ru/api/v1/webhook-events",
46 "version": 1,
47 "statusDescriptions": [
48 {
49 "cause": "Revocation of agreement",
50 "description": "The webhook is disabled due to the agreement being revoked in Alfa ID"
51 },
52 {
53 "cause": "Disabled by administrator",
54 "description": "Webhook disabled administrator"
55 }
56 ]
57 }
58 ]
59}Код ошибки. Принимает возможные значения:
- •
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}Значения параметров ошибок могут изменяться. Рекомендуем предусмотреть стандартную обработку ошибок, не описанных в текущей версии документации.