B2C

Получение пользовательских лимитов клиента

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

limits-control

Описание

Позволяет получить пользовательские лимиты по карте клиента с детальной информацией по:

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

application/json

PATH
Атрибут
Описание
cardId
stringrequired
Пример запроса
Язык 
1curl --location --globoff 'https://baas.alfabank.ru/api/pp/v1/cards/{cardId}/user-limits' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Accept: application/json'
Параметры ответа
Пример ответа 200 (OK) 
1{
2  "limits": [
3    {
4      "id": 186,
5      "activity": {
6        "from": "04-06-2020",
7        "to": "30-06-2025"
8      },
9      "validity": "wholePeriod",
10      "created": "2020-06-04",
11      "coveredOperations": [
12        "onlineShopping",
13        "allDebits"
14      ],
15      "limits": {
16        "single": {
17          "value": 1000,
18          "currency": "RUR",
19          "minorUnits": 1
20        },
21        "max": {
22          "value": 100000,
23          "currency": "RUR",
24          "minorUnits": 1
25        },
26        "rest": {
27          "value": 10000000,
28          "currency": "RUR",
29          "minorUnits": 100
30        },
31        "turnover": {
32          "value": 0,
33          "currency": "RUR",
34          "minorUnits": 100
35        }
36      },
37      "countriesRestrictions": {
38        "restrictionType": "including",
39        "list": [
40          {
41            "isoCode": "51",
42            "description": "Armenia"
43          },
44          {
45            "isoCode": "156",
46            "description": "Австралия И Новая зеландия"
47          },
48          {
49            "isoCode": "392",
50            "description": "Commonwealth Of Independent States"
51          }
52        ]
53      }
54    },
55    {
56      "id": 181,
57      "activity": {
58        "from": "04-06-2020",
59        "to": "30-06-2020"
60      },
61      "validity": "wholePeriod",
62      "created": "2020-06-04",
63      "coveredOperations": [
64        "allDebits",
65        "onlineShopping",
66        "cashWithdrawals"
67      ],
68      "limits": {
69        "single": {
70          "value": 5000,
71          "currency": "RUR",
72          "minorUnits": 1
73        },
74        "max": {
75          "value": 100000,
76          "currency": "RUR",
77          "minorUnits": 1
78        },
79        "rest": {
80          "value": 10000000,
81          "currency": "RUR",
82          "minorUnits": 100
83        },
84        "turnover": {
85          "value": 0,
86          "currency": "RUR",
87          "minorUnits": 100
88        }
89      },
90      "countriesRestrictions": {
91        "restrictionType": "excluding",
92        "list": []
93      }
94    },
95    {
96      "id": 187,
97      "activity": {
98        "from": "30-07-2020",
99        "to": "31-07-2023"
100      },
101      "validity": "wholePeriod",
102      "created": "2020-07-30",
103      "coveredOperations": [
104        "allDebits",
105        "onlineShopping",
106        "cashWithdrawals"
107      ],
108      "limits": {
109        "single": {
110          "value": 2568,
111          "currency": "EUR",
112          "minorUnits": 1
113        },
114        "max": {
115          "value": 256,
116          "currency": "EUR",
117          "minorUnits": 1
118        },
119        "rest": {
120          "value": 25600,
121          "currency": "EUR",
122          "minorUnits": 100
123        },
124        "turnover": {
125          "value": 0,
126          "currency": "EUR",
127          "minorUnits": 100
128        }
129      },
130      "countriesRestrictions": {
131        "restrictionType": "excluding",
132        "list": [
133          {
134            "isoCode": "643",
135            "description": "Russian Federation"
136          }
137        ]
138      }
139    }
140  ]
141}
BODY
атрибут
описание
array of objectsrequired

Список пользовательских лимитов по карте

id
integerrequired

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

objectoptional

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

from
stringrequired

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

to
stringrequired

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

validity
stringoptional

Период применения лимита. Принимает возможные значения:

  • •
    wholePeriod - весь период;
  • •
    daily - день;
  • •
    weekly - неделя;
  • •
    monthly - месяц
created
stringrequired

Дата создания лимита

coveredOperations
array of stringsoptional

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

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

Значения лимитов

objectrequired

Значение лимита на одну операцию

value
integerrequired

Значение

currency
stringrequired

Код валюты

minorUnits
integerrequired

Минорные единицы

objectrequired

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

value
integerrequired

Значение

currency
stringrequired

Код валюты

minorUnits
integerrequired

Минорные единицы

objectoptional

Остаток доступного лимита

value
integerrequired

Значение

currency
stringrequired

Код валюты

minorUnits
integerrequired

Минорные единицы

objectoptional

Оборот за период

value
integerrequired

Значение

currency
stringrequired

Код валюты

minorUnits
integerrequired

Минорные единицы

objectrequired

Ограничения лимита по странам

restrictionType
stringoptional

Тип применения ограничения. Принимает возможные значения:

  • •
    all - во всех странах;
  • •
    including - только в перечисленных странах;
  • •
    excluding - во всех странах, кроме перечисленных
array of objectsoptional

Список стран, к которым применяется ограничение

isoCode
stringoptional

ISO-код страны

description
stringoptional

Наименование страны

Пример ответа 200 (OK) 
1{
2  "limits": [
3    {
4      "id": 186,
5      "activity": {
6        "from": "04-06-2020",
7        "to": "30-06-2025"
8      },
9      "validity": "wholePeriod",
10      "created": "2020-06-04",
11      "coveredOperations": [
12        "onlineShopping",
13        "allDebits"
14      ],
15      "limits": {
16        "single": {
17          "value": 1000,
18          "currency": "RUR",
19          "minorUnits": 1
20        },
21        "max": {
22          "value": 100000,
23          "currency": "RUR",
24          "minorUnits": 1
25        },
26        "rest": {
27          "value": 10000000,
28          "currency": "RUR",
29          "minorUnits": 100
30        },
31        "turnover": {
32          "value": 0,
33          "currency": "RUR",
34          "minorUnits": 100
35        }
36      },
37      "countriesRestrictions": {
38        "restrictionType": "including",
39        "list": [
40          {
41            "isoCode": "51",
42            "description": "Armenia"
43          },
44          {
45            "isoCode": "156",
46            "description": "Австралия И Новая зеландия"
47          },
48          {
49            "isoCode": "392",
50            "description": "Commonwealth Of Independent States"
51          }
52        ]
53      }
54    },
55    {
56      "id": 181,
57      "activity": {
58        "from": "04-06-2020",
59        "to": "30-06-2020"
60      },
61      "validity": "wholePeriod",
62      "created": "2020-06-04",
63      "coveredOperations": [
64        "allDebits",
65        "onlineShopping",
66        "cashWithdrawals"
67      ],
68      "limits": {
69        "single": {
70          "value": 5000,
71          "currency": "RUR",
72          "minorUnits": 1
73        },
74        "max": {
75          "value": 100000,
76          "currency": "RUR",
77          "minorUnits": 1
78        },
79        "rest": {
80          "value": 10000000,
81          "currency": "RUR",
82          "minorUnits": 100
83        },
84        "turnover": {
85          "value": 0,
86          "currency": "RUR",
87          "minorUnits": 100
88        }
89      },
90      "countriesRestrictions": {
91        "restrictionType": "excluding",
92        "list": []
93      }
94    },
95    {
96      "id": 187,
97      "activity": {
98        "from": "30-07-2020",
99        "to": "31-07-2023"
100      },
101      "validity": "wholePeriod",
102      "created": "2020-07-30",
103      "coveredOperations": [
104        "allDebits",
105        "onlineShopping",
106        "cashWithdrawals"
107      ],
108      "limits": {
109        "single": {
110          "value": 2568,
111          "currency": "EUR",
112          "minorUnits": 1
113        },
114        "max": {
115          "value": 256,
116          "currency": "EUR",
117          "minorUnits": 1
118        },
119        "rest": {
120          "value": 25600,
121          "currency": "EUR",
122          "minorUnits": 100
123        },
124        "turnover": {
125          "value": 0,
126          "currency": "EUR",
127          "minorUnits": 100
128        }
129      },
130      "countriesRestrictions": {
131        "restrictionType": "excluding",
132        "list": [
133          {
134            "isoCode": "643",
135            "description": "Russian Federation"
136          }
137        ]
138      }
139    }
140  ]
141}
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}
Нет тела ответа
Получение базовых лимитовСоздание пользовательского лимита