Получить список платежных реестров за временной промежуток

/api/v1/salary/payment-registry/list

POST

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

Метод возвращает список платежных реестров за указанный временной промежуток. Максимальное число число реестров в списке — 50.

Авторизация

Security

Bearer API Token

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

RPS

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

Scopes

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

Запрос

Header parameters

X-Request-Id

String<uuid>

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

Request body schema application/json

offset

Integer

Количество реестров с начала списка, которое мы пропустим при выдаче.

statuses

Array

Requirements: [DRAFT, ERROR, SUBMITTED, PROCESSING, ACCEPTED, EXECUTED, PART_EXEC, REJECTED, CANCELLED, DELETED], <= 10 items

Статусы платежных реестров.

periodStart

String<date>

Начало периода, когда платежный реестр был создан.

periodEnd

String<date>

Окончание периода, когда платежный реестр был создан.

Ответ

200

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

400

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

401

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

403

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

422

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

429

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

500

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

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

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

Интеграция

Прямая (H2H)Партнерская

Сценарий использования

Работа с сотрудниками

Пример запроса

Payload

cURL

Go

Java

NodeJs

PHP

Python

Content type

application/json

{

"offset":

0,

"statuses": [

"EXECUTED",

"PART_EXEC"

],

"periodStart":

"2024-09-01",

"periodEnd":

"2024-09-07"

}

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

200

400

401

403

422

429

500

Content type

application/json

{

"paymentOrders": [

{ ... }

"number":

123,

"date":

"2024-09-01T08:50:46.061Z",

"count":

5,

"sum":

5000,

"status":

"EXECUTED"

}

]

}