Создать новую заявку

POST

https://secured-openapi.business.tinkoff.ru/api/offline/partners/v1/create

Метод создаёт кредитную заявку в системе Тинькофф Кредит Брокер.

В ответе возвращается ссылка с ссылочной авторизацией для продолжения заявочного процесса внутри личного кабинета агента.

Авторизация

Security

Bearer API Token

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

RPS

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

Scopes

Кредитование покупателей → Создание новой заявки

Запрос

Header parameters

X-Request-Id

String<uuid>

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

Request body schema application/json

agentLogin

String

Requirements: Value must match regular expression ^[9]{1}[0-9]{9}$

Номер телефона агента под которым он заведён в TCB.

Required

orderNumber

String<string>

Requirements: non-empty and <= 50 characters

Номер заказа на стороне продавца.

order

Object

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

Required

items

Array of objects ()

Requirements: >= 1 items, <= 99 items

Товары в корзине.

Required

name

String<string>

Requirements: non-empty and <= 255 characters

Наименование товара.

Required

quantity

Integer<int32>

Количество товара.

Required

price

Number<double>

Стоимость 1 единицы товара.

externalId

String<string>

Requirements: non-empty

Идентификатор товара.

Required

type

Object

Объект с информацией по запрашиваемым продуктам.

Required

isPos

Boolean<boolean>

Флаг отправки заявки на пос-кредит.

Required

isCreditCard

Boolean<boolean>

Флаг отправки заявки на кредитную карту.

isCallSigning

Boolean<boolean>

Флаг телефонного заполнения. По умолчанию — false.

isOnlyCredit

Boolean<boolean>

Флаг отключения рассрочек, возможно оформление только кредитов. По умолчанию — false.

values

Object

Данные клиента.

contact

Object

Модель данных клиента.

fio

Object

ФИО клиента.

Required

firstName

String<string>

Requirements: Value must match regular expression ^[а-яА-ЯёЁ\-\s]{1,}$

Имя клиента.

Required

lastName

String<string>

Requirements: Value must match regular expression ^[а-яА-ЯёЁ\-\s]{1,}$

Фамилия клиента.

middleName

String<string>

Requirements: Value must match regular expression ^[а-яА-ЯёЁ\-\s]{1,}$

Отчество клиента.

mobilePhone

String

Requirements: Value must match regular expression ^[9]{1}[0-9]{9}$

Номер телефона клиента.

birthDate

String<date>

Дата рождения клиента.

isResident

Boolean<boolean>

Флаг резидента РФ.

webhookURL

String<url>

Requirements: Value must match regular expression ^https?:\/\/(?:www\.)?[-a-zA-Z0-9@:%._\+~#=]{1,256}\.[a-zA-Z0-9()]{1,6}\b(?:[-a-zA-Z0-9()@:%_\+.~#?&\/=]*)$

URL для отправки вебхуков. Если не указан, используется URL из настроек точки.

pointId

String<string>

Requirements: non-empty and <= 50 characters

Внешний идентификатор точки.

companyId

String<string>

Requirements: non-empty and <= 100 characters

Внешний идентификатор компании.

agentId

String<string>

Requirements: non-empty and <= 100 characters

Внешний идентификатор агента.

creditCards

Object

Объект с кредитными картами.

property name*

Object

Required

ean

String<string>

Requirements: <= 13 characters, Value must match regular expression ^\d{13}$

Штрихкод кредитной карты. Допускаются только цифры.

Ответ

200

Успешный запрос

400

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

401

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

403

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

422

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

429

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

500

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

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

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

Получить консультацию по интеграции