B2C

Заказ справки о доступном остатке на английском

Пром POST https://baas.alfabank.ru/api/pp/v1/reports/type/account/balance/eng

Песочница POST https://sandbox.alfabank.ru/api/pp/v1/reports/type/account/balance/eng

Scope

debit-statements

Описание

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

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

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

application/json

Authorization
stringrequired

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

Content-Type
stringrequired

application/json

BODY
Атрибут
Описание
accountIds
array of stringrequired

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

customNameTranscription
stringoptional

Имя и Фамилия клиента из загран.паспорта

Пример запроса
curl -X POST https://baas.alfabank.ru/api/pp/v1/reports/type/account/balance/eng \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}' \
  -H 'Content-Type: application/json' \
  -d '
    {
      "accountIds": [
        "123455",
      ],
      "customNameTranscription": "FIO"
    }
  '

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

Пример ответа 200 (ОК)
{
  "id": "63d11487bbefcc000184cdfd",
  "date": "2023-01-25T11:37:43.068Z",
  "type": {
    "code": "ufr_stmt_physical_acc_balance_en",
    "title": "О доступном остатке на английском"
  },
  "status": "ENQUEUED"
}
id
stringrequired

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

date
stringrequired

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

objectrequired

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

code
stringrequired

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

title
stringrequired

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

status
stringrequired

Статус заказанного документа. Принимает возможные значения: ENQUEUED - в очереди на оформление; STARTED - оформление; FINISHED - оформление завершено; LOADED - загружена; ERROR - ошибка

Пример ответа 200 (ОК)
{
  "id": "63d11487bbefcc000184cdfd",
  "date": "2023-01-25T11:37:43.068Z",
  "type": {
    "code": "ufr_stmt_physical_acc_balance_en",
    "title": "О доступном остатке на английском"
  },
  "status": "ENQUEUED"
}
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"
}
Нет тела ответа

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