Инициировать платеж
https://securepay.tinkoff.ru/v2/Init
Метод инициирует платеж.
Запрос
Request body schema application/json
Required
TerminalKey
String
Requirements: <= 20 characters
Идентификатор терминала. Выдается мерчанту в Т‑Бизнес при заведении терминала.
Required
Amount
Number
Requirements: <= 10 characters
- Сумма в копейках. Например, 3 руб. 12коп. — это число 312.
- Параметр должен быть равен сумме всех параметров
Amount
, переданных в объектеItems
. - Минимальная сумма операции с помощью СБП составляет 10 руб.
Required
OrderId
String
Requirements: <= 36 characters
Идентификатор заказа в системе мерчанта. Должен быть уникальным для каждой операции.
Required
Token
String
Подпись запроса. Формируется по инструкции.
Description
String
Requirements: <= 140 characters
Описание заказа. Значение параметра будет отображено на платежной форме.
Для привязки и одновременной оплаты по СБП поле обязательное. При оплате через СБП эта информация отобразится в мобильном банке покупателя.
CustomerKey
String
Requirements: <= 36 characters
Идентификатор клиента в системе мерчанта.
- Параметр обязательный, если передан параметр
Recurrent
. - Если был передан в запросе, в нотификации будет указан
CustomerKey
и егоCardId
. Подробнее — в методе Получить список карт клиента. - Нужен для сохранения карт на платежной форме — платежи в один клик.
- Необязателен при рекуррентных платежах через СБП.
Recurrent
String
Requirements: <= 1 characters
Признак родительского рекуррентного платежа. Параметр обязательный для регистрации автоплатежа.
Если передается и установлен в Y
, регистрирует платеж как рекуррентный.
В этом случае после оплаты в нотификации на AUTHORIZED
будет передан параметр RebillId
для использования в методе Автоплатеж.
Для привязки и одновременной оплаты по CБП передавайте Y
.
Значение зависит от параметров OperationInitiatorType
и Recurrent
в методе Инициировать платеж.
PayType
String
Requirements: [O
, T
]
Определяет тип проведения платежа — двухстадийная или одностадийная оплата:
O
— одностадийная оплата;T
— двухстадийная оплата.
Если параметр передан — используется его значение, если нет — значение из настроек терминала.
Language
String
Requirements: <= 2 characters
Язык платежной формы:
ru
— русский;en
— английский.
Если параметр не передан, форма откроется на русском языке.
NotificationURL
String<uri>
URL на веб-сайте мерчанта, куда будет отправлен POST-запрос о статусе выполнения вызываемых методов — настраивается
в личном кабинете.
Если параметр:
- передан — используется его значение;
- не передан — значение из настроек терминала.
Подробнее в разделе Уведомления об операциях.
SuccessURL
String<uri>
URL на веб-сайте мерчанта, куда будет
переведен клиент в случае успешной оплаты — настраивается в личном кабинете.
Если параметр:
- передан — используется его значение;
- не передан — значение из настроек терминала.
FailURL
String<uri>
URL на веб-сайте мерчанта, куда будет
переведен клиент в случае неуспешной
оплаты — настраивается в личном кабинете.
Если параметр:
- передан — используется его значение;
- не передан — значение из настроек терминала.
RedirectDueDate
<date-time>
Срок жизни ссылки или динамического QR-кода
СБП, если выбран этот способ оплаты.
Если текущая дата превышает дату, которая передана в
этом параметре, ссылка для оплаты или
возможность платежа по QR-коду становятся
недоступными и платеж выполнить нельзя.
- Минимальное значение — 1 минута от текущей даты.
- Максимальное значение — 90 дней от текущей даты.
- Формат даты —
YYYY-MM-DDTHH24:MI:SS+GMT
.
Пример даты: 2016-08-31T12:28:00+03:00.
Если параметр не передан, принимает значение 24 часа для платежа
и 30 дней для счета.
Выставление счета через личный кабинет
Если параметр RedirectDueDate
не был передан, проверяется настроечный параметр
платежного терминала REDIRECT_TIMEOUT
, который может содержать значение срока жизни ссылки в
часах.
Если его значение:
- больше нуля — оно будет установлено в качестве срока жизни ссылки или динамического QR-кода;
- меньше нуля — устанавливается значение по умолчанию: 1440 мин. (1 сутки).
DATA
Object
JSON-объект, который позволяет передавать дополнительные параметры по операции и задавать определенные настройки в
формате ключ:значение
.
Максимальная длина для каждого передаваемого параметра:
- ключ — 20 знаков;
- значение — 100 знаков.
Максимальное количество пар ключ:значение
— 20.
Если ключи или значения содержат в себе специальные символы, получившееся значение должно быть закодировано функцией urlencode
.
- Параметр
notificationEnableSource
позволяет отправлять нотификации, только если Source платежа входит в перечень
указанных в параметре — он также есть в параметрах сессии. Возможные значения — T‑Pay
, sbpqr
. Пример: notificationEnableSource=TinkoffPay
DATA
Object
JSON-объект, который позволяет передавать дополнительные параметры по операции и задавать определенные настройки в
формате ключ:значение
.
Максимальная длина для каждого передаваемого параметра:
- ключ — 20 знаков;
- значение — 100 знаков.
Максимальное количество пар ключ:значение
— 20.
Если ключи или значения содержат в себе специальные символы, получившееся значение должно быть закодировано функцией urlencode
.
- Параметр
notificationEnableSource
позволяет отправлять нотификации, только если Source платежа входит в перечень указанных в параметре — он также есть в параметрах сессии. Возможные значения —T‑Pay
,sbpqr
. Пример:notificationEnableSource=TinkoffPay
Receipt
Object
JSON-объект с данными чека. Параметр обязательный, если подключена онлайн-касса.
Receipt
Object
JSON-объект с данными чека. Параметр обязательный, если подключена онлайн-касса.
Shops
Array of objects ()
JSON-объект с данными маркетплейса. Параметр обязательный для маркетплейсов.
Shops
Array of objects ()
JSON-объект с данными маркетплейса. Параметр обязательный для маркетплейсов.
Descriptor
String
Динамический дескриптор точки.
Ответ
Это полезный материал?