/fintech/api/v1/statement/print
Ресурс позволяет запросить формирование выписки за нужную дату в форматах PDF, EXCEL, DOCX, и RTF. При выполнении запроса в ответ получаете идентификатор задачи (id) на формирование выписки в необходимом формате. При готовности выписки ссылку на скачивание можно получить с помощью ресурса /fintech/api/v1/files/tasks-for-download/{taskId}
.
Для осуществления запроса на формирование выписки в нужном формате необходимо отправить GET-запрос /fintech/api/v1/statement/print
с токеном доступа (access_token) пользователя в параметре Authorization заголовка, номером счета (accountNumber), датой выписки (statementDate) и форматом запрашиваемой печатной формы (format) в query-параметрах запроса.
В параметре scope ссылки авторизации пользователя должен быть указана операция GET_STATEMENT_ACCOUNT
для получения доступа к этому ресурсу.
Для обращения к ресурсу необходимо отправлять запрос на:
- Тестовый контур
https://iftfintech.testsbi.sberbank.ru:9443
- Промышленный контур
https://fintech.sberbank.ru:9443
Request
- Модель
- Пример
Наименование | Тип | Формат | 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 | Array[string] | string | ^(PDF|EXCEL|DOCX|RTF)$ | required | Форматы запрашиваемой выписки. Возможно передать запрос на предоставление выписки в нескольких форматах: - с использованием перечисления форматов через символ & format=PDF&format=EXCEL&format=DOCX&format=RTF - с использованием перечисления форматов через запятую format=PDF,EXCEL,DOCX,RTF |
GET /fintech/api/v1/statement/print?accountNumber=40802810706000000087&statementDate=2023-11-14&format=PDF HTTP/1.1
Accept: */*
Authorization: Bearer c727000a071fc54353134a029fd7c8ad1c1cbh
Responses
- Модель
- Пример
Наименование | Тип | Обязательность | Описание |
---|---|---|---|
number | required | Идентификатор задачи для получения ссылки на скачивание. Возвращается один идентификатор задачи на все выбранные форматы. Для проверки готовности выписки и получения ссылки на скачивание используется ресурс /v1/files/tasks-for-download/{taskId} |
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
264415
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 | Сообщение, |