B2C

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

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

reports-downloading

Описание

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

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

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

application/pdf;charset=UTF-8

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

Формат справки или выписки. Возможные значения:

  • •
    PDF - файл в формате pdf
PATH
Атрибут
Описание
reportId
stringrequired
Пример запроса
Язык 
1curl --location --globoff 'https://baas.alfabank.ru/api/pp/v1/reports/{reportId}/body?format={format}' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Accept: application/pdf;charset=UTF-8'
Параметры ответа
1Нет тела ответа
Нет тела ответа
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}
Нет тела ответа
Получение списка заказанных документовПолучение базовых лимитов