Пром GET https://baas.alfabank.ru/api/pp/v1/reports
Песочница GET https://sandbox.alfabank.ru/api/pp/v1/reports
Scope
reports-downloading
Описание
В рамках вызова данного метода пользователь получает перечень заказанных документов с указанием:
- •даты формирования;
- •типа документа;
- •статуса документа.
На данный момент возможно получение только справок и выписок, но перечень документов будет расширяться.
Для того, чтобы получить файл заказанного документа используйте метод Получение файла справки или выписки.
Параметры запроса
application/json
Bearer {access_token}, полученный по Authorization Code Flow
curl -X GET https://baas.alfabank.ru/api/pp/v1/reports \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
Параметры ответа
{
"reports": [
{
"id": "63ff41ef1f11960001098599",
"date": "2023-03-01T15:15:43.622",
"type": {
"code": "ufr_stmt_physical_deposit",
"title": "Справка по депозиту"
},
"status": "ERROR"
},
{
"id": "63ff3edf1f11960001098595",
"date": "2023-03-01T15:02:39.056",
"type": {
"code": "ufr_stmt_physical_closed_credit_sfa",
"title": "Справка о закрытых кредитах"
},
"status": "FINISHED"
},
{
"id": "63ff3b4c1f11960001098592",
"date": "2023-03-01T14:47:24.843",
"type": {
"code": "ufr_stmt_physical_acc_balance_rur",
"title": "О доступном остатке на русском"
},
"status": "FINISHED"
}
]
}
Идентификатор отчета
Дата формирования объекта заказа
Код типа документа
Название документа
Статус заказанного документа. Принимает возможные значения: ENQUEUED - в очереди на оформление; STARTED - оформление; FINISHED - оформление завершено; LOADED - загружена; ERROR - ошибка
{
"reports": [
{
"id": "63ff41ef1f11960001098599",
"date": "2023-03-01T15:15:43.622",
"type": {
"code": "ufr_stmt_physical_deposit",
"title": "Справка по депозиту"
},
"status": "ERROR"
},
{
"id": "63ff3edf1f11960001098595",
"date": "2023-03-01T15:02:39.056",
"type": {
"code": "ufr_stmt_physical_closed_credit_sfa",
"title": "Справка о закрытых кредитах"
},
"status": "FINISHED"
},
{
"id": "63ff3b4c1f11960001098592",
"date": "2023-03-01T14:47:24.843",
"type": {
"code": "ufr_stmt_physical_acc_balance_rur",
"title": "О доступном остатке на русском"
},
"status": "FINISHED"
}
]
}
Код ошибки. Принимает возможные значения: invalid_request - Неверные входные параметры запроса
Описание ошибки
{
"error": "invalid_request",
"error_description": "Authorization header is not present in request headers"
}
Код ошибки. Принимает возможные значения: invalid_token - Предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам
Описание ошибки
{
"error": "invalid_token",
"error_description": "The access token provided is expired, revoked, malformed, or invalid for other reasons"
}
Код ошибки. Принимает возможные значения: insufficient_scope - у пользователя нет прав на использование запрашиваемого сервиса, доступ к которому не предусмотрен настройками scope; access_denied - доступ к счету запрещен
Описание ошибки
{
"error": "insufficient_scope",
"error_description": "The request requires higher privileges than provided by the access token"
}
Код ошибки. Принимает возможные значения: unknown_endpoint - Эндпоинт не найден или неактивен
Описание ошибки
{
"error": "unknown_endpoint",
"error_description": "Endpoint is not found or not active"
}
Код ошибки. Принимает возможные значения: internal_error - Внутренняя ошибка сервиса при выполнении обработки запроса
Описание ошибки
{
"error": "internal_error",
"error_description": "Internal server error"
}
Значения параметров ошибок могут изменяться. Рекомендуем предусмотреть стандартную обработку ошибок, не описанных в текущей версии документации.