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

/openapi/api/v1/acq/payments/cancel

POST

https://acq.t-tech.team/openapi/api/v1/acq/payments/cancel

Метод отменяет платеж.

В поле scope у токена должен быть доступ вида acq/payment.

Подробнее об отмене платежа

Авторизация

Security

Bearer API Token

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

Запрос

Header parameters

Required

Idempotency-Key

String

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

Request body schema application/json

Required

terminalKey

String

Requirements: <= 64 characters

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

ip

String

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

Required

payment

Object

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

Required

paymentId

String

Requirements: <= 36 characters

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

amount

Number

Requirements: <= 10 characters

Сумма операции в копейках. Например, 3 руб. 12 коп. — это число 312.

Если параметр не передан, используется amount, переданный в методе Инициировать платеж. При отмене операции в статусе NEW поле amount игнорируется, отмена производится на полную сумму.

paymentMethod

Object

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

name

String

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

Способ оплаты.

sbp

Object

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

nspkBankId

String

Requirements: <= 12 characters

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

Ответ

200

OK

400

Некорректный запрос — неверные параметры, невалидный JSON и так далее

401

Неавторизованный запрос — нет токена или токен неверный

403

Доступ запрещен — недостаточно прав, нет нужного scope

422

Ошибка валидации данных запроса

429

Превышен лимит запросов

500

Внутренняя ошибка сервера

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

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

Loading...