B2BH2H

Создание заявки на отчет по переводу средств через СБП

Пром POST https://baas.alfabank.ru/api/reports/payments-sbp

Песочница POST https://sandbox.alfabank.ru/api/reports/payments-sbp

Scope

report-sbp

Описание

Метод предназначен для получения информации о комиссии, взимаемой за операции СБП по всем тарифам. Метод инициирует асинхронный процесс формирования отчета. Можно получить два вида отчетов:

  • Агрегированный - сводный отчет по магазинам;
  • Детализированный - потранзакционный отчет в разрезе конкретного магазина.

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

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

Bearer {access_token}, полученный по Client Credentials Flow

Accept
stringrequired

application/json

Content-Type
stringrequired

application/json

BODY
Атрибут
Описание
type
stringrequired

Код типа отчета. Возможные значения: 1 - Агрегированный отчет; 2 - Детализированный отчет

date
stringrequired

Дата, на которую необходимо сформировать отчет

shops
array of stringoptional

Коды магазинов, по которым нужна детализированная информация

Пример запроса
curl -X POST https://baas.alfabank.ru/api/reports/payments-sbp \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}' \
  -H 'Content-Type: application/json' \
  -d '{
    "type": "2",
    "date": "2022-07-30",
    "shops": [
        "F76E",
        "F82A",
        "F11C",
        "F52B"
    ]
  }'

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

Пример ответа 201 (ОК)
{
  "reqId": "34eb7e7e-66db-42fa-9b81-544fed77c871"
}
reqId
stringoptional

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

Пример ответа 201 (ОК)
{
  "reqId": "34eb7e7e-66db-42fa-9b81-544fed77c871"
}
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

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

Код ошибки. Принимает возможные значения: report_already_exist - Повторный запрос на генерацию того же отчета (в рамках одного и того же дня)

error_description
stringoptional

Описание ошибки

Пример ошибки 409 (Conflict)
{
  "error": "report_already_exist",
  "error_description": "Request to generate a report with this parameters already exists"
}
Нет тела ответа
error
stringrequired

Код ошибки. Принимает возможные значения: internal_error - Внутренняя ошибка сервиса при выполнении обработки запроса

error_description
stringoptional

Описание ошибки

Пример ошибки 500 (Internal Server Error)
{
  "error": "internal_error",
  "error_description": "Internal server error"
}
Нет тела ответа

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