Заказ справки по депозиту

Песочница

POST https://sandbox.alfabank.ru/api/pp/v1/reports/type/deposit

Пром

POST https://baas.alfabank.ru/api/pp/v1/reports/type/deposit

Scope

deposit-statements

Описание

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

Используйте следующие методы для того, чтобы:

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

HEADERS

Атрибут

Описание

Authorization

stringrequired

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

stringrequired

application/json

Content-Type

stringrequired

application/json

BODY

Атрибут

Описание

accountIds

array of stringsrequired

Массив выбранных счетов, по которым заказывается справка

Пример запроса

Язык

1curl --location 'https://baas.alfabank.ru/api/pp/v1/reports/type/deposit' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Content-Type: application/json' \
4--header 'Accept: application/json' \
5--data '{
6  "accountIds": [
7    "40817810704980004078",
8    "40817810304100012280"
9  ]
10}'

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

Пример ответа 201 (Created)

1{
2  "date": "2023-01-25T12:00:17.935Z",
3  "id": "63d119d1bbefcc000184ce2f",
4  "type": {
5    "code": "ufr_stmt_physical_deposit",
6    "title": "Справка по депозиту"
7  },
8  "status": {
9    "code": "NEW",
10    "title": "Новый"
11  }
12}

BODY

атрибут

описание

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

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

Пример ответа 201 (Created)

1{
2  "date": "2023-01-25T12:00:17.935Z",
3  "id": "63d119d1bbefcc000184ce2f",
4  "type": {
5    "code": "ufr_stmt_physical_deposit",
6    "title": "Справка по депозиту"
7  },
8  "status": {
9    "code": "NEW",
10    "title": "Новый"
11  }
12}

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}

Нет тела ответа