Получение операций по счету

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

Максимальное количество операций, возвращаемых на одной странице выписки, равно 100 (для ПРОМ контура).
Запросы выписки подсчитываются исходя из количества опрашиваемых счетов и количества заданных обновлений выписки.

Получение выписки по счету

Ресурс /v1/statement/transactions позволяет Партнеру получить выписку по счёту клиента за выбранную дату.

Шаги

1. Получить AccessToken.

2. Отправить запрос.

Для получения выписки по счету клиента необходимо отправить GET-запрос (/v1/statement/transactions), в котором передать авторизационный токен к данным клиента (Access Token), номер счёта (accountNumber), дату выписки (Date) и номер запрашиваемой страницы (Page=1). Авторизационный токен передается в параметре Authorization заголовка запроса.

Чтобы получить доступ к ресурсу, необходимо передать в scope сервис GET_STATEMENT_ACCOUNT.

Модель запроса

Header Parameters
Authorization String
Access token организации-клиента, полученный через SSO.
Пример: Bearer 8190f687-c916-453b-9d68-0ce22f4f3f9d-1
Query Parameters
accountNumber String Номер счета
statementDate DateTime Дата запрашиваемой выписки
page Integer Номер запрашиваемой страницы. По умолчанию 100 операций на странице.
curFormat (optional) String Формат операции по валютному счету

Пример запроса

ccurl -X GET --header 'Accept: application/json' --header

'Authorization:  Bearer 8190f687-c916-453b-9d68-0ce22f4f3f9d-1'

'https://edupirfintech.sberbank.ru:9443/fintech/api/v1/statement/

transactions?accountNumber=40702810340399653236&

statementDate=2019-06-26&page=1'
Выписка может приходить как по рублевым, так и по валютным счетам. Для рублевого счета не заполняется параметр curFormat, данные передаются в обычном формате.

Параметр curFormat влияет на формат данных для валютных счетов и принимает следующие значения:

  • curTransfer,
  • swiftTransfer.

Если curFormat = swiftTransfer, то данные по счету будут переданы в формате МТ103. Если curFormat = curTransfer, то данные по валютному счету будут переданы в том же формате, что и данные по рублевому счету. По умолчанию для валютных счетов curFormat = swiftTransfer.

Необходимо запрашивать постранично данные операции, начиная с первой страницы.

На запрос первой страницы в ответе вернется список операций (если существуют операции за выбранную дату и счет) и контейнер links с параметром (href) на следующую страницу и признаком "rel": "next".
На запрос второй страницы в ответе вернется список операций и контейнер links с параметром (href) на следующую и предыдущую страницы и признаками: "rel": "prev", "rel": "next". Получение последующих страниц производится по аналогии.

Если следующей страницы нет, в полученном ответе перестанет приходить href c признаком "rel": "next".

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

Для получения тестовой выписки в Swagger необходимо использовать:

  • Access token - 9e1efef1-e584-4c6f-9da3-34a04d203308-1;
  • параметры:

    • accountNumber=40702810038120042645,
    • statementDate=2021-03-24.

Модель ответа

StatementTransactions {
_links (Array[Link], optional) Ссылки на связанные ресурсы,
transactions (Array[StatementTransaction], optional) Данные по операциям выписки
}Link {
href (string) Абсолютный или относительный адрес,
rel (string) Отношение ссылки к текущей сущности (next, prev)
}StatementTransaction {
amount (Amount, optional) Сумма в валюте счета,
amountRub (Amount, optional) Сумма в рублях,
correspondingAccount (string, optional) Корреспондирующий счет,
direction (string, optional) Направление транзакции DEBIT/CREDIT= ['DEBIT','CREDIT']stringEnum
documentDate (string, optional) Дата документа,
filial (string, optional) Наименование филиала,
number (string, optional) Номер операции,
operationCode (string, optional) Тип операции,
operationDate (string, optional) Дата и время операции,
paymentPurpose (string, optional) Назначение платежа,
priority (string, optional) Очередность платежа,
revaln (string, optional) Признак операции переоценки (ПК - пересчет курса, ДП - дооценка руб. покрытия),
rurTransfer (RURTransfer, optional) Данные рублевой операции,
swiftTransfer (SWIFTTransfer, optional) Данные перевода SWIFT MT103 (только для валютных операций),
uuid (string, optional) Уникальный идентификатор операции (UUID)
}Amount {
amount (number, optional) Сумма,
currencyName (string, optional) Буквенный ISO-код валюты
}
CurTransfer {
bankOperationCode (string, optional) Код банковской операции (формат MT103),
beneficiaryBankAccount (string, optional) Номер счета банка бенефициара. 1-я часть значения поля 57 в формате MT103,
beneficiaryBankName (string, optional) Код BIC, расположение или название и адрес банка бенефициара. Содержимое поля 57 (за исключением номера счета, с разделителями) в формате MT103,
beneficiaryBankOption (string, optional) Признак вида поля банка бенефициара (поле 57 в формате MT103). Возможные значения
beneficiaryCustomerAccount (string, optional) Номер счета бенефициара. 1-я часть значения поля 59 в формате MT103,
beneficiaryCustomerName (string, optional) Код BIC/BEI или название и адрес бенефициара. Содержимое поля 59 (за исключением номера счета, с разделителями) в формате MT103,
detailsOfCharges (string, optional) Сведения о расходах (формат MT103),
exchangeRate (string, optional) Курс конвертации (формат MT103),
instructedAmount (string, optional) Валюта/сумма по инструкции (формат MT103),
instructionCode (string, optional) Код инструкции (формат MT103),
intermediaryBankAccount (string, optional) Номер счета банка-посредника. 1-я часть значения поля 56 в формате MT103,
intermediaryBankName (string, optional) Код BIC или название банка-посредника.Содержимое поля 56 (за исключением номера счета, с разделителями) в формате MT103,
intermediaryBankOption (string, optional) Признак вида поля банка-посредника (поле 56 в формате MT103). Возможные значения
messageDestinator (string, optional) Получатель сообщения SWIFT (формат MT103),
messageIdentifier (string, optional) Уникальный системный номер сообщения SWIFT (формат MT103),
messageOriginator (string, optional) Отправитель сообщения SWIFT (формат MT103),
messageReceiveTime (string, optional) Дата и время получения сообщения SWIFT (формат MT103),
messageSendTime (string, optional) Дата и время отправки сообщения SWIFT (формат MT103),
messageType (string, optional) Тип сообщения SWIFT,
orderingCustomerAccount (string, optional) Номер счета плательщика в формате IBAN или BBAN (для внутренних платежей). 1-я часть значения поля 50 в формате MT103,
orderingCustomerName (string, optional) Код BIC/BEI или название и адрес плательщика. Содержимое поля 50 (за исключением номера счета, с разделителями) в формате MT103,
orderingCustomerOption (string, optional) Признак вида поля плательщика (поле 50 в формате MT103). Возможные значения
orderingInstitutionAccount (string, optional) Номер счета банка плательщика. 1-я часть значения поля 52 в формате MT103,
orderingInstitutionName (string, optional) Код BIC или название и адрес банка плательщика. Содержимое поля 52 (за исключением номера счета, с разделителями) в формате MT103,
orderingInstitutionOption (string, optional) Признак вида поля банка плательщика (поле 52 в формате MT-103). Возможные значения
payeeBankBic (string, optional) БИК банка получателя,
payeeBankCorrAccount (string, optional) Корсчет банка получателя,
payeeAccount (string, optional) Номер счета получателя,
payeeBankName (string, optional) Наименование банка получателя,
payeeInn (string, optional) ИНН получателя,
payeeKpp (string, optional) КПП получателя,
payeeName (string, optional) Наименование получателя,
payerBankBic (string, optional) БИК банка плательщика,
payerBankCorrAccount (string, optional) Корсчет банка плательщика,
payerAccount (string, optional) Номер счета плательщика,
payerBankName (string, optional) Наименование банка плательщика,
payerInn (string, optional) ИНН плательщика,
payerKpp (string, optional) КПП плательщика,
payerName (string, optional) Наименование плательщика,
receiverCharges (string, optional) Расходы получателя (формат MT103),
receiverCorrespondentAccount (string, optional) Номер счета корреспондента получателя.1-я часть значения поля 54 в формате MT103,
receiverCorrespondentName (string, optional) Код BIC, расположение или название и адрес корреспондента получателя. Содержимое поля 54 (за исключением номера счета, с разделителями) в формате MT103,
receiverCorrespondentOption (string, optional) Признак вида поля корреспондента получателя (поле 54 в формате MT103). Возможные значения
regulatoryReporting (string, optional) Контрольная отчетность (формат MT103),
remittanceInformation (string, optional) Сведения о переводе (формат MT103),
senderCharges (string, optional) Расходы отправителя (формат MT103),
senderCorrespondentAccount (string, optional) Номер счета корреспондента отправителя.1-я часть значения поля 53 в формате MT103,
senderCorrespondentName (string, optional) Код BIC, расположение или название и адрес корреспондента отправителя. Содержимое поля 53 (за исключением номера счета, с разделителями) в формате MT103,
senderCorrespondentOption (string, optional) Признак вида поля корреспондента отправителя (поле 53 в формате MT103). Возможные значения
senderToReceiverInformation (string, optional) Информация отправителя получателю (формат MT103),
transactionReferenceNumber (string, optional) Референс операции (формат MT103),
transactionRelatedReference (string, optional) Связанный референс (формат MT103),
transactionTypeCode (string, optional) Код типа операции (формат MT103),
urgent (string, optional) Признак срочности операции (формат MT103). Возможные значения
valueDateCurrencyInterbankSettledAmount (string, optional) Дата валютирования, код валюты, сумма межбанковского расчета (формат MT103)
},
RURTransfer {
cartInfo (CartInfo, optional) Дополнительная информация о документе (картотека),
deliveryKind (string, optional) Способ отправки документа,
departmentalInfo (DepartmentalInfo, optional) Реквизиты налогового, таможенного или иного бюджетного платежа,
payeeAccount (string, optional) Номер счета получателя,
payeeBankBic (string, optional) БИК банка получателя,
payeeBankCorrAccount (string, optional) Корсчет банка получателя,
payeeBankName (string, optional) Наименование банка получателя,
payeeInn (string, optional) ИНН получателя,
payeeKpp (string, optional) КПП получателя,
payeeName (string, optional) Наименование получателя,
payerAccount (string, optional) Номер счета плательщика,
payerBankBic (string, optional) БИК банка плательщика,
payerBankCorrAccount (string, optional) Корсчет банка плательщика,
payerBankName (string, optional) Наименование банка плательщика,
payerInn (string, optional) ИНН плательщика,
payerKpp (string, optional) КПП плательщика,
payerName (string, optional) Наименование плательщика,
payingCondition (string, optional) Условие оплаты (для 02),
purposeCode (string, optional) Кодовое назначение платежа Коды:" 1 - При переводе денежных средств, являющихся заработной платой и (или) иными доходами, в отношении которых статьей 99 Федерального закона N 229-ФЗ установлены ограничения.2 - При переводе денежных средств, являющихся доходами, на которые в соответствии со статьей 101 Федерального закона N 229-ФЗ не может быть обращено взыскание, за исключением доходов, указанных в пунктах 1 и 4 части 1 статьи 101 Федерального закона N 229-ФЗ. 3 - При переводе денежных средств, являющихся видами доходов, на которые в соответствии с пунктами 1 и 4 части 1 статьи 101 Федерального закона N 229- ФЗ не может быть обращено взыскание,"
receiptDate (string, optional) Дата поступления в банк плательщика,
valueDate (string, optional) Дата валютирования,
transactionId (number, optional) Идентификатор операции
}SWIFTTransfer {
bankOperationCode (string, optional) Код банковской операции (формат MT103),
beneficiaryBankAccount (string, optional) Номер счета банка бенефициара. 1-я часть значения поля 57 в формате MT103,
beneficiaryBankName (string, optional) Код BIC, расположение или название и адрес банка бенефициара. Содержимое поля 57 (за исключением номера счета, с разделителями) в формате MT103,
beneficiaryBankOption (string, optional) Признак вида поля банка бенефициара (поле 57 в формате MT103). Возможные значения
beneficiaryCustomerAccount (string, optional) Номер счета бенефициара. 1-я часть значения поля 59 в формате MT103,
beneficiaryCustomerName (string, optional) Код BIC/BEI или название и адрес бенефициара. Содержимое поля 59 (за исключением номера счета, с разделителями) в формате MT103,
detailsOfCharges (string, optional) Сведения о расходах (формат MT103),
exchangeRate (string, optional) Курс конвертации (формат MT103),
instructedAmount (string, optional) Валюта/сумма по инструкции (формат MT103),
instructionCode (string, optional) Код инструкции (формат MT103),
intermediaryBankAccount (string, optional) Номер счета банка-посредника.1-я часть значения поля 56 в формате MT103,
intermediaryBankName (string, optional) Код BIC или название банка-посредника.Содержимое поля 56 (за исключением номера счета, с разделителями) в формате MT103,
intermediaryBankOption (string, optional) Признак вида поля банка-посредника, (поле 56 в формате MT103). Возможные значения A, С, D,
messageDestinator (string, optional) Получатель сообщения SWIFT (формат MT103),
messageIdentifier (string, optional) Уникальный системный номер сообщения SWIFT (формат MT103),
messageOriginator (string, optional) Отправитель сообщения SWIFT (формат MT103),
messageReceiveTime (string, optional) Дата и время получения сообщения SWIFT (формат MT103),
messageSendTime (string, optional) Дата и время отправки сообщения SWIFT (формат MT103),
messageType (string, optional) Тип сообщения SWIFT,
orderingCustomerAccount (string, optional) Номер счета плательщика в формате IBAN или BBAN (для внутренних платежей). 1-я часть значения поля 50 в формате MT103,
orderingCustomerName (string, optional) Код BIC/BEI или название и адрес плательщика.Содержимое поля 50 (за исключением номера счета, с разделителями) в формате MT103,
orderingCustomerOption (string, optional) Признак вида поля плательщика (поле 50 в формате MT103). Возможные значения A, F, K,
orderingInstitutionAccount (string, optional) Номер счета банка плательщика.1-я часть значения поля 52 в формате MT103,
orderingInstitutionName (string, optional) Код BIC или название и адрес банка плательщика.Содержимое поля 52 (за исключением номера счета, с разделителями) в формате MT103,
orderingInstitutionOption (string, optional) Признак вида поля банка плательщика (поле 52 в формате MT-103). Возможные значения A, D.
receiverCharges (string, optional) Расходы получателя (формат MT103),
receiverCorrespondentAccount (string, optional) Номер счета корреспондента получателя.1-я часть значения поля 54 в формате MT103,
receiverCorrespondentName (string, optional) Код BIC, расположение или название и адрес корреспондента получателя. Содержимое поля 54 (за исключением номера счета, с разделителями) в формате MT103,
receiverCorrespondentOption (string, optional) Признак вида поля корреспондента получателя (поле 54 в формате MT103). Возможные значения A, B, D.
regulatoryReporting (string, optional) Контрольная отчетность (формат MT103),
remittanceInformation (string, optional) Сведения о переводе (формат MT103),
senderCharges (string, optional) Расходы отправителя (формат MT103),
senderCorrespondentAccount (string, optional) Номер счета корреспондента отправителя.1-я часть значения поля 53 в формате MT103,
senderCorrespondentName (string, optional) Код BIC, расположение или название и адрес корреспондента отправителя. Содержимое поля 53 (за исключением номера счета, с разделителями) в формате MT103,
senderCorrespondentOption (string, optional) Признак вида поля корреспондента отправителя (поле 53 в формате MT103).Возможные значения A, B, D.
senderToReceiverInformation (string, optional) Информация отправителя получателю (формат MT103),
transactionReferenceNumber (string, optional) Референс операции (формат MT103),
transactionRelatedReference (string, optional) Связанный референс (формат MT103),
transactionTypeCode (string, optional) Код типа операции (формат MT103),
urgent (string, optional) Признак срочности операции (формат MT103). Возможные значения
valueDateCurrencyInterbankSettledAmount (string, optional) Дата валютирования, код валюты, сумма межбанковского расчета (формат MT103)
}CartInfo {
documentCode (string, optional) Шифр документа (картотека) (для 16),
documentContent (string, optional) Содержание операции (для 16),
documentDate (string, optional) Дата документа (картотека) (для 16),
documentNumber (string, optional) Номер документа (картотека) (для 16),
paymentNumber (string, optional) Номер платежа (картотека) (для 16),
restAmount (number, optional) Сумма остатка платежа (картотека) (для 16)
}DepartmentalInfo {
uip (string) Уникальный идентификатор платежа,
drawerStatus101 (string) Показатель статуса налогоплательщика (реквизит - 101),
kbk (string) Код бюджетной классификации (реквизит - 104),
oktmo (string) Код OKTMO (реквизит - 105),
reasonCode106 (string) Показатель основания платежа (реквизит - 106),
taxPeriod107 (string) Налоговый период / код таможенного органа (реквизит - 107),
docNumber108 (string) Номер налогового документа (реквизит - 108),
docDate109 (string) Дата налогового документа (реквизит - 109), формат ^(0|[0-9]{2}\.[0-9]{2}\.[0-9]{4})$,
paymentKind110 (string, optional) Тип налогового платежа (реквизит - 110)
}

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

{
  "_links": [
    {
      "href": "?accountNumber=40702810500006103990&statementDate=2018-03-15&page=3",
      "rel": "next"
    }
  ],
  "transactions": [
    {
      "amount": {
        "amount": 1.01,
        "currencyName": "USD"
      },
      "amountRub": {
        "amount": 1.01,
        "currencyName": "USD"
      },
      "correspondingAccount": "30101810400000000225",
      "curTransfer": {
        "bankOperationCode": "CRED",
        "beneficiaryBankAccount": "LOYDGB21321",
        "beneficiaryBankName": "BANCO DE SABADELL, S.A.1, PLAZA CATALUNYA SABADELL ES",
        "beneficiaryBankOption": "D",
        "beneficiaryCustomerAccount": "/FI8850000120266333",
        "beneficiaryCustomerName": "SUN-KING KNITTED BELT PRODUCT LTD.  N.39,DONGMEN ROAD FUQING CITY,FUJIAN,CHINA",
        "detailsOfCharges": "OUR",
        "exchangeRate": "67,74",
        "instructedAmount": "USD70,",
        "instructionCode": "URGP",
        "intermediaryBankAccount": "COBADEFF",
        "intermediaryBankName": "BANCA POPOLARE DELL'ETRURIA E DEL LAZIO (SEDE DI MILANO)MILANO",
        "intermediaryBankOption": "D",
        "messageDestinator": "LAPBLV2X",
        "messageIdentifier": "S000013082900014",
        "messageOriginator": "SABRRU2P",
        "messageReceiveTime": "15-05-27 14:01",
        "messageSendTime": "15-05-27 13:21",
        "messageType": "103",
        "orderingCustomerAccount": "/08251801040004813",
        "orderingCustomerName": "DONGNING JIXIN INDUSTRY AND TRADE(GROUP) CO.,LTD.NO.98 FANRONG STREET DONGNING COUNTY",
        "orderingCustomerOption": "K",
        "orderingInstitutionAccount": "ABOCBNBJ080",
        "orderingInstitutionName": "AGRICULTURAL BANK OF CHINA,  THE(HEILONGJIANG BRANCH) HARBIN",
        "orderingInstitutionOption": "A",
        "payeeAccount": "40802810600000200000",
        "payeeBankBic": "044525225",
        "payeeBankCorrAccount": "30101810400000000225",
        "payeeBankName": "ПАО СБЕРБАНК",
        "payeeInn": "7707083893",
        "payeeKpp": "222201001",
        "payeeName": "Общество с ограниченной ответственностью \"Клиент\"",
        "payerAccount": "40802810600000200000",
        "payerBankBic": "044525225",
        "payerBankCorrAccount": "30101810400000000225",
        "payerInn": "7707083893",
        "payerKpp": "222201001",
        "payerBankName": "ПАО СБЕРБАНК",
        "payerName": "Общество с ограниченной ответственностью \"Клиент\"",
        "receiverCharges": "EUR13,19",
        "receiverCorrespondentAccount": "CHASDEFX",
        "receiverCorrespondentName": "THE BANK OF NEW YORK MELLON NEW                    YORK,NY",
        "receiverCorrespondentOption": "D",
        "regulatoryReporting": "/N10/NS/N4/12345678901234567890/N5/12345678901/N6/TP/N7/МS.05.2003/N8/123456789012345/N9/12.05.2003",
        "remittanceInformation": "CONTRACT NO SE/00233 DATED 06.03.2012,                      INVOICE NO 4783",
        "senderCharges": "USD7,03",
        "senderCorrespondentAccount": "BOTKGB2L",
        "senderCorrespondentName": "CITIBANK N.A.NEW YORK,NY",
        "senderCorrespondentOption": "D",
        "senderToReceiverInformation": "/NZP/OT 15.03.2009. NDS NE OBLAGAETSYA",
        "transactionReferenceNumber": "S380609091426498",
        "transactionRelatedReference": "S380609091426498",
        "transactionTypeCode": "N1",
        "urgent": "NORMAL",
        "valueDateCurrencyInterbankSettledAmount": "130824EUR5447,34"
      },
      "direction": "CREDIT",
      "documentDate": "2018-12-31",
      "filial": "ОСБ 3",
      "number": "4",
      "operationCode": "01",
      "operationDate": "2018-12-31T23:59:59",
      "paymentPurpose": "Оплата заказа №123. НДС нет.",
      "priority": "5",
      "revaln": "ПК",
      "rurTransfer": {
        "cartInfo": {
          "documentCode": "string",
          "documentContent": "string",
          "documentDate": "2019-10-19T06:33:47.923Z",
          "documentNumber": "string",
          "paymentNumber": "string",
          "restAmount": 0
        },
        "deliveryKind": "электронно",
        "departmentalInfo": {
          "uip": "0",
          "drawerStatus101": "01",
          "kbk": "18210102010011000110",
          "oktmo": "01701000",
          "reasonCode106": "ТП",
          "taxPeriod107": "ГД.00.2018",
          "docNumber108": "123",
          "docDate109": "31.12.2018",
          "paymentKind110": "1"
        },
        "payeeAccount": "40802810600000200000",
        "payeeBankBic": "044525225",
        "payeeBankCorrAccount": "30101810400000000225",
        "payeeBankName": "ПАО СБЕРБАНК",
        "payeeInn": "7707083893",
        "payeeKpp": "222201001",
        "payeeName": "Общество с ограниченной ответственностью \"Клиент\"",
        "payerAccount": "40802810600000200000",
        "payerBankBic": "044525225",
        "payerBankCorrAccount": "30101810400000000225",
        "payerBankName": "ПАО СБЕРБАНК",
        "payerInn": "7707083893",
        "payerKpp": "222201001",
        "payerName": "Общество с ограниченной ответственностью \"Клиент\"",
        "payingCondition": "string",
        "purposeCode": "2",
        "receiptDate": "2018-12-31",
        "valueDate": "2018-12-31"
      },
      "swiftTransfer": {
        "bankOperationCode": "CRED",
        "beneficiaryBankAccount": "LOYDGB21321",
        "beneficiaryBankName": "BANCO DE SABADELL, S.A. 1, PLAZA CATALUNYA SABADELL ES ",
        "beneficiaryBankOption": "D",
        "beneficiaryCustomerAccount": "/FI8850000120266333",
        "beneficiaryCustomerName": "SUN-KING KNITTED BELT PRODUCT LTD. N.39,DONGMEN ROAD FUQING CITY,FUJIAN,CHINA",
        "detailsOfCharges": "OUR",
        "exchangeRate": "67,74",
        "instructedAmount": "USD70,",
        "instructionCode": "URGP",
        "intermediaryBankAccount": "COBADEFF",
        "intermediaryBankName": "BANCA POPOLARE DELL'ETRURIA E DEL LAZIO (SEDE DI MILANO) MILANO ",
        "intermediaryBankOption": "D",
        "messageDestinator": "LAPBLV2X",
        "messageIdentifier": "S000013082900014",
        "messageOriginator": "SABRRU2P",
        "messageReceiveTime": "15-05-27 14:01",
        "messageSendTime": "15-05-27 13:21",
        "messageType": "103",
        "orderingCustomerAccount": "/08251801040004813",
        "orderingCustomerName": "DONGNING JIXIN INDUSTRY AND TRADE(GROUP) CO.,LTD. NO.98 FANRONG STREET DONGNING COUNTY",
        "orderingCustomerOption": "K",
        "orderingInstitutionAccount": "ABOCBNBJ080",
        "orderingInstitutionName": "SABRRUMM011 SBERBANK (OPERATIONS DEPARTMENT) MOSCOW",
        "orderingInstitutionOption": "A",
        "receiverCharges": "EUR13,19",
        "receiverCorrespondentAccount": "CHASDEFX",
        "receiverCorrespondentName": "THE BANK OF NEW YORK MELLON NEW YORK,NY ",
        "receiverCorrespondentOption": "D",
        "regulatoryReporting": "/N10/NS/N4/12345678901234567890/N5/12345678901/N6/TP/N7 МS.05.2003/N8/123456789012345/N9/12.05.2003",
        "remittanceInformation": "CONTRACT NO SE/00233 DATED 06.03.2012, INVOICE NO 4783",
        "senderCharges": "USD7,03",
        "senderCorrespondentAccount": "BOTKGB2L",
        "senderCorrespondentName": "CITIBANK N.A. NEW YORK,NY ",
        "senderCorrespondentOption": "D",
        "senderToReceiverInformation": "/NZP/OT 15.03.2009. NDS NE OBLAGAETSYA",
        "transactionReferenceNumber": "S380609091426498",
        "transactionRelatedReference": "S380609091426498",
        "transactionTypeCode": "N1",
        "urgent": "NORMAL",
        "valueDateCurrencyInterbankSettledAmount": "130824EUR5447,34"
      },
      "uuid": "55daccdf-de87-3879-976c-8b8415c8caf9",
      "transactionId": "6540997758406"
    }
  ]
}

Если в запросе был передан http-заголовок Accept со значением application/jose, то ответ вернется в формате JOSE в представлении JWS Compact Serialization.

Получение реквизитов по выписке

Ресурс /v1/statement/transactions/{id} позволяет Партнеру получить реквизиты операции по выписке, предварительно получив уведомление с идентификатором операции.

Шаги

1. Получить AccessToken.

2. Отправить запрос.

Для получения реквизитов операции необходимо отправить GET-запрос (/v1/statement/transactions/{id}), в котором передать авторизационный токен к данным клиента (Access Token) и идентификатор операций. Авторизационный токен передается в параметре Authorization заголовка запроса.

Чтобы получить доступ к ресурсу, необходимо передать в scope сервис GET_STATEMENT_ACCOUNT.

Модель запроса

Header Parameters
Authorization String
Access token собственной организации, полученный через SSO.
Пример: Bearer 8190f687-c916-453b-9d68-0ce22f4f3f9d-1
Path Parameters
id String Идентификатор операции

Пример запроса

curl -X GET --header 'Accept: text/html' --header

'Authorization:Bearer 8190f687-c916-453b-9d68-0ce22f4f3f9d-1'

'https://edupirfintech.sberbank.ru:9443/fintech/api/v1/statement/transactions/6540997758406'

Модель ответа

Модель ответа совпадает с /v1/statement/transactions.

Получение информации об оборотах

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

Шаги

1. Получить AccessToken.

2. Отправить запрос.

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

Чтобы получить доступ к ресурсу, необходимо передать в scope сервис GET_STATEMENT_ACCOUNT.

Модель запроса

Header Parameters
Authorization String
Access token клиента, полученный через SSO.
Пример: Bearer 8190f687-c916-453b-9d68-0ce22f4f3f9d-1
Query Parameters
accountNumber String Номер счета
statementDate DateTime Номер запрашиваемой страницы.
page Integer Номер запрашиваемой страницы. По умолчанию 100 операций на странице.

Пример запроса

curl -X GET --header 'Accept: application/json' --header

'Authorization:  Bearer 8190f687-c916-453b-9d68-0ce22f4f3f9d-1'

'https://edupirfintech.sberbank.ru:9443/fintech/api/v1/statement/summary?

accountNumber=40702810340399653236&statementDate=2019-06-26'
Для получения тестовой выписки в Swagger необходимо использовать Access token 9e1efef1-e584-4c6f-9da3-34a04d203308-1 и параметры accountNumber=40702810038120042645, statementDate=2021-03-24.

Модель ответа

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) Входящий остаток в валюте счета,DEBIT, "CREDIT",
openingBalanceRub (Amount, optional) Входящий остаток в рублях,
openingRate (number, optional) Курс ЦБ за единицу валюты на начало периода
}Amount {
amount (number, optional) Сумма ,
currencyName (string, optional) Буквенный ISO-код валюты
}

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

{
  "composedDateTime": "2021-03-24T00:00:00",
  "lastMovementDate": "2017-08-17",
  "openingRate": null,
  "openingBalance": {
    "amount": "100.10",
    "currencyName": "RUB"
  },
  "openingBalanceRub": {
    "amount": "100.10",
    "currencyName": "RUB"
  },
  "closingBalance": {
    "amount": "100.10",
    "currencyName": "RUB"
  },
  "closingBalanceRub": {
    "amount": "100.10",
    "currencyName": "RUB"
  },
  "debitTurnover": {
    "amount": "616147.76",
    "currencyName": "RUB"
  },
  "debitTurnoverRub": {
    "amount": "616147.76",
    "currencyName": "RUB"
  },
  "debitTransactionsNumber": 15,
  "creditTurnover": {
    "amount": "616147.76",
    "currencyName": "RUB"
  },
  "creditTurnoverRub": {
    "amount": "616147.76",
    "currencyName": "RUB"
  },
  "creditTransactionsNumber": 15
}

Формирование печатной формы выписки

Ресурс /v1/statement/files позволяет сформировать печатную форму файла выписки и получить идентификатор задачи, по которому можно запросить ссылку на скачивание печатной формы выписки за нужную дату и в разных форматах.

В дальнейшем файл можно загрузить в другие системы.

Шаги

1. Получить AccessToken.

2. Отправить запрос.

3. Получить ссылку на скачивание файла

Для получения идентификатора задачи, необходимо отправить GET-запрос (/v1/statement/files), в котором передать авторизационный токен к данным организации клиента (Access Token) и параметры запроса. Авторизационный токен передается в параметре Authorization заголовка запроса.

Чтобы получить доступ к ресурсу, необходимо передать в scope сервис GET_STATEMENT_ACCOUNT.

Модель запроса и ответа

Header Parameters
Authorization String
Access token организации-клиента, полученный через SSO
Пример: Bearer c76fb018-27c9-43f7-a751-62646eda7e1a-1
Query Parameters
accountNumber String Номер счета (^[0-9]{20}$)
Пример: 40702810340399653236
statementDate Date, optional Дата запрашиваемой выписки (по умолчанию текущий день) (yyyy-MM-dd)
encoding String, optional Кодировка выписки (по умолчанию WINDOWS) Варианты кодировок: DOS, WINDOWS, UTF8
format String Формат запрашиваемой выписки Варианты форматов: 1С, MT940, camt053

Пример запроса

curl -X GET --header 'Accept: application/json' --header

'Authorization: Bearer c76fb018-27c9-43f7-a751-62646eda7e1a-1'

'https://edupirfintech.sberbank.ru:9443/fintech/api/v1/statement/files

accountNumber=40702810340399653236&statementDate=2019-06

26&encoding=WINDOWS&format=1C'

Модель ответа

{
taskId (Number) Идентификатор задачи для получения ссылки на скачивание. Возвращается один идентификатор задачи на все выбранные форматы
}

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

{

"taskId": 121

}

Формирование выписки в разных форматах

Ресурс /v1/statement/print позволяет сформировать печатную форму файла выписки и получить идентификатор задачи, по которому можно запросить ссылку на скачивание печатной формы выписки за нужную дату и в разных форматах.

Шаги

1. Получить AccessToken.

2. Отправить запрос.

Для получения печатной формы необходимо отправить GET-запрос (/v1/statement/print), в котором передать авторизационный токен к данным организации клиента (Access Token) и параметры запроса. Авторизационный токен передается в параметре Authorization заголовка запроса.

Модель запроса

Header Parameters
Authorization String
Access token организации-клиента, полученный через SSO
Пример: Bearer c76fb018-27c9-43f7-a751-62646eda7e1a-1
Query Parameters
accountNumber String Номер счета (^[0-9]{20}$)
statementDate String Дата выписки (yyyy-MM-dd)
format Array[string] Формат запрашиваемой выписки Возможно передать запрос на предоставление выписки в нескольких форматах Если в запросе указано несколько форматов: с использованием перечисления форматов через символ & format=PDF&format=EXCEL&format=DOCX&format=RTF с использованием перечисления форматов через запятую
format=PDF,EXCEL,DOCX,RTF

Пример запроса

curl -X GET --header 'Accept: application/json' --header

'Authorization: Bearer c76fb018-27c9-43f7-a751-62646eda7e1a-1'

'https://edupirfintech.sberbank.ru:9443/fintech/api/v1/statement/print

accountNumber=40702810340399653236&statementDate=2019-06

26&format=PDF%2CEXCEL%2CDOCX%2CRTF'

Модель ответа

{
taskId (Number) Идентификатор задачи для получения ссылки на скачивание,возвращается один идентификатор задачи на все выбранные форматы
}

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

{

"taskId": 121

}

Получение печатной формы выписки

Ресурс /v1/statement/transactions/{transactionId}/print позволяет получить печатную форму выписки по одной операции в разных форматах.

Шаги

1. Получить AccessToken.

2. Отправить запрос.

Для того что бы получить печатную форму выписки по одной операции необходимо отправить GET-запрос (/v1/statement/transactions/{transactionId}/print), в котором передать авторизационный токен к данным организации клиента (Access Token), идентификатор платежного поручения и формат документа в параметре запроса. Авторизационный токен передается в параметре Authorization заголовка запроса.

Чтобы получить доступ к ресурсу, необходимо передать в scope сервис GET_STATEMENT_TRANSACTION.

Модель запроса

Header Parameters
Authorization String
Access token организации-клиента, полученный через SSO
Пример: Bearer c76fb018-27c9-43f7-a751-62646eda7e1a-1
Query Parameters
transactionId String (36) Идентификатор платежного поручения Пример: c76fb018-27c9-43f7-a751-62646eda7e1a-1
format String Форматы запрашиваемой платежки (PDF, RTF, XLSX, DOCX) Пример: PDF

Пример запроса

curl -X GET --header 'Accept: application/json' --header

'Authorization: Bearer c76fb018-27c9-43f7-a751-62646eda7e1a-1'

'https://edupirfintech.sberbank.ru:9443/fintech/api/v1/statement/

transactions/{transactionId}/print?transactionId=c76fb018-27c9-43f7-a751-62646eda7e1a-1&format=PDF'

Модель ответа

{
file (String) Файл выписки в формате String
}

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

{

"file": "Rk1SACAyMAAAAAFAVvDODnAYEwNI..."

}

Дополнительная информация

Формирование JOSE в представлении JWS Compact Serialization

Ответы формируются в виде компактной сериализации JWS по международной спецификации RFC 7515: JSON Web Signature (JWS).

JWS состоит из трех частей:

  • заголовок (Header)
  • JSON-объект с реквизитным составом ответа (Payload)
  • подпись (Signature)

и формируется как Base64Url(Header) || ’.’ || Base64Url(Payload) || ’.’ || Base64Url(Signature)

  1. Заголовок (Header):
    JSON-объект, содержащий тип токена, в данном случае JOSE; алгоритм подписи, в данном случае gost34.10-2012, и UUID сертификата технологического криптопрофиля Банка парный приватному ключу, которым подписан JOSE.

Пример

{

"typ": "JOSE",

"alg": "gost34.10-2012",

"kid": "b994381d-d886-4b5a-9407-1672952610aa"

}
  1. JSON-объект с реквизитным составом документа (Payload):
    содержимое Payload изменяется в зависимости от реквизитного состава и типа запроса.
  2. Подпись (Signature): подпись данных приватной частью ключевой пары СББОЛ (используется приватный ключ парный сертификату технологического криптопрофиля Банка с UUID, указанному в Заголовке (Header) в параметре kid).
    Подпись вычисляется по алгоритму указанному в Заголовке (Header) в параметре alg, в данном случае gost34.10-2012, и вычисляется от исходных данных:
    Base64Url(**Header**) || ‘.’ || Base64Url(**Payload**)

Формирование исходных данных для вычисления подписи описано в спецификации RFC 7515: JSON Web Signature (JWS).

Коды возврата

Коды возврата Описание кода возврата Причина возникновения
200 OK
Успешный код возврата
202 STATEMENT_RESPONSE_PROCESSING
Сводка по выписке не готова или данные в ней неактуальны. Следует запросить позже. В СББОЛ нет готовой выписки за указанный день и создан запрос формирования первой выписки. На момент поступления запроса данные в выписке по счету неактуальны. Создан запрос на обновление выписки.
400 DESERIALIZATION_FAULT
Неверный формат запроса Неверный формат запроса
WORKFLOW_FAULT
Нельзя запросить выписку за дату в будущем Дата выписки позже текущей
Счет не является действующим на запрошенную дату Счет не является действующим на запрошенную дату
VALIDATION_FAULT
Ошибка валидации Ошибка валидации данных запроса с указанием некорректных значений. Значения полей модели или параметров запроса не соответствуют допустимым и определенным в модели.
Указанный счет не является валютным счетом, формирование выписки в формате SWIFT невозможно Указан рублевый счет
401 UNAUTHORIZED
accessToken not found by value =хххххххх-хххх-хххх-хххх-хххххххххххх-х Указан некорректный или просроченный access_token.
403 ACTION_ACCESS_EXCEPTION
Операция не может быть выполнена: доступ к ресурсу запрещен У пользователя нет прав на использование соответствующего сервиса SberBusinessAPI, доступ к которому не предусмотрен настройками scope; У пользователя отсутствует оферта с внешним сервисом
404 DATA_NOT_FOUND_EXCEPTION
Выписка за указанную дату недоступна, пожалуйста, обратитесь в техническую поддержку Выписки физически нет в системе(по техническим причинам), т.е не возвращается ни заголовок выписки, ни операции.
500 UNKNOWN_EXCEPTION
Внутренняя ошибка сервера
503 UNAVAILABLE_RESOURCE_EXCEPTION
Сервис временно недоступен Проводятся технические работы

Заметили ошибку?

Выделите текст и нажмите Ctrl + Enter, чтобы сообщить нам о ней