Инструкция для интеграции по API

Как происходит интеграция сервиса по API?

Подключение сервиса рассрочки и кредитования для покупателей состоит из трех этапов:

Ниже — пошаговые инструкции к каждому этапу.

Для интеграции нужен разработчик.

Как подготовиться к интеграции по API с банком?

Следуйте этой инструкции:

  1. Получите доступы и информацию для начала работы. Вот что нужно подготовить
  2. Определитесь, нужно ли вам автоподтверждение. Эта функция подойдет магазинам, которые всегда готовы выдать товар: им не нужно проверять наличие на складе и сверяться с системой учета. Остальным можно выбрать ручное подтверждение через личный кабинет агента или с помощью API.

    Автоподтверждение можно включить в личном кабинете руководителя:перейдите в «Кредитование в магазинах» → выберите магазин → «Редактировать». Поставьте галочку в блоке «Автоподтверждение интернет-заказов». Чтобы выключить автоподтверждение, просто уберите галочку.

  3. Если вы хотите отслеживать статус заказа, подпишитесь на уведомления — вебхуки. Для этого укажите URL‑адрес для вебхуков в личном кабинете руководителя.

    Если адрес не меняется, впишите его в личном кабинете: «Кредитование в магазинах» → выберите магазин → «Редактировать» → «Уведомления» → «Адрес для HTTP‑нотификаций». Поставьте галочку в чекбоксе.

    Если адрес меняется, передайте его при создании заявки через метод Create в поле webhookURL. На этот адрес вы будете получать уведомления от банка. Какие вебхуки используются в интеграции

  4. Укажите адрес конкретной страницы, на которую будете перенаправлять покупателей после заполнения заявки. Это можно сделать в личном кабинете руководителя.

    Можно выбрать разные сценарии для перенаправления покупателя:

    • при одобрении заявки покупатель увидит страницу, которую вы впишете в поле successURL;
    • при отказе от банка — страницу failURL;
    • при отмене заявки клиентом — страницу returnURL.

    Если таких страниц нет, ничего не вписывайте. Тогда после одобрения или отказа покупатель увидит главную страницу сайта, на котором оформлял заказ.

Подготовка к интеграции завершена. После этого можно переходить к следующему этапу.

Как провести интеграцию по API?

Прежде чем начинать продажи в рассрочку или кредит, проверьте работу сервиса на вашем сайте.

Тестирование:

  1. Создайте заявку. Используйте CreateDemo — метод для создания тестовых заявок. Какие методы API используют для интеграции

    Тестовые заявки не отправятся в банк, но вы сможете посмотреть, как работает заполнение и что увидят ваши покупатели. Для создания тестовой заявки используйте shopID, showcaseID и promocode, которые получили на этапе подготовки.

  2. Заполните заявку любыми данными, чтобы проверить работу формы и протестировать уведомления:
    • заполните заявку и получите одобрение — придет вебхук approved;
    • после одобрения заявку можно подписать любым СМС‑кодом — придет вебхук signed.
    • заполните заявку и получите отказ — придет вебхук rejected.
    Какие уведомления используют в интеграции
  3. Проверьте, как работает подтверждение заказа в тестовом режиме: «С автоподтверждением» и «Без автоподтверждения». Как работать с заявкой

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

Интеграция и старт продаж:

  1. Для создания реальных заявок используйте метод Create. Такие заявки отправятся в банк. Примеры запросов для интеграции API
  2. Для работы с методом Create используйте боевые параметры из личного кабинета руководителя. Какая информация нужна для начала работы
  3. Задать пароль для интеграции по API можно через личный кабинет руководителя: «Кредитование в магазинах» → выберите магазин → «Настройки API».
  4. Расскажите своим покупателям о новом способе оплаты — в рассрочку или кредит — любым удобным вам способом

Готово! Теперь можно переходить к работе с заявками.

Как работать с заявкой?

Следуйте этой инструкции:

  1. Покупатель оформляет заказ и по кнопке «Купить в кредит» переходит к заявке на рассрочку или кредит.
  2. Покупатель заполняет заявку. Банк в течение одной‑двух минут принимает решение и сообщает о нем покупателю: он увидит решение на той же странице с заявкой. Также решение по заявке придет покупателю по СМС или эл. почте, если он указывал адрес при оформлении заявки.
  3. В личном кабинете агента статус заявки поменяется на «Одобрено», если банк принял положительное решение, или «Отказано банком», если отрицательное. На эл. почту из личного кабинета руководителя придут нотификации approved или rejected. Какие уведомления используют в интеграции

    Если был указан URL для нотификаций, они продублируются и туда.

  4. Если заявку одобрили, покупатель подписывает договор доступным ему способом: по СМС или на встрече с представителем.
  5. Банк сообщит вам о подписании договора по эл. почте и в личном кабинете агента с помощью нотификации signed. Если вы хотите запросить информацию по заявке сами, используйте метод info. Какие методы API используют для интеграции
  6. Если у вас включено автоподтверждение, после подписания договора банк переведет деньги на счет магазина автоматически. Подтверждение или отмена заявки вручную недоступны с включенным автоподтверждением.

    Если автоподтверждение выключено, вам нужно вручную подтвердить выдачу товара в личном кабинете. Если вы не можете выдать покупателю товар или услугу, отмените заявку. Статус заявки поменяется в личном кабинете агента.

    Когда заявка будет подтверждена, банк переведет деньги на счет магазина. Методы commit и cancel недоступны для работы с автоподтверждением. То есть вы не сможете подтвердить заявку вручную. Для методов info, commit, cancel используйте пароль, который необходимо задать через личный кабинет руководителя.

Данные для тестирования

В качестве логина для метода надо передавать ваш идентификатор магазина с префиксом demo-. Например, если идентификатор — my‑shop, при работе с демозаявкой надо передать логин demo‑my‑shop.

Какие методы API существуют?

Всего их пять.

Create — создание заявки

Метод для создания заявки

МетодPOST
URLhttps://forma.tinkoff.ru/api/partners/v2/orders/create
Формат ответаJSON
Статус ответа

200

В случае успешного сценария

400

В случае некорректного формата запроса

401

Аутентификация не пройдена: введены неверные логин и/или пароль

403

Авторизация не пройдена: пытаетесь работать с чужой заявкой

422

Ошибка бизнес-логики: в текущем состоянии заявки нельзя выполнить это действие

500

Внутренняя ошибка сервера
Метод
URL
https://forma.tinkoff.ru/api/partners/v2/ orders/create
Формат ответа
JSON

Статус ответа

200
В случае успешного сценария
400
В случае некорректного формата запроса
401
Аутентификация не пройдена: введены неверные логин и/или пароль
403
Авторизация не пройдена: пытаетесь работать с чужой заявкой
422
Ошибка бизнес-логики: в текущем состоянии заявки нельзя выполнить это действие
500
Внутренняя ошибка сервера

Параметры запроса

НазваниеОписаниеТипОбязательный
shopIdИдентификатор магазинаstringДа
showcaseIdИдентификатор витрины (сайта)stringНет
sumОбщая сумма заказаnumberДа
itemsСписок товаров

array

Структура
Да
orderNumberИдентификатор заказа в системе партнераstringНет
promoCodeИдентификатор кредитного продукта(кредит/рассрочка)stringНет
demoFlowДоступные флоу для демо заявки

enum

sms, appointment, reject, appointment-reject
Нет
initialStageНачальный экран для демо заявки

enum

filling, wait‑offer, wait‑offers‑all, offers‑all, rejected, wait‑offer-timeout, appointment, ses‑documents, ses‑appointment, kvk‑signing‑sms, kvk‑issued, eastern-express‑sms, eastern-express-issued, mts‑add‑additional‑info, mts‑appointment, mts‑issued, canceled, canceled‑by‑partner, complete-waiting
Нет
failURLURL для возврата в случае неуспешного завершения заявки, если не указан то будет использован URL из настроек магазинаstringНет
successURLURL для возврата в случае успешного завершения заявки, если не указан то будет использован URL из настроек магазинаstringНет
returnURLURL для возврата в случае отмены заявки покупателем, если не указан то будет использован URL из настроек магазинаstringНет
webhookURLURL для отправки вебхуков, если не указан, то будет использован URL из настроек магазинаstringНет
valuesДанные покупателя для предзаполнения формыobjectНет
values.contactКонтактobjectНет
values.contact.fioФИО покупателяobjectНет
values.contact.fio.lastNameФамилия покупателяstringНет
values.contact.fio.firstNameИмя покупателяstringНет
values.contact.fio.middleNameОтчество покупателяstringНет
values.contact.mobilePhoneТелефон покупателя: 10 цифр, без +7stringНет
values.contact.emailEmail покупателяstringНет
shopId
Описание
Идентификатор магазина
Тип
string
Обязательный
Да
showcaseId
Описание
Идентификатор витрины (сайта)
Тип
string
Обязательный
Нет
sum
Описание
Общая сумма заказа
Тип
number
Обязательный
Да
items
Описание
Общая сумма заказа
Тип
Обязательный
Да
orderNumber
Описание
Идентификатор заказа в системе партнера
Тип
string
Обязательный
Нет
promoCode
Описание
Идентификатор кредитного продукта (кредит/рассрочка)
Тип
string
Обязательный
Нет
demoFlow
Описание
Доступные флоу для демо заявки
Тип
enum
sms, appointment, reject, appointment-reject
Обязательный
Нет
initialStage
Описание
Начальный экран для демо заявки
Тип
enum
filling, wait‑offer, wait‑offers‑all, offers‑all, rejected, wait‑offer-timeout, appointment, ses‑documents, ses‑appointment, kvk‑signing‑sms, kvk‑issued, eastern-express‑sms, eastern-express-issued, mts‑add‑additional‑info, mts‑appointment, mts‑issued, canceled, canceled‑by‑partner, complete-waiting
Обязательный
Нет
failURL
Описание
URL для возврата в случае неуспешного завершения заявки, если не указан то будет использован URL из настроек магазина
Тип
string
Обязательный
Нет
successURL
Описание
URL для возврата в случае успешного завершения заявки, если не указан то будет использован URL из настроек магазина
Тип
string
Обязательный
Нет
returnURL
Описание
URL для возврата в случае отмены заявки покупателем, если не указан то будет использован URL из настроек магазина
Тип
string
Обязательный
Нет
webhookURL
Описание
URL для отправки вебхуков, если не указан, то будет использован URL из настроек магазина
Тип
string
Обязательный
Нет
values
Описание
Данные покупателя для предзаполнения формы
Тип
object
Обязательный
Нет
values.contact
Описание
Контакт
Тип
object
Обязательный
Нет
values.contact.fio
Описание
ФИО покупателя
Тип
object
Обязательный
Нет
values.contact.fio.lastName
Описание
Фамилия покупателя
Тип
string
Обязательный
Нет
values.contact.fio.firstName
Описание
Имя покупателя
Тип
string
Обязательный
Нет
values.contact.fio.middleName
Описание
Отчество покупателя
Тип
string
Обязательный
Нет
values.contact.mobilePhone
Описание
Телефон покупателя: 10 цифр, без +7
Тип
string
Обязательный
Нет
values.contact.email
Описание
Email покупателя
Тип
string
Обязательный
Нет

Items

НазваниеОписаниеТипОбязательный
nameНазвание товарной позицииstringДа
quantityКоличество единиц товара в позиции

integer

int32
Да
priceЦена одной единицы товараnumberДа
categoryКатегория товараstringНет
vendorCodeАртикулstringНет
name
Описание
Название товарной позиции
Тип
string
Обязательный
Да
quantity
Описание
Количество единиц товара в позиции
Тип
integer
int32
Обязательный
Да
price
Описание
Цена одной единицы товара
Тип
number
Обязательный
Да
category
Описание
Категория товара
Тип
string
Обязательный
Нет
vendorCode
Описание
Артикул
Тип
string
Обязательный
Нет

Параметры ответа

НазваниеОписаниеТипОбязательный
idID заявки в TCBstringДа
linkСсылка на заявку в TCBstringДа
id
Описание
ID заявки в TCB
Тип
string
Обязательный
Да
Create Demo — создание демозаявки

Создание демо‑заявки

Метод для создания демо‑заявки

МетодPOST
URLhttps://forma.tinkoff.ru/api/partners/v2/orders/create‑demo
Формат ответаJSON
Статус ответа

200

В случае успешного сценария

400

В случае некорректного формата запроса

401

Аутентификация не пройдена: введены неверные логин и/или пароль

403

Авторизация не пройдена: пытаетесь работать с чужой заявкой

422

Ошибка бизнес-логики: в текущем состоянии заявки нельзя выполнить это действие

500

Внутренняя ошибка сервера
Метод
POST
URL
https://forma.tinkoff.ru/api/partners/v2/ orders/create‑demo
Формат ответа
JSON

Статус ответа

200
В случае успешного сценария
400
В случае некорректного формата запроса
401
Аутентификация не пройдена: введены неверные логин и/или пароль
403
Авторизация не пройдена: пытаетесь работать с чужой заявкой
422
Ошибка бизнес-логики: в текущем состоянии заявки нельзя выполнить это действие
500
Внутренняя ошибка сервера

Параметры запроса

НазваниеОписаниеТипОбязательный
shopIdИдентификатор магазинаstringДа
showcaseIdИдентификатор витрины (сайта)stringНет
sumОбщая сумма заказаnumberДа
itemsСписок товаров

array

Структура
Да
orderNumberИдентификатор заказа в системе партнераstringНет
promoCodeИдентификатор кредитного продукта(кредит/рассрочка)stringНет
demoFlowДоступные флоу для демо заявки

enum

sms, appointment, reject, appointment-reject
Нет
initialStageНачальный экран для демо заявки

enum

filling, wait‑offer, wait‑offers‑all, offers‑all, rejected, wait‑offer-timeout, appointment, ses‑documents, ses‑appointment, kvk‑signing‑sms, kvk‑issued, eastern-express‑sms, eastern-express-issued, mts‑add‑additional‑info, mts‑appointment, mts‑issued, canceled, canceled‑by‑partner, complete-waiting
Нет
failURLURL для возврата в случае неуспешного завершения заявки, если не указан то будет использован URL из настроек магазинаstringНет
successURLURL для возврата в случае успешного завершения заявки, если не указан то будет использован URL из настроек магазинаstringНет
returnURLURL для возврата в случае отмены заявки покупателем, если не указан то будет использован URL из настроек магазинаstringНет
webhookURLURL для отправки вебхуков, если не указан, то будет использован URL из настроек магазинаstringНет
valuesДанные покупателя для предзаполнения формыobjectНет
values.contactКонтактobjectНет
values.contact.fioФИО покупателяobjectНет
values.contact.fio.lastNameФамилия покупателяstringНет
values.contact.fio.firstNameИмя покупателяstringНет
values.contact.fio.middleNameОтчество покупателяstringНет
values.contact.mobilePhoneТелефон покупателя: 10 цифр, без +7stringНет
values.contact.emailEmail покупателяstringНет
shopId
Описание
Идентификатор магазина
Тип
string
Обязательный
Да
showcaseId
Описание
Идентификатор витрины (сайта)
Тип
string
Обязательный
Нет
sum
Описание
Общая сумма заказа
Тип
number
Обязательный
Да
items
Описание
Общая сумма заказа
Тип
Обязательный
Да
orderNumber
Описание
Идентификатор заказа в системе партнера
Тип
string
Обязательный
Нет
promoCode
Описание
Идентификатор кредитного продукта (кредит/рассрочка)
Тип
string
Обязательный
Нет
demoFlow
Описание
Доступные флоу для демо заявки
Тип
enum
sms, appointment, reject, appointment-reject
Обязательный
Нет
initialStage
Описание
Начальный экран для демо заявки
Тип
enum
filling, wait‑offer, wait‑offers‑all, offers‑all, rejected, wait‑offer-timeout, appointment, ses‑documents, ses‑appointment, kvk‑signing‑sms, kvk‑issued, eastern-express‑sms, eastern-express-issued, mts‑add‑additional‑info, mts‑appointment, mts‑issued, canceled, canceled‑by‑partner, complete-waiting
Обязательный
Нет
failURL
Описание
URL для возврата в случае неуспешного завершения заявки, если не указан то будет использован URL из настроек магазина
Тип
string
Обязательный
Нет
successURL
Описание
URL для возврата в случае успешного завершения заявки, если не указан то будет использован URL из настроек магазина
Тип
string
Обязательный
Нет
returnURL
Описание
URL для возврата в случае отмены заявки покупателем, если не указан то будет использован URL из настроек магазина
Тип
string
Обязательный
Нет
webhookURL
Описание
URL для отправки вебхуков, если не указан, то будет использован URL из настроек магазина
Тип
string
Обязательный
Нет
values
Описание
Данные покупателя для предзаполнения формы
Тип
object
Обязательный
Нет
values.contact
Описание
Контакт
Тип
object
Обязательный
Нет
values.contact.fio
Описание
ФИО покупателя
Тип
object
Обязательный
Нет
values.contact.fio.lastName
Описание
Фамилия покупателя
Тип
string
Обязательный
Нет
values.contact.fio.firstName
Описание
Имя покупателя
Тип
string
Обязательный
Нет
values.contact.fio.middleName
Описание
Отчество покупателя
Тип
string
Обязательный
Нет
values.contact.mobilePhone
Описание
Телефон покупателя: 10 цифр, без +7
Тип
string
Обязательный
Нет
values.contact.email
Описание
Email покупателя
Тип
string
Обязательный
Нет

Items

НазваниеОписаниеТипОбязательный
nameНазвание товарной позицииstringДа
quantityКоличество единиц товара в позиции

integer

int32
Да
priceЦена одной единицы товараnumberДа
categoryКатегория товараstringНет
vendorCodeАртикулstringНет
name
Описание
Название товарной позиции
Тип
string
Обязательный
Да
quantity
Описание
Количество единиц товара в позиции
Тип
integer
int32
Обязательный
Да
price
Описание
Цена одной единицы товара
Тип
number
Обязательный
Да
category
Описание
Категория товара
Тип
string
Обязательный
Нет
vendorCode
Описание
Артикул
Тип
string
Обязательный
Нет

Параметры ответа

НазваниеОписаниеТипОбязательный
idID заявки в TCBstringДа
linkСсылка на заявку в TCBstringДа
id
Описание
ID заявки в TCB
Тип
string
Обязательный
Да
link
Описание
Ссылка на заявку в TCB
Тип
string
Обязательный
Да
Cancel — отмена заявки

Отмена заявки

Метод для отмены заказа, в случае если, например, его нужного товара нет на складе и/или клиент передумал его брать

МетодPOST
URLhttps://forma.tinkoff.ru/api/partners/v2/orders/{orderNumber}/cancel
Формат ответаJSON
Статус ответа

200

В случае успешного сценария

400

В случае некорректного формата запроса

401

Аутентификация не пройдена: введены неверные логин и/или пароль

403

Авторизация не пройдена: пытаетесь работать с чужой заявкой

422

Ошибка бизнес-логики: в текущем состоянии заявки нельзя выполнить это действие

500

Внутренняя ошибка сервера
Метод
POST
URL
https://forma.tinkoff.ru/api/partners/v2/ orders/{orderNumber}/cancel
Формат ответа
JSON

Статус ответа

200
В случае успешного сценария
400
В случае некорректного формата запроса
401
Аутентификация не пройдена: введены неверные логин и/или пароль
403
Авторизация не пройдена: пытаетесь работать с чужой заявкой
422
Ошибка бизнес-логики: в текущем состоянии заявки нельзя выполнить это действие
500
Внутренняя ошибка сервера

Параметры запроса

НазваниеОписаниеТипОбязательный
orderNumber pathНомер заказаstringДа
Authorization headerBasic AuthstringДа
orderNumber
path
Описание
Номер заказа
Тип
string
Обязательный
Да
Authorization
header
Описание
Basic Auth
Тип
string
Обязательный
Да

Параметры ответа

НазваниеОписаниеТипОбязательный
idИдентификатор заказаstringДа
statusТекущий статус заявки

enum

inprogress, signed, issued, canceled, new, rejected, approved
Да
created_atДата и время создания заявки.

string

dateTime
Да
demoФлаг показывающий реальная ли это заявка или заявка созданная в демо‑режимеbooleanДа
committedФлаг показывающий подтверждена ли данная заявкаbooleanДа
first_paymentСумма первого платежа по кредиту

number

double
Нет
order_amountСумма заказа

number

double
Да
credit_amountСумма выдаваемого покупателю кредита

number

double
Нет
productТип продукта

enum

credit, installment_credit
Да
termКоличество месяцев, на которое оформляется кредит

integer

int32
Нет
monthly_paymentСумма ежемесячного платежа

number

double
Нет
first_nameИмя покупателяstringНет
last_nameФамилия покупателяstringНет
middle_nameОтчество покупателяstringНет
phoneТелефон покупателяstringНет
loan_numberНомер договораstringНет
emailemail покупателяstringНет
appropriate_signing_typesДоступные способы подписания по флоуarray Да
signing_typeТип подписания

enum

bank, sms, paperless, ses
Нет
chosen_bankБанк, выдавший кредитstringНет
expected_overdue_atОжидаемая дата, когда заявка просрочится

string

dateTime
Нет
id
Описание
Идентификатор заказа
Тип
string
Обязательный
Да
status
Описание
Текущий статус заявки
Тип
enum
inprogress, signed, issued, canceled, new, rejected, approved
Обязательный
Да
created_at
Описание
Дата и время создания заявки.
Тип
string
dateTime
Обязательный
Да
demo
Описание
Флаг показывающий реальная ли это заявка или заявка созданная в демо‑режиме
Тип
boolean
Обязательный
Да
committed
Описание
Флаг показывающий подтверждена ли данная заявка
Тип
boolean
Обязательный
Да
first_payment
Описание
Сумма первого платежа по кредиту
Тип
number
double
Обязательный
Нет
order_amount
Описание
Сумма заказа
Тип
number
double
Обязательный
Да
credit_amount
Описание
Сумма выдаваемого покупателю кредита
Тип
number
double
Обязательный
Нет
product
Описание
Тип продукта
Тип
enum
credit, installment_credit
Обязательный
Да
term
Описание
Количество месяцев, на которое оформляется кредит
Тип
integer
int32
Обязательный
Нет
monthly_payment
Описание
Сумма ежемесячного платежа
Тип
number
double
Обязательный
Нет
first_name
Описание
Имя покупателя
Тип
string
Обязательный
Нет
last_name
Описание
Фамилия покупателя
Тип
string
Обязательный
Нет
middle_name
Описание
Отчество покупателя
Тип
string
Обязательный
Нет
phone
Описание
Телефон покупателя
Тип
string
Обязательный
Нет
loan_number
Описание
Номер договора
Тип
string
Обязательный
Нет
email
Описание
email покупателя
Тип
string
Обязательный
Нет
appropriate_signing_types
Описание
Доступные способы подписания по флоу
Тип
array ‹string›
Обязательный
Да
signing_type
Описание
Тип подписания
Тип
enum
bank, sms, paperless, ses
Обязательный
Нет
chosen_bank
Описание
Банк, выдавший кредит
Тип
string
Обязательный
Нет
expected_overdue_at
Описание
Ожидаемая дата, когда заявка просрочится
Тип
string
dateTime
Обязательный
Нет
Commit — подтверждение заявки

Подтверждение заявки

Метод для подтверждения заказа, после этого кредит будет выдан

МетодPOST
URLhttps://forma.tinkoff.ru/api/partners/v2/orders/{orderNumber}/commit
Формат ответаJSON
Статус ответа

200

В случае успешного сценария

400

В случае некорректного формата запроса

401

Аутентификация не пройдена: введены неверные логин и/или пароль

403

Авторизация не пройдена: пытаетесь работать с чужой заявкой

422

Ошибка бизнес-логики: в текущем состоянии заявки нельзя выполнить это действие

500

Внутренняя ошибка сервера
Метод
POST
URL
https://forma.tinkoff.ru/api/partners/v2/ orders/{orderNumber}/commit
Формат ответа
JSON

Статус ответа

200
В случае успешного сценария
400
В случае некорректного формата запроса
401
Аутентификация не пройдена: введены неверные логин и/или пароль
403
Авторизация не пройдена: пытаетесь работать с чужой заявкой
422
Ошибка бизнес-логики: в текущем состоянии заявки нельзя выполнить это действие
500
Внутренняя ошибка сервера

Параметры запроса

НазваниеОписаниеТипОбязательный
orderNumber pathНомер заказаstringДа
Authorization headerBasic AuthstringДа
orderNumber
path
Описание
Номер заказа
Тип
string
Обязательный
Да
Authorizationr
header
Описание
Basic Auth
Тип
string
Обязательный
Да

Параметры ответа

НазваниеОписаниеТипОбязательный
idИдентификатор заказаstringДа
statusТекущий статус заявки

enum

inprogress, signed, issued, canceled, new, rejected, approved
Да
created_atДата и время создания заявки.

string

dateTime
Да
demoФлаг показывающий реальная ли это заявка или заявка созданная в демо‑режимеbooleanДа
committedФлаг показывающий подтверждена ли данная заявкаbooleanДа
first_paymentСумма первого платежа по кредиту

number

double
Нет
order_amountСумма заказа

number

double
Да
credit_amountСумма выдаваемого покупателю кредита

number

double
Нет
productТип продукта

enum

credit, installment_credit
Да
termКоличество месяцев, на которое оформляется кредит

integer

int32
Нет
monthly_paymentСумма ежемесячного платежа

number

double
Нет
first_nameИмя покупателяstringНет
last_nameФамилия покупателяstringНет
middle_nameОтчество покупателяstringНет
phoneТелефон покупателяstringНет
loan_numberНомер договораstringНет
emailemail покупателяstringНет
appropriate_signing_typesДоступные способы подписания по флоуarray Да
signing_typeТип подписания

enum

bank, sms, paperless, ses
Нет
chosen_bankБанк, выдавший кредитstringНет
expected_overdue_atОжидаемая дата, когда заявка просрочится

string

dateTime
Нет
id
Описание
Идентификатор заказа
Тип
string
Обязательный
Да
status
Описание
Текущий статус заявки
Тип
enum
inprogress, signed, issued, canceled, new, rejected, approved
Обязательный
Да
created_at
Описание
Дата и время создания заявки.
Тип
string
dateTime
Обязательный
Да
demo
Описание
Флаг показывающий реальная ли это заявка или заявка созданная в демо‑режиме
Тип
boolean
Обязательный
Да
committed
Описание
Флаг показывающий подтверждена ли данная заявка
Тип
boolean
Обязательный
Да
first_payment
Описание
Сумма первого платежа по кредиту
Тип
number
double
Обязательный
Нет
order_amount
Описание
Сумма заказа
Тип
number
double
Обязательный
Да
credit_amount
Описание
Сумма выдаваемого покупателю кредита
Тип
number
double
Обязательный
Нет
product
Описание
Тип продукта
Тип
enum
credit, installment_credit
Обязательный
Да
term
Описание
Количество месяцев, на которое оформляется кредит
Тип
integer
int32
Обязательный
Нет
monthly_payment
Описание
Сумма ежемесячного платежа
Тип
number
double
Обязательный
Нет
first_name
Описание
Имя покупателя
Тип
string
Обязательный
Нет
last_name
Описание
Фамилия покупателя
Тип
string
Обязательный
Нет
middle_name
Описание
Отчество покупателя
Тип
string
Обязательный
Нет
phone
Описание
Телефон покупателя
Тип
string
Обязательный
Нет
loan_number
Описание
Номер договора
Тип
string
Обязательный
Нет
email
Описание
email покупателя
Тип
string
Обязательный
Нет
appropriate_signing_types
Описание
Доступные способы подписания по флоу
Тип
array‹string›
Обязательный
Да
signing_type
Описание
Тип подписания
Тип
enum
bank, sms, paperless, ses
Обязательный
Нет
chosen_bank
Описание
Банк, выдавший кредит
Тип
string
Обязательный
Нет
expected_overdue_at
Описание
Ожидаемая дата, когда заявка просрочится
Тип
string
dateTime
Обязательный
Нет
Info — проверка статуса заявки

Получение информации по заявке

Метод для получения и проверки актуального статус по заявке

МетодGET
URLhttps://forma.tinkoff.ru/api/partners/v2/orders/{orderNumber}/info
Формат ответаJSON
Статус ответа

200

В случае успешного сценария

400

В случае некорректного формата запроса

401

Аутентификация не пройдена: введены неверные логин и/или пароль

403

Авторизация не пройдена: пытаетесь работать с чужой заявкой

422

Ошибка бизнес-логики: в текущем состоянии заявки нельзя выполнить это действие

500

Внутренняя ошибка сервера
Метод
GET
URL
https://forma.tinkoff.ru/api/partners/v2/ orders/{orderNumber}/info
Формат ответа
JSON

Статус ответа

200
В случае успешного сценария
400
В случае некорректного формата запроса
401
Аутентификация не пройдена: введены неверные логин и/или пароль
403
Авторизация не пройдена: пытаетесь работать с чужой заявкой
422
Ошибка бизнес-логики: в текущем состоянии заявки нельзя выполнить это действие
500
Внутренняя ошибка сервера

Параметры запроса

НазваниеОписаниеТипОбязательный
orderNumber pathНомер заказаstringДа
Authorization headerBasic AuthstringДа
orderNumber
path
Описание
Номер заказа
Тип
string
Обязательный
Да
Authorization
header
Описание
Basic Auth
Тип
string
Обязательный
Да

Параметры ответа

НазваниеОписаниеТипОбязательный
idИдентификатор заказаstringДа
statusТекущий статус заявки

enum

inprogress, signed, issued, canceled, new, rejected, approved
Да
created_atДата и время создания заявки.

string

dateTime
Да
demoФлаг показывающий реальная ли это заявка или заявка созданная в демо‑режимеbooleanДа
committedФлаг показывающий подтверждена ли данная заявкаbooleanДа
first_paymentСумма первого платежа по кредиту

number

double
Нет
order_amountСумма заказа

number

double
Да
credit_amountСумма выдаваемого покупателю кредита

number

double
Нет
productТип продукта

enum

credit, installment_credit
Да
termКоличество месяцев, на которое оформляется кредит

integer

int32
Нет
monthly_paymentСумма ежемесячного платежа

number

double
Нет
first_nameИмя покупателяstringНет
last_nameФамилия покупателяstringНет
middle_nameОтчество покупателяstringНет
phoneТелефон покупателяstringНет
loan_numberНомер договораstringНет
emailemail покупателяstringНет
appropriate_signing_typesДоступные способы подписания по флоуarray Да
signing_typeТип подписания

enum

bank, sms, paperless, ses
Нет
chosen_bankБанк, выдавший кредитstringНет
expected_overdue_atОжидаемая дата, когда заявка просрочится

string

dateTime
Нет
id
Описание
Идентификатор заказа
Тип
string
Обязательный
Да
status
Описание
Текущий статус заявки
Тип
enum
inprogress, signed, issued, canceled, new, rejected, approved
Обязательный
Да
created_at
Описание
Дата и время создания заявки.
Тип
string
dateTime
Обязательный
Да
demo
Описание
Флаг показывающий реальная ли это заявка или заявка созданная в демо‑режиме
Тип
boolean
Обязательный
Да
committed
Описание
Флаг показывающий подтверждена ли данная заявка
Тип
boolean
Обязательный
Да
first_payment
Описание
Сумма первого платежа по кредиту
Тип
number
double
Обязательный
Нет
order_amount
Описание
Сумма заказа
Тип
number
double
Обязательный
Да
credit_amount
Описание
Сумма выдаваемого покупателю кредита
Тип
number
double
Обязательный
Нет
product
Описание
Сумма выдаваемого покупателю кредита
Тип
enum
credit, installment_credit
Обязательный
Да
term
Описание
Количество месяцев, на которое оформляется кредит
Тип
integer
int32
Обязательный
Нет
monthly_payment
Описание
Сумма ежемесячного платежа
Тип
number
double
Обязательный
Нет
first_name
Описание
Имя покупателя
Тип
string
Обязательный
Нет
last_name
Описание
Фамилия покупателя
Тип
string
Обязательный
Нет
middle_name
Описание
Отчество покупателя
Тип
string
Обязательный
Нет
phone
Описание
Телефон покупателя
Тип
string
Обязательный
Нет
loan_number
Описание
Номер договора
Тип
string
Обязательный
Нет
email
Описание
email покупателя
Тип
string
Обязательный
Нет
appropriate_signing_types
Описание
Доступные способы подписания по флоу
Тип
array ‹string›
Обязательный
Да
signing_type
Описание
Тип подписания
Тип
enum
bank, sms, paperless, ses
Обязательный
Нет
chosen_bank
Описание
Банк, выдавший кредит
Тип
string
Обязательный
Нет
expected_overdue_at
Описание
Ожидаемая дата, когда заявка просрочится
Тип
string
dateTime
Обязательный
Нет
Получилось найти ответ?
Нет
Да

Другие статьи по этой теме

  • Инструкция по интеграции кнопки «Купить в рассрочку» или «Купить в кредит» на сайт
  • Как начать продавать в рассрочку или кредит по ссылке и QR‑коду
  • Как интегрировать модуль «Битрикс»
  • Как подключить оплату в рассрочку и кредит на GetCourse
  • Справочная информация