Получить информацию по оборотам счета

Обновлено 29 ноября 2024

Компаниям

Холдингам

Платформам

/fintech/api/v2/statement/summary

Ресурс позволяет получить информацию о входящих/исходящих остатках и суммарных оборотах за один день по счету. Дата запрашиваемой информации об остатках не может быть ранее 01.01.2017.

Для получения информации о входящих/исходящих остатках и суммарных оборотах необходимо отправить GET-запрос /fintech/api/v2/statement/summary с токеном доступа (access_token) пользователя в параметре Authorization заголовка, номером счета (accountNumber) и датой выписки (statementDate) в query-параметрах запроса.

В параметре scope ссылки авторизации пользователя должен быть указана операция GET_STATEMENT_ACCOUNT для получения доступа к этому ресурсу.

Для обращения к ресурсу необходимо отправлять запрос на:

• Тестовый контур https://iftfintech.testsbi.sberbank.ru:9443
• Промышленный контур https://fintech.sberbank.ru:9443

Request

/fintech/api/v2/statement/summary

• Модель
• Пример

Наименование	Тип	Формат	Regexp	Обязательность	Описание
HEADER
Authorization	string	string	^[a-zA-Z0-9]{38}$	required	Access token пользователя, полученный через SSO.
Accept	string	string	^(application/json|application/jose)	optional	Указывает на формат данных, который вы готовы принять от Банка. Если ответ не требуется в зашифрованном виде, то может быть не указан или передан со значением application/json. Если необходимо получить ответ на запрос токена в зашифрованном виде, то необходимо передать параметр со значением application/jose.
QUERY-PARAMETERS
accountNumber	string	string	^[0-9]{20}$	required	Номер счета.
statementDate	DateTime	ISO 8601 YYYY-MM-DD	^([0-9]{4}-[0-9]{2}-[0-9]{2})$	required	Дата запрашиваемой выписки.

GET /fintech/api/v2/statement/summary?accountNumber=40802810706000000087&statementDate=2023-11-14 HTTP/1.1
Accept: application/json
Authorization: Bearer 61019d6723ea4537b18a9e87fe458a1c2234f

Responses

200 (ОК)

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
StatementSummary {
closingBalance	Amount	optional	Исходящий остаток в валюте счета
closingBalanceRub	Amount	optional	Исходящий остаток в рублях
composedDateTime	string	optional	Дата и время составления сводки
creditTransactionsNumber	integer	optional	Количество кредитовых операций по счету
creditTurnover	Amount	optional	Кредитовый оборот в валюте счета
creditTurnoverRub	Amount	optional	Кредитовый оборот в рублях
debitTransactionsNumber	integer	optional	Количество дебетовых операций по счету
debitTurnover	Amount	optional	Дебетовый оборот в валюте счета
debitTurnoverRub	Amount	optional	Дебетовый оборот в рублях
lastMovementDate	string	optional	Дата последней операции по счету за запрошенный период
openingBalance	Amount	optional	Входящий остаток в валюте счета
openingBalanceRub	Amount	optional	Входящий остаток в рублях
openingRate	Number	optional	Курс ЦБ за единицу валюты на начало периода
}
Amount {
amount	Number	optional	Сумма
currencyName	string	optional	Буквенный ISO-код валюты
}

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8

{
    "composedDateTime": "2023-11-14T00:00:00",
    "lastMovementDate": "2023-11-14",
    "openingRate": null,
    "openingBalance": {
        "amount": "9999999.00",
        "currencyName": "RUB"
    },
    "openingBalanceRub": {
        "amount": "9999999.00",
        "currencyName": "RUB"
    },
    "closingBalance": {
        "amount": "9998899.00",
        "currencyName": "RUB"
    },
    "closingBalanceRub": {
        "amount": "9998899.00",
        "currencyName": "RUB"
    },
    "debitTurnover": {
        "amount": "1100.00",
        "currencyName": "RUB"
    },
    "debitTurnoverRub": {
        "amount": "1100.00",
        "currencyName": "RUB"
    },
    "debitTransactionsNumber": 2,
    "creditTurnover": {
        "amount": "0.00",
        "currencyName": "RUB"
    },
    "creditTurnoverRub": {
        "amount": "0.00",
        "currencyName": "RUB"
    },
    "creditTransactionsNumber": 0
}

202 (Accepted)

Cause	Message	Description
STATEMENT_RESPONSE_PROCESSING	Сводка по выписке не готова или данные в ней неактуальны. Следует запросить позже.

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор (UUID),
message	string	optional	Сообщение
}

HTTP/1.1 202 Accepted
Content-Type: application/json;charset=UTF-8

{
  "cause": "STATEMENT_RESPONSE_PROCESSING",
  "referenceId": "a5e7d822-70c6-4e79-9603-9941c113f297",
  "message": "Сводка по выписке не готова или данные в ней неактуальны. Следует запросить позже."
}

400 (Bad request)

Cause	Message	Description
DESERIALIZATION_FAULT	Неверный формат запроса	Данные в request указаны в неправильном формате. Атрибуты request, в которых найдены ошибки, указаны в responce в массиве fields с описанием проблемы. Описание типа, формата и regexp атрибутов находится в request ресурса. Скорректируйте заполнение атрибутов и повторите запрос.
WORKFLOW_FAULT	Дата выписки позже текущей. Нельзя запросить выписку за дату в будущем.
	Счет не является действующим на запрошенную дату.
	Запрошенной страницы с операциями не существует.
VALIDATION_FAULT	Ошибка при разборе параметров запроса	Данные не соответствуют требованиям валидации. Сведения о некорректных атрибутах request содержатся в массивах fieldNames и checks. Подробные требования к атрибутам описаны в request ресурса, включая типы, форматы и регулярные выражения. Необходимо скорректировать заполнение атрибутов и повторить запрос.

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
ResourceFault {
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
checks	Array[Check]	optional	Список проверок, приведших к ошибке,
fieldNames	Array[string]	optional	Названия полей с некорректным значением (только для VALIDATION_FAULT)
}
Check {
level	string	optional	Уровень результата \= ['ERROR', 'WARNING'],
message	string	optional	Сообщение,
fields	Array[string]	optional	Названия полей (при наличии связи с моделью)
}

HTTP/1.1 400 Bad Request
Content-Type: application/json;charset=UTF-8

{
    "cause": "WORKFLOW_FAULT",
    "referenceId": "a5e7d822-70c6-4e79-9603-9941c113f297",
    "message": "Параметр \"accountNumber\" не соответствует регулярному выражению: ^[0-9]{20}$",
    "checks": [],
    "fieldNames": null
}

401 (Unauthorized Error)

Cause	Message	Description
UNAUTHORIZED	accessToken not found by value =хххххххх-хххх-хххх-хххх-хххххххххххх-х	Указан некорректный или просроченный access_token. Используйте refresh_token для обновления access_token и повторите запрос.

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор (UUID),
message	string	optional	Сообщение
}

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=UTF-8
 
{
    "cause": "UNAUTHORIZED",
    "referenceId": "014ec3a1-3e41-4805-9e22-d07947b012af",
    "message": "accessToken not found by value = 3513f959dbbd57490aa9f9ff67fb7380fae5m3"
}

403 (Forbidden)

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 предложит пользователю снова подписать Согласие. Перед подписанием ему нужно будет отметить нужный счет как доступный для Платформы.

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор (UUID),
message	string	optional	Сообщение
}

HTTP/1.1 403 Forbidden
Content-Type: application/json;charset=UTF-8

{
    "cause": "ACCESS_EXCEPTION",
    "referenceId": "5650c1e4-5039-4038-8cad-afab64003f61",
    "message": "Для внешнего сервиса недоступны операции по счету: 40702810006000001792"
}

404 (Not Found)

Cause	Message	Description
DATA_NOT_FOUND_EXCEPTION	Выписка за указанную дату недоступна, пожалуйста, обратитесь в техническую поддержку	Необходимо собрать полный лог запроса и сформировать обращение в техническую поддержку Банка (supportdbo2@sberbank.ru)

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор (UUID),
message	string	optional	Сообщение
}

HTTP/1.1 404 Not Found
Content-Type: application/json;charset=UTF-8

{
    "cause": "DATA_NOT_FOUND_EXCEPTION",
    "referenceId": "cc78b3aa-c057-4533-b9db-898bbaad9061",
    "message": "Выписка за указанную дату недоступна, пожалуйста, обратитесь в техническую поддержку"
}

429 (Too Many Requests)

Cause	Message	Description
TOO_MANY_REQUESTS	Превышен лимит запросов. Повторите операцию позже.	Количество запросов к данному методу за ограниченное время превысило допустимое значение. Пользователю необходимо повторить запрос позднее

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
}

HTTP/1.1 429 Too Many Requests
Content-Type: application/json;charset=UTF-8

{
  "cause": " TOO_MANY_REQUESTS ",
  "referenceId": "5650c1e4-5039-4038-8cad-afab64003f61",
  "message": " Превышен лимит запросов. Повторите операцию позже"
}

429 (Too Many Requests)

Cause	Message	Description
TOO_MANY_REQUESTS	Превышен лимит запросов. Повторите операцию позже.	Количество запросов к данному методу за ограниченное время превысило допустимое значение. Пользователю необходимо повторить запрос позднее

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
Notice{
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
}

json HTTP/1.1 429 Too Many Requests Content-Type: application/json;charset=UTF-8

{ "cause": " TOO_MANY_REQUESTS ", "referenceId": "5650c1e4-5039-4038-8cad-afab64003f61", "message": " Превышен лимит запросов. Повторите операцию позже" }

500 (Internal Server Error)

Cause	Message	Description
UNKNOWN_EXCEPTION	Внутренняя ошибка сервера	Сделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор (UUID),
message	string	optional	Сообщение
}

HTTP/1.1 500 Internal Server Error
Content-Type: application/json;charset=UTF-8

{
  "cause": "UNKNOWN_EXCEPTION",
  "referenceId": "9e209109-4b0d-408c-a2fd-e1983c20a65d",
  "message": "Внутренняя ошибка сервера"
}

503 (Service Temporarily Unavailable)

Cause	Message	Description
UNKNOWN_EXCEPTION	Внутренняя ошибка сервера	Сделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор (UUID),
message	string	optional	Сообщение
}

HTTP/1.1 503 Service Temporarily Unavailable
Content-Type: application/json;charset=UTF-8

{
  "cause": "UNAVAILABLE_RESOURCE_EXCEPTION",
  "referenceId": "9e209109-4b0d-408c-a2fd-e1983c20a67d",
  "message": "Внутренняя ошибка сервера"
}