Инициировать операцию.

/api/v1/acq/payments/initiate

POST

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

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

Авторизация

Security

Bearer API Token

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

RPS

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

Scopes

acq/read-write

Запрос

Header parameters

X-Request-Id

String<uuid>

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

Request body schema application/json

Required

terminalKey

String

Requirements: non-empty and <= 64 characters

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

Required

payment

Object

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

Required

orderId

String

Requirements: non-empty and <= 50 characters

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

Required

amount

Number

Requirements: non-empty and <= 10 characters

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

description

String

Requirements: non-empty and <= 250 characters

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

fingerprint

Object

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

deviceChannel

String

Requirements: [APP, MOBILE_BRW, DESKTOP_BRW]

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

• "APP" (Application)
• "MOBILE_BRW" (Mobile Browser)
• "DESKTOP_BRW" (Desktop Browser) Обязательный параметр в методе /acq/payments/authorize для 3DS второй версии и в методе /acq/payments/initiate для способов оплаты TPAY, SBERPAY. Для подключения 3DS второй версии канала "APP" обратитесь в поддержку.

ip

String

Requirements: <= 30 characters

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

language

String

Requirements: <= 2 characters

Язык браузера в формате IETF BCP47. Рекомендуем получать значение в браузере из глобального объекта navigator — navigator.language. Обязательный параметр в методе /acq/payments/authorize для deviceChannel: "MOBILE_BRW" И "DESKTOP_BRW".

timezone

String

Requirements: <= 4 characters

Time-zone пользователя в минутах. Рекомендуем получать значение в браузере через вызов метода getTimezoneOffset(). Обязательный параметр в методе /acq/payments/authorize для deviceChannel: "MOBILE_BRW" И "DESKTOP_BRW".

screenHeight

String

Requirements: <= 4 characters

Высота экрана в пикселях. Рекомендуем получать значение в браузере из глобального объекта screen — screen.height. Обязательный параметр в методе /acq/payments/authorize для deviceChannel: "MOBILE_BRW" И "DESKTOP_BRW".

screenWidth

String

Requirements: <= 4 characters

Ширина экрана в пикселях. Рекомендуем получать значение в браузере из глобального объекта screen — screen.width. Обязательный параметр в методе /acq/payments/authorize для deviceChannel: "MOBILE_BRW" И "DESKTOP_BRW".

colorDepth

String

Requirements: <= 2 characters

Default: 48

Глубина цвета в битах. Допустимые значения — 1/4/8/15/16/24/32/48. Рекомендуем получать значение в браузере из глобального объекта screen — screen.colorDepth. Обязательный параметр в методе /acq/payments/authorize для deviceChannel: "MOBILE_BRW" И "DESKTOP_BRW".

isJavaEnabled

Boolean

Поддерживает ли браузер пользователя Java. Обязательный параметр в методе /acq/payments/authorize для deviceChannel: "MOBILE_BRW" И "DESKTOP_BRW". Возможные значения:

• true,
• false.

os

String

Requirements: <= 1024 characters

Операционная система устройства клиента, на которой открыта платежная форма. Возможные значения: iOS, Android, macOS, Windows, Linux. Обязательный параметр в методе /acq/payments/initiate для способов оплаты TPAY, SBERPAY.

isWebView

Boolean

Признак использования WebView. WebView — это встроенный в приложение браузер. true — WebView используется, false — WebView не используется. Обязательный параметр в методе /acq/payments/initiate для способов оплаты TPAY,SBERPAY.

browser

String

Requirements: <= 255 characters

Браузер, используемый клиентом. Возможные значения: Chrome, Firefox, JivoMobile, Microsoft Edge, Miui, Opera, Safari, Samsung, WebKit, WeChat, Yandex. Обязательный параметр в методе /acq/payments/initiate для способов оплаты TPAY,SBERPAY.

paymentMethod

Object

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

name

String

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

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

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

isRecurrent

Boolean

Признак рекуррентного платежа. Рекуррентный платеж можно создать для способов оплаты CARD/SBP/TPAY.

operationInitiatorType

String

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

Тип инициатора операции для рекуррентного платежа. Обязательное поле при создании рекуррентного родительского платежа для способа оплаты CARD. 0 — Оплата без сохранения реквизитов карты для последующего использования. Сценарий «0 — CIT, Credential-Not-Captured». 1 — Используется, если мерчант сохраняет карту. Сценарий «1 — Consumer-Initiated, Credential-Captured». 2 — Операция по ранее сохранённой карте, инициирована клиентом. Сценарий «2 — Consumer-Initiated, Credential-on-File». R — Повторяющаяся операция по сохранённой карте без графика. Является Merchant Initiated сценарием — «R = Merchant-Initiated, Credential-on-File, Recurring». I — Повторяющаяся операция по сохраненной карте в соответствии с графиком платежей для погашения кредита. Является Merchant Initiated сценарием — «I = Merchant-Initiated, Credential-on-File, Installment». D - Операция выполняемая однократно или несколько раз в течение ограниченного периода времени. Является Merchant Initiated сценарием. Merchant-Initiated, Credential-on-File, Delayed-Charge. N - Операция выполняемая однократно или несколько раз в течение ограниченного периода времени. Является Merchant Initiated сценарием. Merchant-Initiated, Credential-on-File, No-Show.

customer

Object

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

customerKey

String

Requirements: non-empty and <= 255 characters

Идентификатор клиента в системе мерчанта. Обязателен, если атрибут payment.paymentMethod.isRecurrent=true и payment.paymentMethod равен CARD или TPAY.

phone

String

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

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

email

String<email>

Requirements: non-empty and <= 100 characters

Email клиента.

additionalProperties

Object

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

property name*

Object

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

Ответ

200

Successful operation

400

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

401

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

403

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

422

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

429

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

500

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

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

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

Loading...