Управление лимитами¶

Общая информация¶

Лимиты — это ограничения, которые применяются к операциям клиента. После создания клиента для него по умолчанию начинают действовать сервисные лимиты. Чтобы применять дополнительные ограничения, партнёру следует установить cобственные — партнёрские лимиты.

Свойства лимитов¶

Свойства, которыми обладают как сервисные, так и партнёрские лимиты, перечислены ниже.

limitType — тип лимита.
Пример
- BALANCE — лимит на допустимый остаток на счёте клиента.
- CASH_WITHDRAWAL_OPERATIONS — лимит на снятие наличных с карты.
periodType — период действия лимита.
Пример
- ON_DAY — лимит на снятие наличных с карты в день.
- ON_MONTH — лимит на снятие наличных с карты в месяц.
periodFrom и periodTill — дата и время начала и окончания периода действия.

Пример

На дату 10.07.2023 дата и время начала и окончания периода действия для лимита на снятие наличных с карты в день будут 2023-07-10T00:00:00+03:00 и 2023-07-10T23:59:59+03:00 соответственно, в месяц — 2023-07-01T00:00:00+03:00 и 2023-07-31T23:59:59+03:00.

Поддерживаемые типы лимитов и периоды действия см. в документации Limits API.
maxValue — значение лимита в рублях.
Пример
- Максимально допустимая сумма остатка на счёте клиента установлена 60 000 рублей.
- Максимально допустимая сумма снятия наличных с карты установлена 5 000 рублей.
accumulatedValue — израсходованная сумма в рамках лимита в рублях.

Пример

Лимит на снятие наличных с карты установлен 5 000 рублей в день. Клиент снял 3 000 рублей 02.06.2023. Израсходованная сумма в рамках лимита того же дня (02.06.2023) — 3 000 рублей.
remainingValue — остаток в рамках лимита в рублях.

Пример

Лимит на снятие наличных с карты установлен 5 000 рублей в день. Клиент снял 3 000 рублей 02.06.2023. Остаток в рамках лимита того же дня (02.06.2023) — 2 000 рублей.

Свойство, которым обладают только партнёрские лимиты:

dateFrom, dateTill — срок действия лимита.

Пример

Лимит применяется в период с 01.01.2022 00:00:00 до 31.01.2023 23:59:59. После 31.01.2023 23:59:59 он перестанет считаться действующим.

Разные лимиты могут относиться к одному и тому же типу и отличаться другими свойствами: см. Пример 2 раздела «Получение информации о лимитах».

Виды лимитов¶

Сервисные лимиты¶

Сервисные лимиты устанавливаются BaaS согласно требованиям действующего законодательства или внутренним банковским требованиям. Такие лимиты применяются к операциям по умолчанию.

Список сервисных лимитов см. в статье «BaaS → «Идентификация» → «Уровни» → «Лимиты». Здесь мы расскажем об особенностях некоторых сервисных лимитов.

Лимит на допустимый остаток на счёте клиента

Данный лимит относится к типу BALANCE и не имеет периода или срока действия: в каждый момент времени у клиента на счёте может храниться не больше N рублей.

Период действия такого лимита — всё время жизни продукта.

Для лимита с типом BALANCE:

значение accumulatedValue равно текущему балансу счёта клиента;
значение remainingValue означает максимально допустимую сумму, на которую клиент может пополнить баланс своего счёта.

Лимит с типом BALANCE не возвращается в ответе на запрос получения информации, если для клиента не создан счёт.

Лимит типа BALANCE не обновляется, так как не имеет конкретного периода действия.

Партнёрские лимиты¶

Партнёрские лимиты устанавливаются партнёром, если продукт не может быть предоставлен клиенту без применения дополнительных ограничений. Такие лимиты относятся к типу CUSTOMIZABLE_EXPENSE_OPERATIONS, применяются только к операциям категории «Платежи и переводы» и могут иметь один из следующих периодов действия (periodType):

ON_DAY — день;
ON_MONTH — месяц.

Остальные значения для periodType не поддерживаются.

Для установки лимита партнёр выполняет запрос на установку лимита для платежей и переводов к API Limits.

Обновление лимитов¶

Время обновления лимитов зависит от periodType — периода действия лимита. Лимит с periodType:ON_DAY обновляется ежедневно, лимит с periodType:ON_MONTH обновляется ежемесячно и т.д.

В качестве примера см. Пример 1 раздела «Получение информации о лимитах».

Обратите внимание

Лимит с periodType:LIFETIME не обновляется никогда.

Получение информации о лимитах¶

Партнёр может получить список действующих для клиента лимитов, выполнив запрос на получение информации о лимитах к API Limits.

Ответ на запрос информации представляет собой JSON-объект и содержит список как сервисных, так и партнёрских лимитов.

Обратите внимание

Для фильтра информации по типам лимитов можно использовать параметр запроса limitTypes. Если его не указывать, вернётся список всех лимитов, независимо от типа.

Элемент списка содержит информацию о свойствах каждого отдельного лимита.

Пример 1Пример 2

Пример ответа, согласно которому для клиента установлен лимит на платежи и переводы до 200 000 рублей в месяц, размещён ниже. Из ответа следует, что:

клиент совершил платежи и переводы на общую сумму 199 990,24 рублей в июне 2023 года;
в том же месяце клиент может совершить операции, считающиеся платежами или переводами, на сумму не более 9,76 рубля.

01.07.2023 в 00:00:00 значение accumulatedValue обновится на 0, а значение remainingValue — на 200000.00.

Ответ на запрос получения информации о лимите

  [
    {
        "limitType": "EXPENSE_OPERATIONS",
        "limitPeriod": {
            "periodFrom": "2023-06-01T00:00:00+03:00",
            "periodTill": "2023-06-30T23:59:59+03:00",
            "periodType": "ON_MONTH"
        },
        "maxValue": {
            "type": "MONEY",
            "value": 200000.00,
            "currency": "RUB"
        },
        "accumulatedValue": {
            "type": "MONEY",
            "value": 199990.24,
            "currency": "RUB"
        },
        "remainingValue": {
            "type": "MONEY",
            "value": 9.76,
            "currency": "RUB"
        }
    }
  ]

Разные лимиты для одного клиента могут относиться к одному и тому же типу и отличаться другими свойствами: например, сроком действия.

Пример ответа, согласно которому для одного клиента установлено несколько лимитов на снятие наличных с карты, размещён ниже. Из ответа следует, что:

клиент может снимать с карты до 5 000 рублей в день;
общая сумма снятия наличных за месяц не должна превышать 40 000 рублей.

Ответ на запрос получения информации о лимите

  [
    {
        "maxValue": {
            "type": "MONEY",
            "value": 5000.00,
            "currency": "RUB"
        },
        "accumulatedValue": {
            "type": "MONEY",
            "value": 1.57,
            "currency": "RUB"
        },
        "remainingValue": {
            "type": "MONEY",
            "value": 4998.43,
            "currency": "RUB"
        },
        "limitPeriod": {
            "periodFrom": "2022-02-03T00:00:00+03:00",
            "periodTill": "2022-02-03T23:59:59+03:00",
            "periodType": "ON_DAY"
        },
        "limitType": "CASH_WITHDRAWAL_OPERATIONS"
    },
    {
        "maxValue": {
            "type": "MONEY",
            "value": 40000.00,
            "currency": "RUB"
        },
        "accumulatedValue": {
            "type": "MONEY",
            "value": 1.57,
            "currency": "RUB"
        },
        "remainingValue": {
            "type": "MONEY",
            "value": 39998.43,
            "currency": "RUB"
        },
        "limitPeriod": {
            "periodFrom": "2022-02-01T00:00:00+03:00",
            "periodTill": "2022-02-28T23:59:59+03:00",
            "periodType": "ON_MONTH"
        },
        "limitType": "CASH_WITHDRAWAL_OPERATIONS"
    }
  ]

Обратите внимание

Ответы приведены в качестве примера: актуальные формат и список параметров см. в документации API Limits.
periodFrom и periodTill не возвращаются для periodType:LIFETIME.