B2C

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

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

limits-control

Описание

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

  • •
    времени действия;
  • •
    периода;
  • •
    типа совершаемых операций.
Параметры запроса
HEADERS
Атрибут
Описание
Authorization
stringrequired
Accept
stringrequired

application/json

Content-Type
stringrequired

application/json

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

Срок действия лимита

from
stringrequired

Дата начала действия лимита в формате DD-MM-YYYY

to
stringrequired

Дата окончания действия лимита в формате DD-MM-YYYY

validity
stringoptional

Периодичность применения лимита. Возможные значения

  • •
    wholePeriod - весь период;
  • •
    daily - день;
  • •
    weekly - неделя;
  • •
    monthly - месяц
coveredOperations
array of stringsoptional

Типы операций, на которые распространяется лимит. Возможные значения:

  • •
    allDebits - расходные операции;
  • •
    onlineShopping - операции в интернет;
  • •
    cashWithdrawals - снятие наличных
objectoptional

Лимиты

objectrequired

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

value
integerrequired

Значение

objectrequired

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

value
integerrequired

Значение

objectoptional

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

value
integerrequired

Значение

objectoptional

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

value
integerrequired

Значение

Пример запроса
Язык
1curl --location --globoff 'https://baas.alfabank.ru/api/pp/v1/cards/{cardId}/user-limits' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Content-Type: application/json' \
4--header 'Accept: application/json' \
5--data '{
6  "activity": {
7    "from": "20-01-2023",
8    "to": "16-11-2023"
9  },
10  "coveredOperations": [
11    "onlineShopping",
12    "allDebits"
13  ],
14  "validity": "wholePeriod",
15  "limits": {
16    "single": {
17      "value": 10000,
18      "currency": "RUR",
19      "minorUnits": 1
20    },
21    "rest": {
22      "value": 2000000,
23      "currency": "RUR",
24      "minorUnits": 100
25    },
26    "max": {
27      "value": 20000,
28      "currency": "RUR",
29      "minorUnits": 1
30    },
31    "turnover": {
32      "value": 0,
33      "currency": "RUR",
34      "minorUnits": 100
35    }
36  }
37}'
Параметры ответа
Пример ответа 200 (OK)
1{
2  "id": 186
3}
BODY
атрибут
описание
id
integerrequired

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

Пример ответа 200 (OK)
1{
2  "id": 186
3}
BODY
атрибут
описание
error
stringrequired

Код ошибки. Принимает возможные значения:

  • •
    invalid_request - неверные входные параметры запроса
error_description
stringoptional

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

Пример ошибки 400 (Bad Request)
1{
2  "error": "invalid_request",
3  "error_description": "Authorization header is not present in request headers"
4}
BODY
атрибут
описание
error
stringrequired

Код ошибки. Принимает возможные значения:

  • •
    invalid_token - предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам. При истечении срока жизни токена необходимо обновить его с помощью refresh_token. При отзыве токена необходимо заново пройти авторизацию
error_description
stringoptional

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

Пример ошибки 401 (Unauthorized)
1{
2  "error": "invalid_token",
3  "error_description": "The access token provided is expired, revoked, malformed, or invalid for other reasons"
4}
BODY
атрибут
описание
error
stringrequired

Код ошибки. Принимает возможные значения:

  • •
    insufficient_scope - при запросе кода авторизации не были переданы все необходимые scopes. Необходимо переподписать договор согласия, повторно отправив запрос на получение кода авторизации с указанием всех доступных scopes и параметра prompt=consent;
  • •
    access_denied - доступ к счёту запрещён
error_description
stringoptional

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

Пример ошибки 403 (Forbidden)
1{
2  "error": "insufficient_scope",
3  "error_description": "The request requires higher privileges than provided by the access token"
4}
BODY
атрибут
описание
error
stringrequired

Код ошибки. Принимает возможные значения:

  • •
    unknown_endpoint - эндпоинт не найден или неактивен
error_description
stringoptional

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

Пример ошибки 404 (Not Found)
1{
2  "error": "unknown_endpoint",
3  "error_description": "Endpoint is not found or not active"
4}
Нет тела ответа
BODY
атрибут
описание
error
stringrequired

Код ошибки. Принимает возможные значения:

  • •
    internal_error - внутренняя ошибка сервиса при выполнении обработки запроса
error_description
stringoptional

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

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