Отменить платеж.

POST

https://secured-openapi.tbank.ru/api/v1/acq/payments/cancel

Отменить платеж.

Авторизация

Security

Bearer API Token

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

RPS

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

Scopes

acq/read-write

Запрос

Header parameters

Required

Idempotency-Key

String

Requirements: non-empty and <= 36 characters, Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Ключ идемпотентности, формат UUID. Время жизни ключа — 24 часа.

X-Request-Id

String<uuid>

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

Request body schema application/json

Required

terminalKey

String

Requirements: non-empty and <= 64 characters

Идентификатор терминала. Выдается мерчанту в Т‑Бизнес при заведении терминала.

String

Requirements: <= 30 characters

IP-адрес клиента.

Required

payment

Object

Параметры операции.

Required

paymentId

String

Requirements: non-empty and <= 36 characters

Идентификатор операции в системе Т-Бизнес.

amount

Number

Requirements: <= 10 characters

Сумма операции в копейках. Например, 3 руб. 12 коп. — это число 312. Если не передан, используется amount, переданный в методе /acq/payments/initiate. При отмене операции в статусе NEW поле amount игнорируется, даже если оно заполнено. Отмена производится на полную сумму.

paymentMethod

Object

Параметры операции, связанные со способом оплаты. Объект передается только для отмен по SBP.

name

String

Requirements: [CARD, BNPL, SBP, SBERPAY, TPAY]

Наименование способа оплаты:

CARD - Оплата картой
BNPL - Оплата Долями
SBP - Оплата по СБП
TPAY - Оплата через T-Pay
SBERPAY - Оплата через SberPay Обязательный параметр в методе /acq/payments/authorize для проведения дочернего рекуррентного платежа.

sbp

Object

Параметры метода оплаты SBP.

nspkBankId

String

Requirements: <= 12 characters

Код банка в классификации СБП, в который нужно выполнить возврат.

Ответ

200

Successful operation

400

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

401

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

403

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

422

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

429

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

500

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

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

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