B2C

Получение списка карт клиента

Пром GET https://baas.alfabank.ru/api/pp/v1/cards

Песочница GET https://sandbox.alfabank.ru/api/pp/v1/cards

Scope

cards

Описание

С помощью данного метода, клиент получает список карт клиента. В рамках запроса возможно отфильтровать получаемый список по:

  • заблокированным картам;
  • картам, у которых есть установленный пин.

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

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

application/json

Authorization
stringrequired

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

QUERY
Атрибут
Описание
cardFilter
booleanoptional

Фильтрация получаемых карт по следующим признакам: isBlocked - заблокированные карты; isPinInstalled - карты с установленным пином

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

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

Пример ответа 200 (ОК)
{
  "cards": [
    {
      "cardId": "123731041",
      "maskedNumber": "458443******3430",
      "type": "ER",
      "typeDescription": "RR",
      "title": "VISA Rewards PW",
      "status": "0",
      "issueDate": "2021-11-15T08:28:22+03:00",
      "account": {
        "number": "40817810605610705598"
      },
      "expirationDate": "1126",
      "isPrimary": true,
      "isVirtual": false,
      "isCredit": false,
      "paymentSystem": "VISA",
      "state": {
        "isActive": true,
        "isBlocked": false,
        "isClosed": false
      }},
      {
      "cardId": "123456789",
      "maskedNumber": "456985******2517",
      "type": "ER",
      "typeDescription": "RR",
      "title": "VISA Rewards PW",
      "status": "0",
      "issueDate": "2022-12-25T09:27:22+03:00",
      "account": {
        "number": "40817810605610705598"
      },
      "expirationDate": "1227",
      "isPrimary": true,
      "isVirtual": false,
      "isCredit": false,
      "paymentSystem": "VISA",
      "state": {
        "isActive": true,
        "isBlocked": false,
        "isClosed": false
      }
    }
  ]
}
array of objectrequired

Массив карт

cardId
stringrequired

Идентификатор карты

maskedNumber
stringrequired

Маскированный номер карты

type
stringrequired

Тип карты

typeDescription
stringrequired

Тип продукта карты

status
stringrequired

Статус карты

issueDate
stringrequired

Дата выпуска карты в формате ISO

expirationDate
stringrequired

Срок действия карты в формате MMYY

title
stringoptional

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

isPrimary
booleanrequired

Признак основной карты

isVirtual
booleanrequired

Признак виртуальной карты

isCredit
booleanrequired

Признак кредитной карты

objectrequired

Счет карты

number
stringrequired

Номер счета к которому привязана карта

paymentSystem
stringrequired

Платежная система

objectrequired

Настройки карты

isActive
booleanoptional

Карта активна

isBlocked
booleanoptional

Карта заблокирована

isClosed
booleanoptional

Карта закрыта

isPinInstalled
booleanoptional

Пинкод установлен

Пример ответа 200 (ОК)
{
  "cards": [
    {
      "cardId": "123731041",
      "maskedNumber": "458443******3430",
      "type": "ER",
      "typeDescription": "RR",
      "title": "VISA Rewards PW",
      "status": "0",
      "issueDate": "2021-11-15T08:28:22+03:00",
      "account": {
        "number": "40817810605610705598"
      },
      "expirationDate": "1126",
      "isPrimary": true,
      "isVirtual": false,
      "isCredit": false,
      "paymentSystem": "VISA",
      "state": {
        "isActive": true,
        "isBlocked": false,
        "isClosed": false
      }},
      {
      "cardId": "123456789",
      "maskedNumber": "456985******2517",
      "type": "ER",
      "typeDescription": "RR",
      "title": "VISA Rewards PW",
      "status": "0",
      "issueDate": "2022-12-25T09:27:22+03:00",
      "account": {
        "number": "40817810605610705598"
      },
      "expirationDate": "1227",
      "isPrimary": true,
      "isVirtual": false,
      "isCredit": false,
      "paymentSystem": "VISA",
      "state": {
        "isActive": true,
        "isBlocked": false,
        "isClosed": false
      }
    }
  ]
}
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"
}
Нет тела ответа

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