Запрос выписки для экспорта в другие системы

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

Компаниям

Холдингам

Платформам

/fintech/api/v1/statement/files

Ресурс позволяет запросить формирование выписки для экспорта в другие системы в разных форматах. При выполнении запроса в ответ получаете идентификатор задачи (id) на формирование выписки в необходимом формате. При готовности выписки ссылку на скачивание можно получить с помощью ресурса /v1/files/tasks-for-download/{taskId}.

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

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

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

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

Request

/fintech/api/v1/statement/files

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

Наименование	Тип	Формат	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})$	optional	Дата запрашиваемой выписки. Если не заполнять, по умолчанию текущий день.
format	string	string	^(1C|MT940|camt053)$	required	Форматы запрашиваемой выписки.
encodin	string	string	^(DOS|WINDOWS|UTF8)$	optional	Кодировка выписки. Если не заполнять, по умолчанию WINDOWS

GET /fintech/api/v1/statement/files?format=1C&accountNumber=40802810706000000087&statementDate=2023-11-14&encoding=WINDOWS HTTP/1.1
Accept: */*
Authorization: Bearer c727000a071fc243538a0291fd7c8ad1c1cbdf

Responses

200 (ОК)

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

Наименование	Тип	Обязательность	Описание
	number	required	Идентификатор задачи для получения ссылки на скачивание. Возвращается один идентификатор задачи на все выбранные форматы. Для проверки готовности выписки и получения ссылки на скачивание используется запрос /v1/files/tasks-for-download/{taskId}

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

264411

400 (Bad request)

Cause	Message	Description
DESERIALIZATION_FAULT	Неверный формат запроса.	Данные в request указаны в неправильном формате. Атрибуты request, в которых найдены ошибки, указаны в responce в массиве fields с описанием проблемы. Описание типа, формата и regexp атрибутов находится в request ресурса. Скорректируйте заполнение атрибутов и повторите запрос.
WORKFLOW_FAULT	Дата выписки позже текущей. Нельзя запросить выписку за дату в будущем.
	Счет не является действующим на запрошенную дату.
	Запрошенной страницы с операциями не существует.	Проверьте контейнер links с параметром (href) на следующую и предыдущую страницы и признаками: "rel": "prev", "rel": "next". Если следующей страницы нет, в полученном ответе перестанет приходить href c признаком "rel": "next".
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": "d277c48a-9427-4985-81c1-1eed78ef8a9a",
    "message": "Неподдерживаемая кодировка: WINDOWSs",
    "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": "Внутренняя ошибка сервера"
}