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

POST

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

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

В поле 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

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

Required

payment

Object

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

Required

orderId

String

Requirements: <= 50 characters

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

Required

amount

Number

Requirements: <= 10 characters

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

description

String

Requirements: <= 250 characters

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

fingerprint

Object

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

deviceChannel

String

Requirements: [APP, BRW]

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

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

APP (Application);
BRW (Browser).

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

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

String

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

language

String

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

Параметр обязательный, если в методе Подтвердить платеж передается "deviceChannel":"BRW".

timezone

String

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

screenHeight

String

Высота экрана в пикселях. Рекомендуем получать значение в браузере из глобального объекта screen — screen.height. Параметр обязательный, если в методе Подтвердить платеж передается "deviceChannel":"BRW".

screenWidth

String

Ширина экрана в пикселях. Рекомендуем получать значение в браузере из глобального объекта screen — screen.width. Параметр обязательный, если в методе Подтвердить платеж передается "deviceChannel":"BRW".

colorDepth

String

Requirements: [1, 4, 8, 15, 16, 24, 32, 48]

Default: 48

Глубина цвета в битах. Рекомендуем получать значение в браузере из глобального объекта screen — screen.colorDepth. Параметр обязательный, если в методе Подтвердить платеж передается "deviceChannel":"BRW".

Допустимые значения:

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

isJavaEnabled

Boolean

Requirements: [true, false]

Поддержка Java браузером пользователя. Параметр обязательный, если в методе Подтвердить платеж передается "deviceChannel":"BRW".

deviceId

String

Requirements: <= 1024 characters

Идентификатор устройства клиента.

referrer_url

String

Requirements: <= 1024 characters

URL-адрес, с которого был переход на платежную форму.

String

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

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

userAgent

String

Requirements: <= 1024 characters

UserAgent браузера, в котором будет открыта платежная форма.

cookieId

String

Requirements: <= 1024 characters

Идентификатор сессии/cookie клиента.

webView

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 — оплата «Долями».

isRecurrent

Boolean

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

operationInitiatorType

String

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

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

Подробнее о признаке инициатора операции

customer

Object

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

Required

customerKey

String

Requirements: <= 255 characters

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

phone

String

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

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

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

String<email>

Requirements: <= 100 characters

Email клиента.

additionalProperties

Object

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

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

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

property name*

Object

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

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

Ответ

200

400

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

401

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

403

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

422

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

429

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

500

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

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

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