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

Песочница

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

Пром

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

Scope

accounts

Описание

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

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

HEADERS

Атрибут

Описание

Authorization

stringrequired

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

stringrequired

application/json

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

Язык

1curl --location 'https://baas.alfabank.ru/api/pp/v1/accounts' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Accept: application/json'

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

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

1{
2  "accounts": [
3    {
4      "mnemonic": "Имя счёта 4078",
5      "number": "40817810704980004078",
6      "type": "EE",
7      "typeDescription": "Текущий счёт ФЛ (НРБ)",
8      "status": "ACTIVE",
9      "dateCreated": "2011-10-14",
10      "balance": {
11        "currency": "RUR",
12        "minorUnits": 100,
13        "holds": 22222,
14        "amount": 24000
15      }
16    },
17    {
18      "mnemonic": "moneyway",
19      "number": "40817810704980004078",
20      "type": "EH",
21      "typeDescription": "Текущий счёт",
22      "status": "ACTIVE",
23      "dateCreated": "2021-08-23",
24      "balance": {
25        "currency": "RUR",
26        "minorUnits": 100,
27        "holds": 10000,
28        "amount": 50000
29      }
30    }
31  ]
32}

BODY

атрибут

описание

array of objectsrequired

Массив счетов

mnemonic

stringrequired

Наименование счёта

number

stringrequired

Номер счёта

type

stringrequired

Тип счёта

typeDescription

stringoptional

Описание типа счёта

status

stringrequired

Статус счёта. Принимает возможные значения:

•

ACTIVE - активный;
•

INACTIVE - неактивный

dateCreated

stringrequired

Дата открытия счёта в формате YYYY-MM-DD

objectrequired

Баланс счёта

currency

stringrequired

Валюта счёта (ISO 4217 Code). Список доступных валют указан в таблице в конце страницы

minorUnits

integerrequired

Количество минорных единиц

holds

integerrequired

Сумма холдов (резервов) в минорных единицах

amount

integerrequired

Сумма денежных средств в минорных единицах

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

1{
2  "accounts": [
3    {
4      "mnemonic": "Имя счёта 4078",
5      "number": "40817810704980004078",
6      "type": "EE",
7      "typeDescription": "Текущий счёт ФЛ (НРБ)",
8      "status": "ACTIVE",
9      "dateCreated": "2011-10-14",
10      "balance": {
11        "currency": "RUR",
12        "minorUnits": 100,
13        "holds": 22222,
14        "amount": 24000
15      }
16    },
17    {
18      "mnemonic": "moneyway",
19      "number": "40817810704980004078",
20      "type": "EH",
21      "typeDescription": "Текущий счёт",
22      "status": "ACTIVE",
23      "dateCreated": "2021-08-23",
24      "balance": {
25        "currency": "RUR",
26        "minorUnits": 100,
27        "holds": 10000,
28        "amount": 50000
29      }
30    }
31  ]
32}

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}

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

Таблица возможных значений параметра currency

Значение	Описание
AED	Дирхам ОАЭ
AMD	Армянский драм
AUD	Австралийский доллар
AZN	Азербайджанский манат
BGN	Болгарский лев
BRL	Бразильский реал
BYN	Белорусский рубль
CAD	Канадский доллар
CHF	Швейцарский франк
CNY	Юань