B2C

Создание пользовательского лимита

Пром POST https://baas.alfabank.ru/api/pp/v1/cards/{cardId}/user-limits

Песочница POST https://sandbox.alfabank.ru/api/pp/v1/cards/{cardId}/user-limits

Scope

limits-control

Описание

В рамках вызова данного метода клиент может установить лимит на определённую карту для совершения операций с возможностью указания:

  • времени действия;
  • периода;
  • типа совершаемых операций.

Параметры запроса

HEADERS
Атрибут
Описание
Authorization
stringrequired

Bearer {access_token}, полученный по Authorization Code Flow

Accept
stringrequired

application/json

Content-Type
stringrequired

application/json

PATH
Атрибут
Описание
cardId
stringrequired

Идентификатор карты. Для того, чтобы получить cardId используйте метод Получение списка карт клиента

BODY
Атрибут
Описание
objectoptional

Время действия лимита

from
stringrequired

Начало действия лимита. Должно быть позже текущей даты. Формат: dd-MM-yyyy

to
stringrequired

Конец действия лимита. Формат: dd-MM-yyyy

validity
stringoptional

Период лимита. Принимает возможные значения: wholePeriod - весь период; daily - день; weekly - неделя; monthly - месяц

coveredOperations
array of stringoptional

Тип операций. Принимает возможные значения: allDebits - расходные операции; onlineShopping - операции в интернет; cashWithdrawals - снятие наличных

objectoptional

Лимиты

objectrequired

Лимит по сумме разовой операции

value
integerrequired

Значение

objectrequired

Максимальное значение лимита на весь период действия

value
integerrequired

Значение

objectoptional

Лимит на остатки по карте

value
integerrequired

Значение

objectoptional

Лимит по обороту денежных средств на карте на весь период действия

value
integerrequired

Значение

Пример запроса
curl -X POST https://baas.alfabank.ru/api/pp/v1/cards/123456789/user-limits \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}' \
  -H 'Content-Type: application/json' \
  -d '
  {
  "activity": {
    "from": "25-04-2023",
    "to": "27-04-2023"
  },
  "coveredOperations": [
    "onlineShopping"
  ],
  "validity": "wholePeriod",
  "limits": {
    "single": {
       "value" : 100
     },
    "max": {
       "value" : 100
     }
    "rest": {
       "value" : 100
     },
    "turnover": {
       "value" : 100
     }
  }
}
  '

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

Пример ответа 200 (ОК)
{
  "id": 101
}
id
integerrequired

Идентификатор пользовательского лимита

Пример ответа 200 (ОК)
{
  "id": 101
}
error
stringrequired

Код ошибки. Принимает возможные значения: invalid_request - Неверные входные параметры запроса

error_description
stringoptional

Описание ошибки

Пример ошибки 400 (Bad Request)
{
  "error": "invalid_request",
  "error_description": "Authorization header is not present in request headers"
}
error
stringrequired

Код ошибки. Принимает возможные значения: invalid_token - Предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам

error_description
stringoptional

Описание ошибки

Пример ошибки 401 (Unauthorized)
{
  "error": "invalid_token",
  "error_description": "The access token provided is expired, revoked, malformed, or invalid for other reasons"
}
error
stringrequired

Код ошибки. Принимает возможные значения: insufficient_scope - у пользователя нет прав на использование запрашиваемого сервиса, доступ к которому не предусмотрен настройками scope; access_denied - доступ к счету запрещен

error_description
stringoptional

Описание ошибки

Пример ошибки 403 (Forbidden)
{
  "error": "insufficient_scope",
  "error_description": "The request requires higher privileges than provided by the access token"
}
error
stringrequired

Код ошибки. Принимает возможные значения: unknown_endpoint - Эндпоинт не найден или неактивен

error_description
stringoptional

Описание ошибки

Пример ошибки 404 (Not Found)
{
  "error": "unknown_endpoint",
  "error_description": "Endpoint is not found or not active"
}
Нет тела ответа
error
stringrequired

Код ошибки. Принимает возможные значения: internal_error - Внутренняя ошибка сервиса при выполнении обработки запроса

error_description
stringoptional

Описание ошибки

Пример ошибки 500 (Internal Server Error)
{
  "error": "internal_error",
  "error_description": "Internal server error"
}
Нет тела ответа

Значения параметров ошибок могут изменяться. Рекомендуем предусмотреть стандартную обработку ошибок, не описанных в текущей версии документации.