Редактирование вебхука

Песочница

PUT https://sandbox.alfabank.ru/api/v2/webhooks/{id}

Пром

PUT https://baas.alfabank.ru/api/v2/webhooks/{id}

Scope

scope события, на которое подписываетесь, с допустимыми значениями, которые можно посмотреть здесь.

Параметры запроса

HEADERS

Атрибут

Описание

Authorization

stringrequired

Bearer {access_token}, полученный по Authorization Code Flow / Authorization Code Flow H2H

stringrequired

application/json

Content-Type

stringrequired

application/json

PATH

Атрибут

Описание

uuidrequired

Идентификатор вебхука

BODY

Атрибут

Описание

object

stringrequired

Объект/сущность, на которую партнёр API хочет подписаться. Возможные значения:

•
ul_transaction_default - получение выписки по счетам юридических лиц;
•
jp_sbp_incoming_payments - получение входящих платежей по СБП для юридических лиц

enabled

booleanoptional

Статус вебхука. Возможные значения:

•
true - вебхук включён;
•
false - вебхук выключен

organizationIdHash

stringoptional

Хэш идентификатора организации

objectoptional

Дополнительные данные по вебхукам. Список полей зависит от события, на которое подписываетесь. Для объекта jp_sbp_incoming_payments данное поле не заполняется

accounts

array of stringoptional

Список счетов. Опционально поле. При object: ul_transaction_default является обязательным, необходимо передавать в списке все счета, а не только новые. При передаче пустого массива будет создан вебхук на все счета

callbackUri

stringoptional

URL партнёра, на который будет отправлен вебхук. Редактировать можно только path. Менять host не допускается

version

integeroptional

Версия формата получаемых данных. Для объектов ul_transaction_default, jp_sbp_incoming_payments возможное значение - 1

Пример запроса

1curl -X PUT https://baas.alfabank.ru/api/v2/webhooks/f9f8c674-7a2a-4297-bdb8-ddd3013de3a3 \
2  -H 'Authorization: Bearer {token}' \
3  -H 'Accept: application/json' \
4  -H 'Content-Type: application/json' \
5  -d '{
6    {
7      "object": "ul_transaction_default",
8      "enabled": true,
9      "data": {
10        "accounts": [
11          "40802810401300015422",
12          "40802810401300015422"
13        ]
14      },
15      "callbackUri": "https://webhook.partner.ru/api/v1/webhook-events",
16      "version": 1
17    }
18  }'

Параметры ответа

Пример ответа 200 (ОК)

1{
2  "id": "f9f8c674-7a2a-4297-bdb8-ddd3013de3a3",
3  "object": "ul_transaction_default",
4  "enabled": true,
5  "organizationIdHash": "ff22df927f36344155f7075fae297541fcfca87e3dabef5aa9c951a21c4f072c",
6  "data": {
7    "accounts": [
8      "40702810800000000001",
9      "40702810800000000004",
10      "40702810800000000007"
11    ]
12  },
13  "callbackUri": "https://webhook.partner.ru/api/v1/webhook-events",
14  "version": 1,
15  "statusDescriptions": [
16    {
17      "cause": "Revocation of agreement",
18      "description": "The webhook is disabled due to the agreement being revoked in Alfa ID"
19    },
20    {
21      "cause": "Disabled by administrator",
22      "description": "Webhook disabled by administrator"
23    }
24  ]
25}

uuidoptional

Идентификатор записи

object

stringoptional

Объект/сущность, на которую партнёр API хочет подписаться. Принимает возможные значения:

•
ul_transaction_default - получение выписки по счетам юридических лиц;
•
jp_sbp_incoming_payments - получение входящих платежей по СБП для юридических лиц

enabled

booleanoptional

Статус вебхука. Принимает возможные значения:

•
true - вебхук включён;
•
false - вебхук выключен

objectoptional

accounts

array of stringoptional

Список счетов. Опционально поле, заполняется при object: ul_transaction_default

callbackUri

stringoptional

URL партнёра, на который был отправлен вебхук

version

integeroptional

Версия формата получаемых данных. Для объектов ul_transaction_default, jp_sbp_incoming_payments возможное значение - 1

objectoptional

Описание статуса выключения вебхука

cause

stringoptional

Причина выключения вебхука

description

stringoptional

Описание причины

Пример ответа 200 (ОК)

1{
2  "id": "f9f8c674-7a2a-4297-bdb8-ddd3013de3a3",
3  "object": "ul_transaction_default",
4  "enabled": true,
5  "organizationIdHash": "ff22df927f36344155f7075fae297541fcfca87e3dabef5aa9c951a21c4f072c",
6  "data": {
7    "accounts": [
8      "40702810800000000001",
9      "40702810800000000004",
10      "40702810800000000007"
11    ]
12  },
13  "callbackUri": "https://webhook.partner.ru/api/v1/webhook-events",
14  "version": 1,
15  "statusDescriptions": [
16    {
17      "cause": "Revocation of agreement",
18      "description": "The webhook is disabled due to the agreement being revoked in Alfa ID"
19    },
20    {
21      "cause": "Disabled by administrator",
22      "description": "Webhook disabled by administrator"
23    }
24  ]
25}

error

stringrequired

Код ошибки. Принимает возможные значения:

•
invalid_request - неверные входные параметры запроса

error_description

stringoptional

Описание ошибки

Пример ошибки 400 (Bad Request)

1{
2  "error": "invalid_request",
3  "error_description": "Authorization header is not present in request headers"
4}

error

stringrequired

Код ошибки. Принимает возможные значения:

•
invalid_token - предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам

error_description

stringoptional

Описание ошибки

Пример ошибки 401 (Unauthorized)

1{
2  "error": "invalid_token",
3  "error_description": "The access token provided is expired, revoked, malformed, or invalid for other reasons"
4}

error

stringrequired

Код ошибки. Принимает возможные значения:

•
insufficient_scope - у пользователя нет прав на использование запрашиваемого сервиса, доступ к которому не предусмотрен настройками scope;
•
insufficient_privileges - отсутствует доступ к URL партнёра, указанному в callbackUri, или настройки вебхуков выключены для партнёра или сервиса в целом

error_description

stringoptional

Описание ошибки

Пример ошибки 403 (Forbidden)

1{
2  "error": "insufficient_scope",
3  "error_description": "The request requires higher privileges than provided by the access token"
4}

error

stringrequired

Код ошибки. Принимает возможные значения:

•
unknown_route - эндпоинт не найден или неактивен

error_description

stringoptional

Описание ошибки

Пример ошибки 404 (Not Found)

1{
2  "error": "unknown_route",
3  "error_description": "Route is not found or not active"
4}

Нет тела ответа

error

stringrequired

Код ошибки. Принимает возможные значения:

•
internal_error - внутренняя ошибка сервиса при выполнении обработки запроса

error_description

stringoptional

Описание ошибки

Пример ошибки 500 (Internal Server Error)

1{
2  "error": "internal_error",
3  "error_description": "Internal server error"
4}

Нет тела ответа

Значения параметров ошибок могут изменяться. Рекомендуем предусмотреть стандартную обработку ошибок, не описанных в текущей версии документации.