Инициировать платеж

POST

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

Метод инициирует платеж.

Авторизация

Security

Bearer API Token

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

Запрос

Request body schema application/json

Required

terminalKey

String

Requirements: <= 64 characters

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

Required

payment

Object

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

Required

orderId

String

Requirements: <= 50 characters

Идентификатор заказа в системе мерчанта. Должен быть уникальным для каждой операции.

Required

amount

Number

Requirements: <= 10 characters

Сумма в копейках. Например, 3 руб. 12коп. — это число 312. Минимальная сумма операции через СБП составляет 10 руб.

Чтобы привязать карту, передавайте значение 0.

description

String

Requirements: non-empty and <= 250 characters

Описание заказа. Параметр обязательный при привязке и одновременной оплате через СБП. При оплате через СБП текст из этого параметра отобразится в мобильном банке клиента.

isRecurrent

Boolean

Признак рекуррентного платежа. Рекуррентный платеж можно создать при оплате картой, через СБП и T‑Pay.

operationInitiatorType

String

Requirements: [0, 1, 2, R, I, D, N]

Признак инициатора операции для платежа. Параметр обязательный при оплате картой.

Подробнее о признаке инициатора операции для обычного платежа и по сохраненным реквизитам

fingerprint

Object

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

deviceChannel

String

Requirements: [APP, MOBILE_BRW, DESKTOP_BRW]

Канал устройства.

Поддерживаются следующие каналы:

APP — Application;
MOBILE_BRW — Mobile Browser;
DESKTOP_BRW — Desktop Browser.

Параметр обязательный для способов оплаты TPAY и SBERPAY.

Чтобы подключить 3DS второй версии для канала APP, обратитесь в поддержку.

String

Requirements: <= 39 characters

IP-адрес клиента в формате IPv4 и IPv6. DS платежной системы требует передавать IPv6 в полном формате — 8 групп по 4 символа.

language

String

Requirements: <= 2 characters

Язык браузера в формате IETF BCP47. Рекомендуем получать значение в браузере из глобального объекта navigator — navigator.language.

timezone

String

Requirements: <= 4 characters

Часовой пояс пользователя в минутах. Рекомендуем получать значение в браузере через вызов метода getTimezoneOffset().

screenHeight

String

Requirements: <= 4 characters

Высота экрана в пикселях. Рекомендуем получать значение в браузере из глобального объекта screen — screen.height.

screenWidth

String

Requirements: <= 4 characters

Ширина экрана в пикселях. Рекомендуем получать значение в браузере из глобального объекта screen — screen.width.

colorDepth

String

Requirements: <= 2 characters, [1, 4, 8, 15, 16, 24, 32, 48]

Default: 48

Глубина цвета в битах. Рекомендуем получать значение в браузере из глобального объекта screen — screen.colorDepth.

Значение по умолчанию — 48.

isJavaEnabled

Boolean

Requirements: [true, false]

Поддержка Java браузером пользователя.

String

Requirements: <= 1024 characters, [iOS, Android, macOS, Windows, Linux]

Операционная система устройства клиента, на котором открыта платежная форма. Параметр обязательный для способов оплаты TPAY и SBERPAY.

isWebView

Boolean

Requirements: [true, false]

Признак использования WebView — встроенного в приложение браузера. Параметр обязательный для способов оплаты TPAY и SBERPAY.

browser

String

Requirements: <= 255 characters, [Chrome, Firefox, JivoMobile, Microsoft Edge, Miui, Opera, Safari, Samsung, WebKit, WeChat, Yandex]

Браузер клиента. Параметр обязательный для способов оплаты TPAY и SBERPAY.

paymentMethod

Object

Список параметров.

name

String

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

Способ оплаты. Параметр обязательный для способов оплаты TPAY, SBERPAY и при проведении рекуррентного платежа.

Возможные значения:

SBP — оплата через СБП;
TPAY — оплата через T‑Pay;
SBERPAY — оплата через SberPay;
CARD — оплата картой;
BNPL — оплата «Долями».

customer

Object

Информация о клиенте.

customerKey

String

Requirements: non-empty and <= 255 characters

Идентификатор клиента в системе мерчанта. Параметр обязательный, если:

isRecurrent=true и name равен CARD или TPAY – для создания рекуррентного платежа;
amount=0 и paymentMethod=CARD – для привязки карты.

phone

String

Requirements: >= 7 characters and <= 20 characters, Value must match regular expression ^\+?[0-9]*$

Номер телефона клиента в международном формате. Должен содержать от 7 до 20 символов. В значении параметра разрешены только цифры, исключение — первый символ может быть +.

Параметр обязательный для МСС 4814.

String<email>

Requirements: non-empty and <= 100 characters

Электронная почта клиента.

additionalProperties

Object

JSON-объект, который позволяет передавать дополнительные параметры по операции и задавать определенные настройки в формате ключ:значение. Максимальная длина для каждого передаваемого параметра:

ключ — 20 знаков;
значение — 100 знаков.

Максимальное количество пар ключ:значение — 20.

property_name*

String (additional property)

Ответ

200

400

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

401

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

403

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

422

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

429

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

500

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

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

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