Запрос сводной информации по выписке
/v2/statement/summary
Возвращает информацию о входящих/исходящих остатках и суммарных оборотах за один день по счету. Дата запрашиваемой информации об остатках не может быть ранее 01.01.2017.
Должен содержать токен доступа (access_token) пользователя в параметре Authorization заголовка, номер счета (accountNumber) и дату выписки (statementDate) в параметрах запроса.
Для доступа к этому методу в параметре scope ссылки авторизации пользователя должен быть указан сервис GET_STATEMENT_ACCOUNT.
Запрос
Query Parameters
Номер счета (^[0-9]{20}$)
Дата выписки (yyyy-MM-dd)
Header Parameters
Access token организации-клиента, полученный через SSO
Успешный код возврата
- application/json
- Схема
- Пример из схемы
Schema
closingBalance
FintechAmount
Исходящий остаток в валюте счета
Возможные значения: >= 0 и <= 16 characters
Сумма
Буквенный ISO-код валюты
closingBalanceRub
FintechAmount
Исходящий остаток в рублях
Возможные значения: >= 0 и <= 16 characters
Сумма
Буквенный ISO-код валюты
Дата и время составления сводки
Количество кредитовых операций по счету
creditTurnover
FintechAmount
Кредитовый оборот в валюте счета
Возможные значения: >= 0 и <= 16 characters
Сумма
Буквенный ISO-код валюты
creditTurnoverRub
FintechAmount
Кредитовый оборот в рублях
Возможные значения: >= 0 и <= 16 characters
Сумма
Буквенный ISO-код валюты
Количество дебетовых операций по счету
debitTurnover
FintechAmount
Дебетовый оборот в валюте счета
Возможные значения: >= 0 и <= 16 characters
Сумма
Буквенный ISO-код валюты
debitTurnoverRub
FintechAmount
Дебетовый оборот в рублях
Возможные значения: >= 0 и <= 16 characters
Сумма
Буквенный ISO-код валюты
Дата последней операции по счету за запрошенный период
openingBalance
FintechAmount
Входящий остаток в валюте счета
Возможные значения: >= 0 и <= 16 characters
Сумма
Буквенный ISO-код валюты
openingBalanceRub
FintechAmount
Входящий остаток в рублях
Возможные значения: >= 0 и <= 16 characters
Сумма
Буквенный ISO-код валюты
Курс ЦБ за единицу валюты на начало периода
{
"closingBalance": {
"amount": 1.01,
"currencyName": "USD"
},
"closingBalanceRub": {
"amount": 1.01,
"currencyName": "USD"
},
"composedDateTime": "2022-04-04T23:59:59",
"creditTransactionsNumber": 1,
"creditTurnover": {
"amount": 1.01,
"currencyName": "USD"
},
"creditTurnoverRub": {
"amount": 1.01,
"currencyName": "USD"
},
"debitTransactionsNumber": 1,
"debitTurnover": {
"amount": 1.01,
"currencyName": "USD"
},
"debitTurnoverRub": {
"amount": 1.01,
"currencyName": "USD"
},
"lastMovementDate": "2022-04-04",
"openingBalance": {
"amount": 1.01,
"currencyName": "USD"
},
"openingBalanceRub": {
"amount": 1.01,
"currencyName": "USD"
},
"openingRate": "1.01"
}
"Запрос принят"
| Cause | Message | Description |
|---|---|---|
| STATEMENT_RESPONSE_PROCESSING | Сводка по выписке не готова или данные в ней неактуальны. Следует запросить позже. |
- application/json
- Схема
- Пример из схемы
Schema
Причина или основание сообщения
Уникальный идентификатор (UUID)
Сообщение
{
"cause": "string",
"referenceId": "string",
"message": "string"
}
"Ошибка в запросе"
| Cause | Message | Description |
|---|---|---|
| DESERIALIZATION_FAULT | Неверный формат запроса | Данные в request указаны в неправильном формате. Атрибуты request, в которых найдены ошибки, указаны в responce в массиве fields с описанием проблемы. Описание типа, формата и regexp атрибутов находится в request ресурса. Скорректируйте заполнение атрибутов и повторите запрос. |
| WORKFLOW_FAULT | Дата выписки позже текущей. Нельзя запросить выписку за дату в будущем. | |
| Счет не является действующим на запрошенную дату. | ||
| Запрошенной страницы с операциями не существует. | ||
| VALIDATION_FAULT | Ошибка при разборе параметров запроса | Данные не соответствуют требованиям валидации. Сведения о некорректных атрибутах request содержатся в массивах fieldNames и checks. Подробные требования к атрибутам описаны в request ресурса, включая типы, форматы и регулярные выражения. Необходимо скорректировать заполнение атрибутов и повторить запрос. |
- application/json
- Схема
- Пример из схемы
Schema
Array [
]
Уникальный идентификатор ошибки (UUID)
Сообщение
checks
object[]
Список проверок, приведших к ошибке
Уровень результата
Сообщение
Названия полей (при наличии связи с моделью)
{
"referenceId": "string",
"message": "string",
"checks": [
{
"level": "ERROR",
"message": "string",
"fields": [
"string"
]
}
]
}
"Не авторизован"
| Cause | Message | Description |
|---|---|---|
| UNAUTHORIZED | accessToken not found by value =хххххххх-хххх-хххх-хххх-хххххххххххх-х | Указан некорректный или просроченный access_token. Используйте refresh_token для обновления access_token и повторите запрос. |
- application/json
- Схема
- Пример из схемы
Schema
Причина или основание сообщения
Уникальный идентификатор (UUID)
Сообщение
{
"cause": "string",
"referenceId": "string",
"message": "string"
}
"Доступ запрещен"
| Cause | Message | Description |
|---|---|---|
| ACTION_ACCESS_EXCEPTION | Операция не может быть выполнена: доступ к ресурсу запрещен | Используемый в запросе access_token не имеет разрешения на доступ к нужному сервису Sber API. В ссылке авторизации СберБизнес ID, в параметре scope, не указана операция GET_STATEMENT_ACCOUNT. Необходимо добавить эту операцию в scope. Пользователю потребуется пройти авторизацию заново. Вы получите новые токены access_token и refresh_token. Сделайте повторный запрос с новым access_token. |
| ACCESS_EXCEPTION | Для внешнего сервиса недоступны операции по счету: {номер счета} | В процессе авторизации через СберБизнес ID пользователь должен подписать Согласие и указать счета, к которым Платформа получит доступ. Однако для данного счета доступ не был предоставлен при подписании Согласия. Чтобы решить эту проблему, пользователю необходимо войти в СберБизнес, отменить текущее Согласие, затем заново авторизоваться в Платформе, используя СберБизнес ID. Затем СберБизнес ID предложит пользователю снова подписать Согласие. Перед подписанием ему нужно будет отметить нужный счет как доступный для Платформы. |
- application/json
- Схема
- Пример из схемы
Schema
Причина или основание сообщения
Уникальный идентификатор (UUID)
Сообщение
{
"cause": "string",
"referenceId": "string",
"message": "string"
}
"Данные не найдены"
| Cause | Message | Description |
|---|---|---|
| DATA_NOT_FOUND_EXCEPTION | Выписка за указанную дату недоступна, пожалуйста, обратитесь в техническую поддержку | Необходимо собрать полный лог запроса и сформировать обращение в техническую поддержку Банка (supportdbo2@sberbank.ru) |
- application/json
- Схема
- Пример из схемы
Schema
Причина или основание сообщения
Уникальный идентификатор (UUID)
Сообщение
{
"cause": "string",
"referenceId": "string",
"message": "string"
}
"Превышен лимит запросов"
| Cause | Message | Description |
|---|---|---|
| TOO_MANY_REQUESTS | Превышен лимит запросов. Повторите операцию позже. | Количество запросов к данному методу за ограниченное время превысило допустимое значение. Пользователю необходимо повторить запрос позднее |
- application/json
- Схема
- Пример из схемы
Schema
Причина или основание сообщения
Уникальный идентификатор (UUID)
Сообщение
{
"cause": "string",
"referenceId": "string",
"message": "string"
}
"Внутренняя ошибка сервера"
| Cause | Message | Description |
|---|---|---|
| UNKNOWN_EXCEPTION | Внутренняя ошибка сервера | Сделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка. |
- application/json
- Схема
- Пример из схемы
Schema
Причина или основание сообщения
Уникальный идентификатор (UUID)
Сообщение
{
"cause": "string",
"referenceId": "string",
"message": "string"
}
"Сервис временно недоступен"
| Cause | Message | Description |
|---|---|---|
| UNAVAILABLE_RESOURCE_EXCEPTION | Внутренняя ошибка сервера | Сделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка. |
- application/json
- Схема
- Пример из схемы
Schema
Причина или основание сообщения
Уникальный идентификатор (UUID)
Сообщение
{
"cause": "string",
"referenceId": "string",
"message": "string"
}