forked from apoloz/alfa-bank-sdk
4.5 KiB
4.5 KiB
# Удаление вебхука
Теги:
B2B B2C H2H
## Эндпоинты
| Среда | Метод и URL |
| :--- | :--- |
| Песочница | DELETE https://sandbox.alfabank.ru/api/v1/webhooks/{id} |
| Пром | DELETE https://baas.alfabank.ru/api/v1/webhooks/{id} |
### Scope
scope события, на которое подписываетесь, с допустимыми значениями можно посмотреть здесь.
Параметры запроса
HEADERS
| Атрибут | Тип | Обязательность | Описание |
|---|---|---|---|
| Authorization | string | required | Bearer {access_token}, полученный по Authorization Code Flow / Authorization Code Flow H2H |
| Accept | string | required | application/json |
| Content-Type | string | optional | application/json |
PATH
| Атрибут | Тип | Обязательность | Описание |
|---|---|---|---|
| id | uuid | required | Идентификатор вебхука |
QUERY
| Атрибут | Тип | Обязательность | Описание |
|---|---|---|---|
| object | string | required | Объект/сущность, на который партнёр API хочет подписаться. Возможные значения: • ul_transaction_default — получение выписки;• jp_sbp_incoming_payments — получение входящих платежей. |
Пример запроса
curl -X DELETE 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 — OK
Нет тела ответа.
400 — Bad Request
| Атрибут | Тип | Обязательность | Описание |
|---|---|---|---|
| error | string | required | Код ошибки: invalid_request — неверные входные параметры запроса |
| error_description | string | optional | Описание ошибки |
401 — Unauthorized
| Атрибут | Тип | Обязательность | Описание |
|---|---|---|---|
| error | string | required | Код ошибки: invalid_token — предоставленный токен просрочен, отозван или недействителен |
| error_description | string | optional | Описание ошибки |
403 — Forbidden
| Атрибут | Тип | Обязательность | Описание |
|---|---|---|---|
| error | string | required | Код ошибки: • insufficient_scope — нет прав (настройки scope);• insufficient_privileges — вебхуки выключены для клиента или сервиса |
| error_description | string | optional | Описание ошибки |
404 — Not Found
| Атрибут | Тип | Обязательность | Описание |
|---|---|---|---|
| error | string | required | Код ошибки: unknown_route — эндпоинт не найден или неактивен |
| error_description | string | optional | Описание ошибки |
429 — Too Many Requests
Нет тела ответа.
500 — Internal Server Error
| Атрибут | Тип | Обязательность | Описание |
|---|---|---|---|
| error | string | required | Код ошибки: internal_error — внутренняя ошибка сервиса |
| error_description | string | optional | Описание ошибки |
503 — Service Unavailable
Нет тела ответа.
Примечание: Значения параметров ошибок могут изменяться. Рекомендуем предусмотреть стандартную обработку ошибок, не описанных в данной документации.
Навигация: ← Редактирование вебхука | Получение вебхука →