B2BB2CH2H

Получение вебхука

Пром GET https://baas.alfabank.ru/api/v1/webhooks/{id}

Песочница GET https://sandbox.alfabank.ru/api/v1/webhooks/{id}

Scope

scope события, на которое подписываетесь.

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

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

HEADERS
Атрибут
Описание
Authorization
stringrequired

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

Accept
stringrequired

application/json

Content-Type
stringoptional

application/json

PATH
Атрибут
Описание
id
uuidrequired

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

QUERY
Атрибут
Описание
object
stringrequired

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

Пример запроса
curl -X GET https://baas.alfabank.ru/api/v1/webhooks/f9f8c674-7a2a-4297-bdb8-ddd3013de3a3?object=ul_transaction_default \
  -H 'Authorization: Bearer {token}' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

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

Пример ответа 200 (ОК)
{
  "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
uuidoptional

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

object
stringoptional

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

enabled
booleanoptional

Статус вебхука. Принимает возможные значения: true - Вебхук включен; false - Вебхук выключен

objectoptional

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

accounts
array of stringoptional

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

callbackUri
stringoptional

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

version
integeroptional

Версия формата получаемых данных. Для object: ul_transaction_default доступное значение - 1

Пример ответа 200 (ОК)
{
  "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
}
error
stringrequired

Код ошибки. Принимает возможные значения: invalid_request - Неверные входные параметры запроса

error_description
stringoptional

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

Пример ошибки 400 (Bad Request)
{
  "error": "invalid_request",
  "error_description": "Authorization header is not present in request headers"
}
error
stringrequired

Код ошибки. Принимает возможные значения: invalid_token - Предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам

error_description
stringoptional

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

Пример ошибки 401 (Unauthorized)
{
  "error": "invalid_token",
  "error_description": "The access token provided is expired, revoked, malformed, or invalid for other reasons"
}
error
stringrequired

Код ошибки. Принимает возможные значения: insufficient_scope - У пользователя нет прав на использование запрашиваемого сервиса, доступ к которому не предусмотрен настройками scope

error_description
stringoptional

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

Пример ошибки 403 (Forbidden)
{
  "error": "insufficient_scope",
  "error_description": "The request requires higher privileges than provided by the access token"
}
error
stringrequired

Код ошибки. Принимает возможные значения: unknown_route - Эндпоинт не найден или неактивен

error_description
stringoptional

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

Пример ошибки 404 (Not Found)
{
  "error": "unknown_route",
  "error_description": "Route is not found or not active"
}
Нет тела ответа
error
stringrequired

Код ошибки. Принимает возможные значения: internal_error - Внутренняя ошибка сервиса при выполнении обработки запроса

error_description
stringoptional

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

Пример ошибки 500 (Internal Server Error)
{
  "error": "internal_error",
  "error_description": "Internal server error"
}
Нет тела ответа

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