Scope
credit-statements
Описание
В рамках вызова данного метода пользователь оформляет заказ справки с синим штампом и реквизитами банка, в которой указаны условия договора, остаток задолженности, начисленные проценты на текущую дату и история операций.
Используйте следующие методы для того, чтобы:
-
•
-
•
Параметры запроса
Bearer {access_token}, полученный по Authorization Code Flow
application/json
application/json
Массив выбранных счетов, по которым заказывается справка
Дата, c которой формируется выписка, в формате YYYY-MM-DD
Дата, до которой формируется выписка, в формате YYYY-MM-DD
Номер кредитного договора
Детальная информация по депозиту
1curl --location 'https://baas.alfabank.ru/api/api/pp/v1/reports/type/credit/statement' \
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 "dateBegin": "2000-01-23",
11 "dateEnd": "2000-01-23",
12 "agreementNumber": "F0TCRC20S19031508353",
13 "operationsHistory": true
14}'Параметры ответа
1{
2 "date": "2023-01-25T12:17:57.831Z",
3 "id": "63d11df5bbefcc000184ce44",
4 "type": {
5 "code": "ufr_stmt_physical_credit_product",
6 "title": "Выписка по кредиту"
7 },
8 "status": {
9 "code": "ENQUEUED",
10 "title": "В очереди на оформление"
11 }
12}Идентификатор отчёта
Дата формирования объекта заказа
Информация о типе справки/выписки
Код типа документа
Название документа
Статус заказанного документа
Код статуса. Принимает возможные значения:
-
•
NEW -
•
ENQUEUED -
•
ENQUEUED_POST_PROCESS -
•
PENDING -
•
STARTED -
•
FINISHED -
•
REJECTED -
•
LOADED -
•
LOADED_SIGNED -
•
ERROR -
•
REVISION
Описание статуса
1{
2 "date": "2023-01-25T12:17:57.831Z",
3 "id": "63d11df5bbefcc000184ce44",
4 "type": {
5 "code": "ufr_stmt_physical_credit_product",
6 "title": "Выписка по кредиту"
7 },
8 "status": {
9 "code": "ENQUEUED",
10 "title": "В очереди на оформление"
11 }
12}Код ошибки. Принимает возможные значения:
-
•
invalid_request- неверные входные параметры запроса
Сообщение об ошибке
1{
2 "error": "invalid_request",
3 "error_description": "Authorization header is not present in request headers"
4}Код ошибки. Принимает возможные значения:
-
•
invalid_token- предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам. При истечении срока жизни токена необходимо обновить его с помощьюrefresh_token. При отзыве токена необходимо заново пройти авторизацию
Сообщение об ошибке
1{
2 "error": "invalid_token",
3 "error_description": "The access token provided is expired, revoked, malformed, or invalid for other reasons"
4}Код ошибки. Принимает возможные значения:
-
•
insufficient_scope- при запросе кода авторизации не были переданы все необходимые scopes. Необходимо переподписать договор согласия, повторно отправив запрос на получение кода авторизации с указанием всех доступных scopes и параметраprompt=consent; -
•
access_denied- доступ к счёту запрещён
Сообщение об ошибке
1{
2 "error": "insufficient_scope",
3 "error_description": "The request requires higher privileges than provided by the access token"
4}Код ошибки. Принимает возможные значения:
-
•
unknown_endpoint- эндпоинт не найден или неактивен
Сообщение об ошибке
1{
2 "error": "unknown_endpoint",
3 "error_description": "Endpoint is not found or not active"
4}Код ошибки. Принимает возможные значения:
-
•
internal_error- внутренняя ошибка сервиса при выполнении обработки запроса
Сообщение об ошибке
1{
2 "error": "internal_error",
3 "error_description": "Internal server error"
4}