Создать и подписать платежный реестр

POST

https://secured-openapi.tbank.ru/api/v1/salary/payment-registry/create-submit

Метод позволяет создать платежный реестр и сразу его подписать.

Запрос асинхронный — его результат можно получить через метод Получить результат создания и подписания платежного реестра, передав в нем соответствующий correlationId.

Авторизация

Security

Bearer API Token

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

RPS

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

Scopes

Зарплатный проект → Подписание платежных реестров по сотрудникам компании с ИНН {inn} и КПП {kpp}

Запрос

Header parameters

X-Request-Id

String<uuid>

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

Request body schema application/json

Required

payments

Array of objects ()

Requirements: <= 8000 items

Список платежей внутри реестра.

Required

number

Integer<int32>

Идентификатор платежа на стороне клиента.

revenueTypeCode

String

Requirements: [1, 2, 3, 4, 5]

Код вида дохода.

collectionAmount

Number<double>

Удержанная сумма.

Required

paymentPurpose

String

Requirements: <= 210 characters

Назначение платежа данному сотруднику в рамках зарплатного реестра.

Required

accountNumber

String

Requirements: <= 50 characters

Номер счета сотрудника.

periodStart

String<date>

Начало периода платежа.

Required

employeeInfo

Object

Данные сотрудника.

Required

firstName

String

Requirements: <= 100 characters

Имя (кириллица).

Required

lastName

String

Requirements: <= 100 characters

Фамилия (кириллица).

middleName

String

Requirements: <= 100 characters

Отчество (кириллица).

periodEnd

String<date>

Окончание периода платежа.

Required

sum

Number<double>

Сумма платежа.

loadDate

String<date-time>

Дата отправки реестра.

registryCreateType

String (OpenPaymentOrderCreationFlowDTO217098214)

Requirements: [IGNORE_ERRORS, FAIL_ERRORS]

Условия создания и подписания реестра:

IGNORE_ERRORS — реестр будет создан и подписан из всех корректных платежей. Если корректных платежей нет, реестр не создастся.
FAIL_ERRORS — реестр не создастся и не подпишется, если есть ошибочные платежи.

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

companyAccountNumber

String

Requirements: <= 50 characters

Номер счета компании, с которого будут списаны деньги для оплаты реестра (при наличии РКО в Т-Банке). Если номер счета не передан, средства спишутся с основного счета компании.

Required

correlationId

String<uuid>

Идентификатор, связывающий запрос создания и подписания с запросом получения ответа.

Ответ

200

400

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

401

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

403

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

422

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

429

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

500

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

502

Bad Gateway

503

Service Unavailable

504

Gateway Timeout

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

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