B2C

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

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

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

Scope

accounts

Описание

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

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

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

application/json

Authorization
stringrequired

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

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

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

Пример ответа 200 (ОК)
{
  "accounts": [
    {
      "mnemonic": "Имя счета 4078",
      "number": "40817810704980004078",
      "type": "EE",
      "typeDescription": "Текущий счет ФЛ (НРБ)",
      "status": "ACTIVE",
      "dateCreated": "2011-10-14",
      "balance": {
        "currency": "RUR",
        "minorUnits": 100,
        "holds": 22222,
        "amount": 24000
      }
    },
    {
      "mnemonic": "moneyway",
      "number": "40817810704980004078",
      "type": "EH",
      "typeDescription": "Текущий счёт",
      "status": "ACTIVE",
      "dateCreated": "2021-08-23",
      "balance": {
        "currency": "RUR",
        "minorUnits": 100,
        "holds": 10000,
        "amount": 50000
      }
    }
  ]
}
array of objectrequired

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

mnemonic
stringrequired

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

number
stringrequired

Номер счета

type
stringrequired

Тип счета

typeDescription
stringrequired

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

status
stringrequired

Статус счета. Принимает возможные значения: ACTIVE - активный; INACTIVE - неактивный

dateCreated
stringrequired

Дата открытия счета в формате yyyy-MM-dd

objectrequired

Баланс счета

currency
stringrequired

Валюта счета (ISO 4217 Code)

minorUnits
integerrequired

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

holds
integerrequired

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

amount
integerrequired

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

Пример ответа 200 (ОК)
{
  "accounts": [
    {
      "mnemonic": "Имя счета 4078",
      "number": "40817810704980004078",
      "type": "EE",
      "typeDescription": "Текущий счет ФЛ (НРБ)",
      "status": "ACTIVE",
      "dateCreated": "2011-10-14",
      "balance": {
        "currency": "RUR",
        "minorUnits": 100,
        "holds": 22222,
        "amount": 24000
      }
    },
    {
      "mnemonic": "moneyway",
      "number": "40817810704980004078",
      "type": "EH",
      "typeDescription": "Текущий счёт",
      "status": "ACTIVE",
      "dateCreated": "2021-08-23",
      "balance": {
        "currency": "RUR",
        "minorUnits": 100,
        "holds": 10000,
        "amount": 50000
      }
    }
  ]
}
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"
}
Нет тела ответа

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