Создать платёжное правило

POST

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

Метод для создания платёжного правила.

Задать правило можно двумя способами:

Регулярное списание по расписанию. Правило может выполняться не чаще одного раза в 24 часа — например, каждый день в 12:00 мск.
Списание по событию. Когда происходит событие, соответствующее заданным параметрам, система автоматически генерирует платёжное требование, которое позволит списать средства вам на счёт. Например, если вам нужно списывать роялти с ваших франчайзи, мы можем автоматически списывать определённый процент от всех пополнений по торговому эквайрингу и зачислять вам на счёт.

В рамках одного правила доступна одна из обязательных категорий пополнения и вариант списания — фиксированная сумма или процент от платежа. Категории:

внесение наличных на счёт контрагента;
торговый эквайринг;
интернет-эквайринг;
входящие переводы от контрагентов — если используете эту категорию, обязательно указывайте данные компаний-инициаторов платежей.

Если денег на счёте плательщика не хватает, платёж встаёт в картотеку. Остаток списывается при следующих поступлениях.

Авторизация

Security

Bearer API Token

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

RPS

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

Scopes

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

Запрос

Header parameters

Required

Idempotency-Key

String

Ключ идемпотентности. Подробнее.

X-Request-Id

String<uuid>

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

Request body schema application/json

oneOf

Рекуррентное правило
Триггерное правило

Required

type

String

Requirements: [Recurrent, Trigger]

Тип правила:

Recurrent — рекуррентное правило;
Trigger — триггерное правило.

Required

agreementId

String<uuid>

ID соглашения.

Required

cronExpr

String<string>

Requirements: >= 9 characters and <= 200 characters

CRON-выражение регулярности платежа. Например, "0 12 * * *" — каждый день в 12:00 мск.

Required

requisites

Object

Required

docType

String

Requirements: [PaymentRequest]

Тип платёжного документа.

PaymentRequest — платёжное требование.

Required

amount

Number<decimal>

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

paymentCondition

String

Requirements: [WithAcceptance, WithoutAcceptance]

Условие платежа. WithoutAcceptance — без акцепта.

acceptTerm

Integer<int32>

Requirements: >= 5 and <= 9

Количество дней для акцепта.

docDispatchDate

String

Requirements: Value must match regular expression ^(\d{4}-\d{2}-\d{2})$

Дата вручения плательщику предусмотренных договором документов в формате YYYY-MM-DD.

Required

payerAccount

String

Requirements: Value must match regular expression ^(\d{20})$

Номер счёта плательщика.

Required

payerINN

String

Requirements: Value must match regular expression ^(\d{10}|\d{12})$

ИНН плательщика.

Required

payerKPP

String

Requirements: Value must match regular expression ^(\d{9}|0)$

КПП плательщика.

Если КПП нет, передайте 0.

Required

payerName

String

Requirements: non-empty and <= 160 characters

Наименование плательщика.

Required

payerBIC

String

Requirements: Value must match regular expression ^(\d{9})$

БИК плательщика.

Required

payerCorAccount

String

Requirements: Value must match regular expression ^(\d{20})$

Корреспондентский счёт плательщика.

Required

recipientAccount

String

Requirements: Value must match regular expression ^(\d{20})$

Счёт получателя.

Required

purpose

String<string>

Requirements: non-empty and <= 210 characters

Назначение платежа.

Required

type

String

Requirements: [Recurrent, Trigger]

Тип правила:

Recurrent — рекуррентное правило;
Trigger — триггерное правило.

Required

agreementId

String<uuid>

ID соглашения.

Required

amount

Object

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

Возможно представление в одном из двух видов: фиксированный или процентный. Заполнять необходимо только одно из полей: либо fixed, либо percent.

fixed

Number<decimal>

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

percent

Number<decimal>

Requirements: <= 1

Сумма платежа в виде процента от суммы пополнения. Значение 0.0001 соответствует 0.01%, а 1.0000 - 100%.

Required

replenishmentFilter

Object

Условия, при которых должны проводиться списания по операциям пополнения.

Работает по принципу «и»: если заполнены несколько полей, то списания будут происходить, только если для каждого этих полей будет выполнено указанное условие.

Например, если в category указано CounterpartyIncome и в payers указана компания с ИНН = 7777777777, списание будет происходить только при входящем переводе от компании с ИНН = 7777777777.

payers

Array of objects ()

Requirements: <= 50 items

Данные компаний-инициаторов пополнений.

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

Заполнение поля обязательно для правил с category = CounterpartyIncome. В иных случаях поле не заполняется.

Required

inn

String

Requirements: Value must match regular expression ^(\d{10}|\d{12})$

ИНН.

Required

kpp

String

Requirements: Value must match regular expression ^(\d{9}|0)$

КПП.

Required

Ответ

200

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

400

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

401

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

403

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

422

Соглашение имеет невалидный статус

429

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

500

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

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

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

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