Изменить платёжное правило

/api/v1/rules/{ruleId}

PUT

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

Метод позволяет обновить конфигурацию платёжного правила.

Важные детали работы с рекуррентными правилами:

После изменения правила следующее списание выполняется не раньше, чем через 24 часа после последнего платежа. Например, списание настроено раз в месяц на 14 число в 10:00. Сейчас 15 декабря, последнее списание было 14 декабря. Рассмотрим несколько случаев:

• Вы хотите изменить расписание на списание раз в месяц 16 числа. Тогда следующее списание произойдёт 16 декабря — между предыдущим списанием 14 числа и новым списанием 16 пройдёт больше 24 часов.
• Вы хотите изменить расписание на списание раз в месяц 15 числа в 15:00. Тогда следующее списание произойдёт 15 декабря в 15:00 — между предыдущим списанием 14 числа в 10:00 и новым списанием 15 числа в 15:00 пройдёт больше 24 часов.
• Вы хотите изменить расписание на списание раз в месяц 15-го числа в 9:00. Тогда следующее списание произойдёт 15 января в 9:00 — между предыдущим списанием 14 декабря в 10:00 и новым списанием 15 декабря в 9:00 пройдёт меньше 24 часов, поэтому будет взята следующая по расписанию дата — 15 января.

Авторизация

Security

Bearer API Token

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

RPS

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

Scopes

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

Запрос

Header parameters

X-Request-Id

String<uuid>

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

Path parameters

Required

ruleId

String<uuid>

ID платёжного правила.

Request body schema application/json

oneOf

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

Required

type

String

Requirements: [Recurrent, Trigger]

Тип правила:

• Recurrent — рекуррентное правило;

• Trigger — триггерное правило.

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

cronExpr

String<string>

Requirements: >= 9 characters and <= 200 characters

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

Триггерное правило

Required

type

String

Requirements: [Recurrent, Trigger]

Тип правила:

• Recurrent — рекуррентное правило;

• Trigger — триггерное правило.

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

category

String

Requirements: [CashIn, MerchantAcq, InternetAcq, CounterpartyIncome]

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

CashIn - операции внесения наличных на счёт контрагента.

MerchantAcq - операции, проведённые по торговому эквайрингу.

InternetAcq - операции, проведённые по интернет-эквайрингу.

CounterpartyIncome - операции по входящим переводам от контрагентов.

Required

requisites

Object

Required

docType

String

Requirements: [PaymentRequest]

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

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

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

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

Ответ

200

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

400

Правило не найдено

401

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

403

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

422

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

429

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

500

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

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

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

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

Loading...