B2C

Получение файла документа

Пром GET https://baas.alfabank.ru/api/pp/v1/reports/{reportId}/body

Песочница GET https://sandbox.alfabank.ru/api/pp/v1/reports/{reportId}/body

Scope

reports-downloading

Описание

Данный метод возвращает файл документа в формате PDF.

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

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

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

application/pdf;charset=UTF-8

Authorization
stringrequired

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

PATH
Атрибут
Описание
reportId
stringrequired

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

QUERY
Атрибут
Описание
format
stringoptional

Формат справки или выписки. Принимает возможные значения: PDF - файл в формате pdf

Пример запроса
curl -X GET https://baas.alfabank.ru/api/pp/v1/reports/63ff41ef1f11960001098599/body \
  -H 'Accept: application/pdf;charset=UTF-8' \
  -H 'Authorization: Bearer {access-token}' \

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

Пример ответа 200 (ОК)
pdf file
Пример ответа 200 (ОК)
pdf file
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"
}
Нет тела ответа

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