Перейти к основному содержимому

Получить список платёжных правил для указанного соглашения

/api/v1/rules

GET

https://secured-openapi.tbank.ru/api/v1/rules

Метод для получения списка платёжных правил, созданных для указанного соглашения.

В поле scope у токена должен быть доступ opensme/inn/[{inn}]/kpp/[{kpp}]/nonacceptance-debits/manageУправление соглашениями о безакцептных списаниях.

Замечание: возвращает только правила с типом Recurrent. Для получения информации о триггерных правилах вызывайте метод /api/v2/rules.

Авторизация

Security

Bearer API Token

RPS

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

Scopes

Управление соглашениями о безакцептных списанияхУправление соглашениями о безакцептных списаниях

Header parameters

X-Request-Id

String<uuid>

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

Query parameters

Required

agreementId

String<uuid>

ID соглашения, в рамках которого заключены правила.

limit

Integer<int32>

Default: 50

Максимальное количество правил, которое нужно вывести. Значение по умолчанию — 50.

offset

Integer<int32>

0

Количество правил, которые нужно пропустить. Значение по умолчанию — 0.

Ответ

200

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

400

Соглашение не найдено

401

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

403

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

422

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

429

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

500

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

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

Loading...

openapi@tinkoff.ru

АО «Тинькофф Банк» использует файлы «cookie», с целью персонализации сервисов и повышения удобства пользования веб-сайтом. «Cookie» представляют собой небольшие файлы, содержащие информацию о предыдущих посещениях веб-сайта. Если вы не хотите использовать файлы «cookie», измените настройки браузера.