B2C

Получение списка заказанных документов

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

reports-downloading

Описание

В рамках вызова данного метода пользователь получает перечень заказанных документов с указанием:

  • •
    даты формирования;
  • •
    типа документа;
  • •
    статуса документа.

На данный момент возможно получение только справок и выписок, но перечень документов будет расширяться.

Для того чтобы получить файл заказанного документа, используйте метод Получение файла справки или выписки.

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

application/json

Пример запроса
Язык 
1curl --location 'https://baas.alfabank.ru/api/pp/v1/reports' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Accept: application/json'
Параметры ответа
Пример ответа 200 (OK) 
1{
2  "reports": [
3    {
4      "date": "2023-01-25T12:00:17.935Z",
5      "id": "62c4f39c5f1503000128a5e2",
6      "type": {
7        "code": "ufr_stmt_physical_deposit",
8        "title": "Справка по депозиту"
9      },
10      "status": {
11        "code": "FINISHED",
12        "title": "Завершён"
13      }
14    },
15    {
16      "date": "2023-01-25T12:08:03.415Z",
17      "id": "62c4f39c5f1503000128a5e3",
18      "type": {
19        "code": "ufr_stmt_physical_closed_credit_sfa",
20        "title": "Справка о закрытых кредитах"
21      },
22      "status": {
23        "code": "FINISHED",
24        "title": "Завершён"
25      }
26    }
27  ]
28}
BODY
атрибут
описание
array of objectsoptional

Информация о заказанных справках и выписках

id
stringrequired

Идентификатор отчёта

date
stringrequired

Дата формирования объекта заказа

objectrequired

Информация о типе справки или выписки

code
stringrequired

Код типа документа

title
stringrequired

Название документа

objectrequired

Статус заказанного документа

code
stringrequired

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

  • •
    NEW
  • •
    ENQUEUED
  • •
    ENQUEUED_POST_PROCESS
  • •
    PENDING
  • •
    STARTED
  • •
    FINISHED
  • •
    REJECTED
  • •
    LOADED
  • •
    LOADED_SIGNED
  • •
    ERROR
  • •
    REVISION
title
stringrequired

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

Пример ответа 200 (OK) 
1{
2  "reports": [
3    {
4      "date": "2023-01-25T12:00:17.935Z",
5      "id": "62c4f39c5f1503000128a5e2",
6      "type": {
7        "code": "ufr_stmt_physical_deposit",
8        "title": "Справка по депозиту"
9      },
10      "status": {
11        "code": "FINISHED",
12        "title": "Завершён"
13      }
14    },
15    {
16      "date": "2023-01-25T12:08:03.415Z",
17      "id": "62c4f39c5f1503000128a5e3",
18      "type": {
19        "code": "ufr_stmt_physical_closed_credit_sfa",
20        "title": "Справка о закрытых кредитах"
21      },
22      "status": {
23        "code": "FINISHED",
24        "title": "Завершён"
25      }
26    }
27  ]
28}
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 - предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам. При истечении срока жизни токена необходимо обновить его с помощью refresh_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}
Нет тела ответа
Заказ справки по депозитуПолучение файла документа