B2BB2CH2H

Удаление вебхука

Песочница
DELETE https://sandbox.alfabank.ru/api/v1/webhooks/{id}
Пром
DELETE https://baas.alfabank.ru/api/v1/webhooks/{id}
Scope

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

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

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

application/json

Content-Type
stringoptional

application/json

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

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

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

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

  • •
    ul_transaction_default - получение выписки по счетам юридических лиц;
  • •
    jp_sbp_incoming_payments - получение входящих платежей по СБП для юридических лиц
Пример запроса 
1curl -X DELETE https://baas.alfabank.ru/api/v1/webhooks/f9f8c674-7a2a-4297-bdb8-ddd3013de3a3?object=ul_transaction_default \
2  -H 'Authorization: Bearer {token}' \
3  -H 'Accept: application/json' \
4  -H 'Content-Type: application/json'

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

1Нет тела ответа
Нет тела ответа
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 - предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам. При истечении срока жизни токена необходимо обновить его с помощью refresh_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 - при запросе кода авторизации не были переданы все необходимые scopes. Необходимо переподписать договор согласия, повторно отправив запрос на получение кода авторизации с указанием всех доступных scopes и параметра prompt=consent;
  • •
    insufficient_privileges - настройки вебхуков выключены для клиента или сервиса в целом
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}
Нет тела ответа

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

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