Основные сценарии использования
Получение выписок в форматах SWIFT
API позволяет получить выписки в двух форматах: MT940 и MT942. MT940 используется для итоговых выписок, а MT942 для внутридневных. Также для внутридневных выписок можно получить дельту (изменения) между уже полученной и новой выпиской, если она уже есть.
Получение итоговой выписки в формате MT940
Для получения выписки MT940 необходимо отправить GET запрос на адрес
/v1/accounts/{account}/statements/mt940, где {account} - номер
счета, по которому запрашивается выписка.
Важно! Информацию о готовности итоговой выписки можно получить пользуясь методами описанными в разделе про выписки в формате JSON.
Пример запроса:
curl -X 'GET'
'https://api.openapi.raiffeisen.ru/api/v1/accounts/4070281000000XXXXXXX/statements/mt940'
-H 'accept: text/plain'
-H 'Id-Token: {ВАШ_ТОКЕН}'
-H 'Authorization: Bearer {ВАШ_ТОКЕН_ПОЛУЧЕННЫЙ_ПРИ_АВТОРИЗАЦИИ}'
При этом метод поддерживает query параметры:
- date - дата запрашиваемой выписки.
- field86 - позволяет выбрать в каком формате будет описано 86-е поле выписки. Поддерживаются значения MT940_OLD и MT940_SEPA. По умолчанию - MT940_SEPA
- transliteration - задает необходимость транслитерации кириллицы в 86-м поле
Пример запроса для получения выписки за 16.10.2021 с транслитерацией 86-го в формате MT940_SEPA (NZP)
Запрос:
curl -X 'GET'
'https://api.openapi.raiffeisen.ru/api/v1/accounts/4070281000000XXXXXXX/statements/mt940?date=16.10.2021&field86=MT940_OLD&transliteration=true'
-H 'accept: text/plain'
-H 'Id-Token: {ВАШ_ТОКЕН}'
-H 'Authorization: Bearer {ВАШ_ТОКЕН_ПОЛУЧЕННЫЙ_ПРИ_АВТОРИЗАЦИИ}'
Ответ:
:20:GL211016000001 :25:RZBMRUMM/4070281000000XXXXXXX/RUB :28C:00208 :60F:C201116RUB0,00 :61:2110161116D500,00NTRF393//211016PEOI022307 'P'/'O' 393,40101810500000010004 :86:020?00Payment Order?10?20OPLATA STRAHOVYH VZNOSOV NA?21 OBaZATELX NOE MEDICINSKOGO ?22STRAHOVANIa ZA 3 KV.2020 ND?23S NE OBLAGAETSa ?24?25?26?27?28?29?30042007001?3140101810500000010004?32UFK PO VO RONEJSKOi OBLASTI ?33(IFNS ROSSII PO LEVOBEREJNO?34?350?603663052 143?61393?62?63Код дохода ? :61:2110161116D600,00NTRF390//211016PEOI021826 'P'/'O' 390,40101810500000010004 :86:020?00Payment Order?10?20OPLATA STRAHOVYH VZNOSOV NA?21 OBaZATELX NOE MEDICINSKOGO ?22STRAHOVANIa ZA 3 KV.2020 ND?23S NE OBLAGAETSa ?24?25?26?27?28?29?30042007001?3140101810500000010004?32UFK PO VO RONEJSKOi OBLASTI ?33(IFNS ROSSII PO LEVOBEREJNO?34?350?603663052 143?61390?62?63Код дохода ? :62F:D211016RUB106517,64 :64:C211016RUB101253,57
Пример запроса для получения выписки за 18.10.2021 без транслитерации 86-го в формате MT940_OLD (NZP)
Запрос:
curl -X 'GET'
'https://api.openapi.raiffeisen.ru/api/v1/accounts/4070281000000XXXXXXX/statements/mt940?date=16.10.2021&field86=MT940_OLD&transliteration=true'
-H 'accept: text/plain'
-H 'Id-Token: {ВАШ_ТОКЕН}'
-H 'Authorization: Bearer {ВАШ_ТОКЕН_ПОЛУЧЕННЫЙ_ПРИ_АВТОРИЗАЦИИ}'
Ответ:
:20:GL211018000001 :25:RZBMRUMM/4070281000000XXXXXXX/RUB :28C:00210 :60F:C211018RUB81515,04 :61:2110181118D80000,00NTRF396//211018PEOI001212 P/O 396,4070281000000XXXXXXX :86:/ORD/INN 3663052143 УФК по Воронежской области (ИФНС России по Ле вобережному району г.Воронежа)/NPP/396/UIP/0/NZP/оплата УСН за 4 квартал 2020 г. НДС не облагается :62F:C211018RUB1515,04 :64:C211018RUB11515,04
Получение внутридневной выписки в формате MT942
Для получения внутридневной выписки MT942 необходимо отправить GET запрос на адрес
/v1/accounts/{account}/statements/mt942, где {account}- номер
счета, по которому запрашивается выписка.
Пример запроса:
curl -X 'GET'
'https://api.openapi.raiffeisen.ru/api/v1/accounts/4070281000000XXXXXXX/statements/mt942'
-H 'accept: text/plain'
-H 'Id-Token: {ВАШ_ТОКЕН}'
-H 'Authorization: Bearer {ВАШ_ТОКЕН_ПОЛУЧЕННЫЙ_ПРИ_АВТОРИЗАЦИИ}'
При этом метод поддерживает query параметры:
- field86 - позволяет выбрать в каком формате будет описано 86-е поле выписки. Поддерживаются значения MT940_OLD и MT940_SEPA. По умолчанию - MT940_SEPA
- transliteration - задает необходимость транслитерации кириллицы в 86-м поле
Пример запроса внутридневной выписки
curl -X 'GET'
'https://api.openapi.raiffeisen.ru/api/v1/accounts/4070281000000XXXXXXX/statements/mt942'
-H 'accept: text/plain'
-H 'Id-Token: {ВАШ_ТОКЕН}'
-H 'Authorization: Bearer {ВАШ_ТОКЕН_ПОЛУЧЕННЫЙ_ПРИ_АВТОРИЗАЦИИ}'
Ответ:
:20:SW210122000001 :25:RZBMRUMM/4070281000000XXXXXXX :28C:01006 :34F:RUB0, :13D:2101101229+0300 :61:2101220922D1000,00NTRF704//190321PCIN044330 P/O 223,4070281000000XXXXXXX :86:020?00Payment Order?10?20НДС 12%?21?22?23?24?25?26?27?28?29?30044 525700?3140702810700001470239?32ООО Арт Базар Пром?33?34?35?60770 6804648?61704?62?63Код дохода ? :61:2101220922D1000,00NTRF705//190321PCIN044330 P/O 223,4070281000000XXXXXXX :86:020?00Payment Order?10?20НДС 12%?21?22?23?24?25?26?27?28?29?30044 525700?3140702810700001470239?32ООО Арт Базар Пром?33?34?35?60770 6804648?61705?62?63Код дохода ? :61:2101220922C1000,00NTRF706//190321PCIN044330 P/O 223,4070281000000XXXXXXX :86:020?00Payment Order?10?20НДС 12%?21?22?23?24?25?26?27?28?29?30044 525700?3140702810700001470239?32ООО Арт Базар Пром?33?34?35?60770 6804648?61706?62?63Код дохода ? :90D:2RUB2000,00 :90C:1RUB1000,00
Получение дельты между какой-либо внутридневной выпиской и последней новой
Этот сценарий позволит получить все новые транзакции, которые еще не были отражены в одной из внутридневных выписок.
Представим себе, что в течение дня совершаются операции А, Б и В.
После совершения операции А, через некоторое время запросим внутридневную выписку. В ней будет отражена информация об операции А. Номер выписки 00001.
Далее совершим операции Б и В.
Теперь, если запросить дельту, указав, что хотим получить дельту относительно выписки с номером 00001, мы получим выписку, в которой будут отражены только операции Б и С. Номер выписки 00002.
Если не указывать номер выписки относительно которой желаем получить дельту, то эффект будет такой же, как и от предыдущего метода (будут отражены все операции за текущий день)
Пример запроса дельты относительно выписки с номером 00001
curl -X 'GET'
'https://api.openapi.raiffeisen.ru/api/v1/accounts/ds/statements/mt942/delta?lastSentNumber=00001&field86=MT940_SEPA&transliteration=false'
-H 'accept: text/plain'
-H 'Id-Token: {ВАШ_ТОКЕН}'
-H 'Authorization: Bearer {ВАШ_ТОКЕН_ПОЛУЧЕННЫЙ_ПРИ_АВТОРИЗАЦИИ}'
Ответ:
:20:SW210122000001 :25:RZBMRUMM/4070281000000XXXXXXX :28C:00002 :34F:RUB0, :13D:2101101229+0300 :61:2101220922D1000,00NTRF705//190321PCIN044330 P/O 223,4070281000000XXXXXXX :86:020?00Payment Order?10?20НДС 12%?21?22?23?24?25?26?27?28?29?30044 525700?3140702810700001470239?32ООО Арт Базар Пром?33?34?35?60770 6804648?61705?62?63Код дохода ? :61:2101220922C1000,00NTRF706//190321PCIN044330 P/O 223,4070281000000XXXXXXX :86:020?00Payment Order?10?20НДС 12%?21?22?23?24?25?26?27?28?29?30044 525700?3140702810700001470239?32ООО Арт Базар Пром?33?34?35?60770 6804648?61706?62?63Код дохода ? :90D:1RUB1000,00 :90C:1RUB1000,00
Как видно, в поле 28С указан номер внутридневной выписки - 00002.
Получение выписок в формате 1С "Клиент Банка"
API позволяет получить итоговые или внутридневные выписки в формате 1С по номеру счета, готовые на момент выполнения запроса. Тип полученной выписки зависит от готовности итоговой. Если за запрашиваемую дату уже была готова итоговая, то вернется она. Иначе, вернется внутридневная.
Выборку можно ограничить датой. Результаты отдаются постранично и содержат основные данные выписки.
Пример использования для подтверждения готовности итоговой или внутридневной выписки
Для получения выписки в формате 1C необходимо отправить GET запрос на адрес /v1/accounts/{account}/statements/1c, где {account}- номер счета, по которому запрашивается выписка.
При этом метод поддерживает query параметр:
- date - дата запрашиваемой выписки. По умолчанию текущая.
Для получения выписки, нужно сделать вызов.
Пример вызова:
curl -X GET \
https://api.openapi.raiffeisen.ru/api/v1/accounts/4070281030000ХХХХХХХ/statements/1c?date=yyyy-MM-dd" \
-H "accept: text/plain" \
-H "Id-Token: `{ВАШ_ТОКЕН}`" \
-H "Authorization: Bearer `{ВАШ_ТОКЕН_ПОЛУЧЕННЫЙ_ПРИ_АВТОРИЗАЦИИ}`Пример ответа при готовности выписки:
1CClientBankExchange
ВерсияФормата=1.03
Кодировка=windows-1251
Отправитель=
Получатель=
ДатаСоздания=20.10.2021
ВремяСоздания=17:06:07
ДатаНачала=14.12.2020
ДатаКонца=14.12.2020
РасчСчет=4070281030000ХХХХХХХ
СекцияРасчСчет
ДатаНачала=14.12.2020
ДатаКонца=14.12.2020
РасчСчет=4070281030000ХХХХХХХ
НачальныйОстаток=120597.16
ВсегоПоступило=196339.26
ВсегоСписано=0
КонечныйОстаток=214592.17
КонецРасчСчет
СекцияДокумент=Платежное поручение
Номер=1709
Дата=14.12.2020
Сумма=32223.5
ПлательщикСчет=40802810064580ХХХХХХХ
Плательщик=Тестовый Тест Тестович (ИП)
ПлательщикИНН=615400001013
ПлательщикКПП=
ПлательщикРасчСчет=40802810064580ХХХХХХХ
ПлательщикБанк1=ЮГО-ЗАПАДНЫЙ БАНК АО ТЕСТОВЫЙ БАНК Г РОСТОВ-НА-ДОНУ
ПлательщикБИК=046015100
ПлательщикКорсчет=3010181060000ХХХХХХХ
ПолучательСчет=40702810300000ХХХХХХХ
ДатаПоступило=14.12.2020
Получатель=ООО Тестовая Организация 1
ПолучательИНН=3663000014
ПолучательКПП=366301001
ПолучательРасчСчет=40702810300000ХХХХХХХ
ПолучательБанк1=АО "РАЙФФАЙЗЕНБАНК" Г МОСКВА
ПолучательБИК=044525700
ПолучательКорсчет=30101810200000ХХХХХХХ
ВидОплаты=01
ВидПлатежа=
КодНазПлатежа=
Код=
ОКАТО=
Очередность=5
СтатусСоставителя=
ПоказательДаты=
ПоказательКБК=
ПоказательНомера=
ПоказательОснования=
ПоказательПериода=
ПоказательТипа=
НазначениеПлатежа=Оплата по накладной №8239 от 04.12.2020 г. сумма 32223-50 без налога (НДС)
КонецДокумента
КонецФайла