Отменить заявку

/api/v1/consult/requests/comment/workflow/cancel

POST

https://secured-openapi.tbank.ru/api/v1/consult/requests/comment/workflow/cancel

Метод переводит заявку типа «Комментарий» в статус Cancelled.

Если заявка не будет найдена или ее нельзя перевести в этот статус, вернется ошибка. Если заявка уже в статусе Cancelled, метод вернет данные в 200 ответе. Если актуальная версия заявки не совпадает с версией, переданной в HTTP-заголовке, вернется 422 ошибка.

Авторизация

Security

Bearer API Token

MTLS-сертификат

RPS

Ограничение — 10 запросов в секунду

Scopes

Налоговые консультации → Налоговые консультации - Изменить статус заявки

Header parameters

Required

If-Match

String

Requirements: <= 50 characters

Версия заявки в формате ETag, которая используется для оптимистичных блокировок. Другое название — casVersion.

X-Request-Id

String<uuid>

Уникальный идентификатор для трассировки запроса. Не влияет на логику исполнения запроса.

Query parameters

Required

taxRequestId

String<uuid>

Уникальный ID заявки.

Ответ

200

OK

400

Заявка не найдена

401

Ошибка аутентификации

403

Ошибка авторизации

422

Неверные данные заявки

429

Слишком много запросов

500

Ошибка сервера

Это полезный материал?

Обратиться в поддержку

Получить консультацию по интеграции

Интеграция

Прямая (H2H)Партнерская

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

cURL

Go

Java

NodeJs

PHP

Python

Content type

curl --location --request POST 'https://secured-openapi.tbank.ru/api/v1/consult/requests/comment/workflow/cancel' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <TOKEN>'\
--cert /path/to/cert.pem \
--key /path/to/key.key

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

200

400

401

403

422

429

500

Content type

application/json

{

"status":

"Cancelled",

"casVersion":

2

}