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

Песочница

GET https://sandbox.alfabank.ru/api/pp/v1/cards

Пром

GET https://baas.alfabank.ru/api/pp/v1/cards

Scope

cards

Описание

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

•

заблокированным картам;
•

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

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

HEADERS

Атрибут

Описание

Authorization

stringrequired

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

stringrequired

application/json

QUERY

Атрибут

Описание

isBlocked

booleanoptional

Фильтрация получаемых карт по признаку блокировки. Возможные значения:

•

true - заблокированные карты;
•

false - незаблокированные карты

isPinInstalled

booleanoptional

Фильтрация получаемых карт по признаку наличия установленного ПИН-кода. Возможные значения:

•

true - карты с установленным ПИН-кодом;
•

false - карты без ПИН-кода

Пример запроса

Язык

1curl --location --globoff 'https://baas.alfabank.ru/api/pp/v1/cards?isBlocked={isBlocked}&isPinInstalled={isPinInstalled}' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Accept: application/json'

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

Пример ответа 200 (OK)

1{
2  "cards": [
3    {
4      "cardId": "123731041",
5      "maskedNumber": "458443******3430",
6      "type": "ER",
7      "typeDescription": "RR",
8      "title": "VISA Rewards PW",
9      "status": "0",
10      "issueDate": "2021-11-15T08:28:22+03:00",
11      "account": {
12        "number": "40817810605610705598"
13      },
14      "expirationDate": "1126",
15      "isPrimary": true,
16      "isVirtual": false,
17      "isCredit": false,
18      "paymentSystem": "VISA",
19      "state": {
20        "isActive": true,
21        "isBlocked": false,
22        "isClosed": false
23      }
24    },
25    {
26      "cardId": "123731041",
27      "maskedNumber": "458443******3430",
28      "type": "ER",
29      "typeDescription": "RR",
30      "title": "VISA Rewards PW",
31      "status": "0",
32      "issueDate": "2021-11-15T08:28:22+03:00",
33      "account": {
34        "number": "40817810605610705598"
35      },
36      "expirationDate": "1126",
37      "isPrimary": true,
38      "isVirtual": false,
39      "isCredit": false,
40      "paymentSystem": "VISA",
41      "state": {
42        "isActive": true,
43        "isBlocked": false,
44        "isClosed": false
45      }
46    }
47  ]
48}

BODY

атрибут

описание

array of objectsrequired

Объект карты

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 (OK)

1{
2  "cards": [
3    {
4      "cardId": "123731041",
5      "maskedNumber": "458443******3430",
6      "type": "ER",
7      "typeDescription": "RR",
8      "title": "VISA Rewards PW",
9      "status": "0",
10      "issueDate": "2021-11-15T08:28:22+03:00",
11      "account": {
12        "number": "40817810605610705598"
13      },
14      "expirationDate": "1126",
15      "isPrimary": true,
16      "isVirtual": false,
17      "isCredit": false,
18      "paymentSystem": "VISA",
19      "state": {
20        "isActive": true,
21        "isBlocked": false,
22        "isClosed": false
23      }
24    },
25    {
26      "cardId": "123731041",
27      "maskedNumber": "458443******3430",
28      "type": "ER",
29      "typeDescription": "RR",
30      "title": "VISA Rewards PW",
31      "status": "0",
32      "issueDate": "2021-11-15T08:28:22+03:00",
33      "account": {
34        "number": "40817810605610705598"
35      },
36      "expirationDate": "1126",
37      "isPrimary": true,
38      "isVirtual": false,
39      "isCredit": false,
40      "paymentSystem": "VISA",
41      "state": {
42        "isActive": true,
43        "isBlocked": false,
44        "isClosed": false
45      }
46    }
47  ]
48}

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 - предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам. Необходимо получить новый токен доступа

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}

Нет тела ответа