B2C

Получение информации по счёту

Песочница
GET https://sandbox.alfabank.ru/api/pp/v1/accounts/{accountNumber}
Пром
GET https://baas.alfabank.ru/api/pp/v1/accounts/{accountNumber}
Scope

accounts

Параметры запроса
HEADERS
Атрибут
Описание
Authorization
stringrequired
Accept
stringrequired

application/json

PATH
Атрибут
Описание
accountNumber
stringrequired
Пример запроса
Язык
1curl --location --globoff 'https://baas.alfabank.ru/api/pp/v1/accounts/{accountNumber}' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Accept: application/json'
Параметры ответа
Пример ответа 200 (OK)
1{
2  "mnemonic": "Имя счёта 4078",
3  "number": "40817810704980004078",
4  "type": "EE",
5  "typeDescription": "Текущий счёт ФЛ (НРБ)",
6  "status": "ACTIVE",
7  "dateCreated": "2011-10-14",
8  "balance": {
9    "currency": "RUR",
10    "minorUnits": 100,
11    "holds": 22222,
12    "amount": 24000
13  }
14}
BODY
атрибут
описание
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  "mnemonic": "Имя счёта 4078",
3  "number": "40817810704980004078",
4  "type": "EE",
5  "typeDescription": "Текущий счёт ФЛ (НРБ)",
6  "status": "ACTIVE",
7  "dateCreated": "2011-10-14",
8  "balance": {
9    "currency": "RUR",
10    "minorUnits": 100,
11    "holds": 22222,
12    "amount": 24000
13  }
14}
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 — у пользователя нет прав на использование запрашиваемого сервиса, доступ к которому не предусмотрен настройками scope;
  • 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}
Нет тела ответа