Отменить обработку документов в ESOP (V2)

/api/v2/esop/document/cancel

POST

https://secured-openapi.tbank.ru/api/v2/esop/document/cancel

Метод принимает список документов по заявкам на выплату в программе ESOP, которые нужно отменить, и возвращает список отмененных по заявкам документов.

Авторизация

Security

Bearer API Token

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

RPS

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

Scopes

ESOP → Работа с API системы ESOP

Запрос

Header parameters

X-Request-Id

String<uuid>

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

Required

idempotency-key

String

Requirements: non-empty and <= 64 characters

Ключ идемпотентности. Подробнее.

Request body schema application/json

Required

documents

Array of objects ()

Requirements: <= 2000 items

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

Required

id

String<uuid>

Идентификатор документа в системе ESOP.

Required

payoutOrderId

String<uuid>

Идентификатор заявки на выплату в системе ESOP.

Ответ

200

OK

400

Некорректный запрос

401

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

403

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

422

Ошибка при обработке данных

429

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

500

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

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

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

Loading...