B2C

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

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

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

Scope

limits-control

Описание

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

  • •
    времени действия;
  • •
    периоду;
  • •
    типу операций;
  • •
    странам, на которые распространяется установленный лимит.

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

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

application/json

Authorization
stringrequired

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

Пример запроса
curl -X GET https://baas.alfabank.ru/api/pp/v1/cards/123456789/user-limits \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}' \

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

Пример ответа 200 (ОК)
{
  "limits": [
    {
	  "id": 186,
      "activity": {
        "from": "04-06-2020",
        "to": "30-06-2025"
      },
      "validity": "wholePeriod",
	  "created": "2020-06-04",
      "coveredOperations": [
        "onlineShopping",
        "allDebits"
      ],
      "limits": {
        "single": {
          "value": 1000,
          "currency": "RUR",
          "minorUnits": 1
        },
        "max": {
          "value": 100000,
          "currency": "RUR",
          "minorUnits": 1
        },
        "rest": {
          "value": 10000000,
          "currency": "RUR",
          "minorUnits": 100
        },
        "turnover": {
          "value": 0,
          "currency": "RUR",
          "minorUnits": 100
        }
      },
      "countriesRestrictions": {
        "restrictionType": "including",
        "list": [
          {
            "isoCode": "51",
            "description": "Armenia"
          },
          {
            "isoCode": "156",
            "description": "Австралия И Новая зеландия"
          },
          {
            "isoCode": "392",
            "description": "Commonwealth Of Independent States"
          }
        ]
      }
    },
    {
	  "id": 181,
      "activity": {
        "from": "04-06-2020",
        "to": "30-06-2020"
      },
      "validity": "wholePeriod",
	  "created": "2020-06-04",
      "coveredOperations": [
        "allDebits",
        "onlineShopping",
        "cashWithdrawals"
      ],
      "limits": {
        "single": {
          "value": 5000,
          "currency": "RUR",
          "minorUnits": 1
        },
        "max": {
          "value": 100000,
          "currency": "RUR",
          "minorUnits": 1
        },
        "rest": {
          "value": 10000000,
          "currency": "RUR",
          "minorUnits": 100
        },
        "turnover": {
          "value": 0,
          "currency": "RUR",
          "minorUnits": 100
        }
      },
      "countriesRestrictions": {
        "restrictionType": "excluding",
        "list": []
      }
    },
    {
	  "id": 187,
      "activity": {
        "from": "30-07-2020",
        "to": "31-07-2023"
      },
      "validity": "wholePeriod",
	  "created": "2020-07-30",
      "coveredOperations": [
        "allDebits",
        "onlineShopping",
        "cashWithdrawals"
      ],
      "limits": {
        "single": {
          "value": 2568,
          "currency": "EUR",
          "minorUnits": 1
        },
        "max": {
          "value": 256,
          "currency": "EUR",
          "minorUnits": 1
        },
        "rest": {
          "value": 25600,
          "currency": "EUR",
          "minorUnits": 100
        },
        "turnover": {
          "value": 0,
          "currency": "EUR",
          "minorUnits": 100
        }
      },
      "countriesRestrictions": {
        "restrictionType": "excluding",
        "list": [
          {
            "isoCode": "643",
            "description": "Russian Federation"
          }
        ]
      }
    }
  ]
}
array of objectrequired

Лимиты

id
integerrequired

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

objectoptional

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

from
stringrequired

Дата начала действия лимита

to
stringrequired

Дата завершения действия лимита

validity
stringoptional

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

created
stringrequired

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

coveredOperations
array of stringoptional

Тип операций. Принимает возможные значения: 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 objectoptional

Список стран

isoCode
stringoptional

ISO код страны

description
stringoptional

Описание страны

Пример ответа 200 (ОК)
{
  "limits": [
    {
	  "id": 186,
      "activity": {
        "from": "04-06-2020",
        "to": "30-06-2025"
      },
      "validity": "wholePeriod",
	  "created": "2020-06-04",
      "coveredOperations": [
        "onlineShopping",
        "allDebits"
      ],
      "limits": {
        "single": {
          "value": 1000,
          "currency": "RUR",
          "minorUnits": 1
        },
        "max": {
          "value": 100000,
          "currency": "RUR",
          "minorUnits": 1
        },
        "rest": {
          "value": 10000000,
          "currency": "RUR",
          "minorUnits": 100
        },
        "turnover": {
          "value": 0,
          "currency": "RUR",
          "minorUnits": 100
        }
      },
      "countriesRestrictions": {
        "restrictionType": "including",
        "list": [
          {
            "isoCode": "51",
            "description": "Armenia"
          },
          {
            "isoCode": "156",
            "description": "Австралия И Новая зеландия"
          },
          {
            "isoCode": "392",
            "description": "Commonwealth Of Independent States"
          }
        ]
      }
    },
    {
	  "id": 181,
      "activity": {
        "from": "04-06-2020",
        "to": "30-06-2020"
      },
      "validity": "wholePeriod",
	  "created": "2020-06-04",
      "coveredOperations": [
        "allDebits",
        "onlineShopping",
        "cashWithdrawals"
      ],
      "limits": {
        "single": {
          "value": 5000,
          "currency": "RUR",
          "minorUnits": 1
        },
        "max": {
          "value": 100000,
          "currency": "RUR",
          "minorUnits": 1
        },
        "rest": {
          "value": 10000000,
          "currency": "RUR",
          "minorUnits": 100
        },
        "turnover": {
          "value": 0,
          "currency": "RUR",
          "minorUnits": 100
        }
      },
      "countriesRestrictions": {
        "restrictionType": "excluding",
        "list": []
      }
    },
    {
	  "id": 187,
      "activity": {
        "from": "30-07-2020",
        "to": "31-07-2023"
      },
      "validity": "wholePeriod",
	  "created": "2020-07-30",
      "coveredOperations": [
        "allDebits",
        "onlineShopping",
        "cashWithdrawals"
      ],
      "limits": {
        "single": {
          "value": 2568,
          "currency": "EUR",
          "minorUnits": 1
        },
        "max": {
          "value": 256,
          "currency": "EUR",
          "minorUnits": 1
        },
        "rest": {
          "value": 25600,
          "currency": "EUR",
          "minorUnits": 100
        },
        "turnover": {
          "value": 0,
          "currency": "EUR",
          "minorUnits": 100
        }
      },
      "countriesRestrictions": {
        "restrictionType": "excluding",
        "list": [
          {
            "isoCode": "643",
            "description": "Russian Federation"
          }
        ]
      }
    }
  ]
}
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"
}
Нет тела ответа

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

Получение базовых лимитовСоздание пользовательского лимита