Raiffeisen bank integration API
OpenAPI
Raiffeisen bank Integration API documentation
Варианты
- Паблик
Операции API
GET /v1/accounts/{account}/statements/mt940 — Receive a SWIFT statement by account number
This method is deprecated. Use the [new `/bank-statements/v1/reports/mt-940`](https://developer.raif.ru/docs/api/bank-statements/mt-940-request) instead.
{
"tags": [
"FinalStatementMT940"
],
"summary": "Receive a SWIFT statement by account number",
"description": "This method is deprecated. Use the [new `/bank-statements/v1/reports/mt-940`](https://developer.raif.ru/docs/api/bank-statements/mt-940-request) instead.\n",
"operationId": "getStatementMt940",
"parameters": [
{
"name": "account",
"description": "Account number",
"in": "path",
"required": true,
"schema": {
"type": "string",
"example": 40702810000006960000
}
},
{
"name": "date",
"in": "query",
"description": "Statement date.",
"required": false,
"schema": {
"type": "string",
"format": "date",
"example": "2020-01-01T00:00:00.000Z"
}
},
{
"name": "field25",
"in": "query",
"required": false,
"description": "Format field 25. Allowed to enter variables (be sure to put them in square brackets) [RCBIC] - BIC (Russian Central Bank Identification Code), [SWIFT] - international SWIFT BIC, [Account Number] - account Number, [Cur] - ISO code of account currency. No more than 3 variables can be selected at a time. Use as a separator /",
"schema": {
"type": "string",
"example": "[SWIFT]/[Account Number]"
}
},
{
"name": "field86",
"in": "query",
"required": false,
"description": "Format field 86",
"schema": {
"type": "string",
"enum": [
"MT940_OLD",
"MT940_SEPA",
"DISABLED"
]
}
},
{
"name": "transliteration",
"in": "query",
"required": false,
"description": "The need for transliteration of the Cyrillic alphabet in the 86th field",
"schema": {
"type": "boolean",
"default": false
}
},
{
"$ref": "#/components/parameters/IdTokenHeader"
}
],
"responses": {
"200": {
"description": "Statement was successfully received (content encoding UTF-8)",
"headers": {
"X-Rate-Limit-Limit": {
"$ref": "#/components/headers/X-Rate-Limit-Limit"
},
"X-Rate-Limit-Remaining": {
"$ref": "#/components/headers/X-Rate-Limit-Remaining"
},
"X-Rate-Limit-Reset": {
"$ref": "#/components/headers/X-Rate-Limit-Reset"
}
},
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"examples": {
"sepa": {
"value": ":20:GL211014000001\n:25:RZBMRUMM/4070281000000XXXXXXX\n:28C:00222\n:60F:C211014RUB0,00\n:61:2101410142D1000,00NTRF3ce-9553e9871837//190321PCIN044330\nP/O 223,4070281000000XXXXXY\n:86:020?00Payment Order?10?20НДС 12%?21?22?23?24?25?26?27?28?29?30044 525700?314070281000000XXXXXY?32ООО ХХХХХХХХ?33?34?35?60123 4567890?61705?62?63Код дохода ?\n:61:2009220922D1000,00NTRF3ce-9553e9871837//190321PCIN044335\nP/O 223,4070281000000XXXXXY\n:86:020?00Payment Order?10?20НДС 12%?21?22?23?24?25?26?27?28?29?30044 525700?3140702810700001470239?32ООО ХХХХХХХХ?33?34?35?60123 4567890?61705?62?63Код дохода ?\n:61:2009220922C1000,00NTRF3ce-9553e9871837//190321PCIN046130\nP/O 223,4070281000000XXXXXXX\n:86:020?00Payment Order?10?20НДС 12%?21?22?23?24?25?26?27?28?29?30044 525700?3140702810700001470239?32ООО ХХХХХХХХ?33?34?35?60123 4567890?61705?62?63Код дохода ?\n:62F:D200922RUB3000,00\n:64:C200922RUB11005,77"
},
"nzp": {
"value": ":20:GL211014000001\n:25:RZBMRUMM/4070281000000XXXXXXX\n:28C:00222\n:60F:C211014RUB0,00\n:61:2101410142D1000,00NTRF3ce-9553e9871837//190321PCIN044323\nP/O 223,4070281000000XXXXXXY\n:86:/ORD/INN 1234567890 УФК по Воронежской области (ИФНС России по Ле вобережному району г.Воронежа)/NPP/706/UIP/0/NZP/оплата УСН за 4 квартал 2020 г. НДС не облагается\n:61:2009220922D1000,00NTRF3ce-9553e9871837//190321PCIN044345\nP/O 223,4070281000000XXXXXXY\n:86:/ORD/INN 1234567890 УФК по Воронежской области (ИФНС России по Ле вобережному району г.Воронежа)/NPP/706/UIP/0/NZP/оплата УСН за 4 квартал 2020 г. НДС не облагается\n:61:2009220922C1000,00NTRF3ce-9553e9871837//190321PCIN044227\nP/O 223,4070281000000XXXXXXY\n:86:/ORD/INN 1234567890 УФК по Воронежской области (ИФНС России по Ле вобережному району г.Воронежа)/NPP/706/UIP/0/NZP/оплата УСН за 4 квартал 2020 г. НДС не облагается\n6804648?61706?62?63Код дохода ?\n:62F:D200922RUB3000,00\n:64:C200922RUB11005,77"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"429": {
"$ref": "#/components/responses/RateLimit"
}
}
}GET /v1/accounts/{account}/statements/mt942 — Receive an intraday SWIFT mt942 statement by account number
This method is deprecated. Use the [new `/bank-statements/v1/reports/mt-942`](https://developer.raif.ru/docs/api/bank-statements/mt-942-request) instead.
{
"tags": [
"IntradayStatementMT942"
],
"summary": "Receive an intraday SWIFT mt942 statement by account number",
"description": "This method is deprecated. Use the [new `/bank-statements/v1/reports/mt-942`](https://developer.raif.ru/docs/api/bank-statements/mt-942-request) instead.\n",
"operationId": "getStatementMt942",
"parameters": [
{
"name": "account",
"description": "Account number",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "field86",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"MT940_OLD",
"MT940_SEPA",
"DISABLED"
]
}
},
{
"name": "transliteration",
"in": "query",
"required": false,
"description": "The need for transliteration of the Cyrillic alphabet in the 86th field",
"schema": {
"type": "boolean",
"default": false
}
},
{
"$ref": "#/components/parameters/IdTokenHeader"
}
],
"responses": {
"200": {
"description": "Statement was successfully received (content encoding UTF-8)",
"headers": {
"X-Rate-Limit-Limit": {
"$ref": "#/components/headers/X-Rate-Limit-Limit"
},
"X-Rate-Limit-Remaining": {
"$ref": "#/components/headers/X-Rate-Limit-Remaining"
},
"X-Rate-Limit-Reset": {
"$ref": "#/components/headers/X-Rate-Limit-Reset"
},
"text/plain": {
"schema": {
"type": "string"
},
"examples": {
"sepa": {
"value": ":20:SW210122000001\n:25:RZBMRUMM/4070281000000XXXXXXX\n:28C:01006\n:34F:RUB0,\n:13D:2101101229+0300\n:61:2101220922D1000,00NTRF704//190321PCIN044330\nP/O 223,4070281000000XXXXXXX\n:86:020?00Payment Order?10?20НДС 12%?21?22?23?24?25?26?27?28?29?30044\n525700?3140702810700001470239?32ООО Арт Базар Пром?33?34?35?60770\n6804648?61704?62?63Код дохода ?\n:61:2101220922D1000,00NTRF705//190321PCIN044330\nP/O 223,4070281000000XXXXXXX\n:86:020?00Payment Order?10?20НДС 12%?21?22?23?24?25?26?27?28?29?30044\n525700?3140702810700001470239?32ООО Арт Базар Пром?33?34?35?60770\n6804648?61705?62?63Код дохода ?\n:61:2101220922C1000,00NTRF706//190321PCIN044330\nP/O 223,4070281000000XXXXXXX\n:86:020?00Payment Order?10?20НДС 12%?21?22?23?24?25?26?27?28?29?30044\n525700?3140702810700001470239?32ООО Арт Базар Пром?33?34?35?60770\n6804648?61706?62?63Код дохода ?\n:90D:2RUB2000,00\n:90C:1RUB1000,00"
},
"nzp": {
"value": ":20:SW210923000001\n:25:RZBMRUMM/4070281000000XXXXXXX\n:28C:00002\n:34F:RUB0,\n:13D:2101101229+0300\n:61:2009030903D2,11NTRF618//200903PENN000009\n:86:/ORD/INN 5505208899 ОЛТА ТРЭВЕЛ ООО/NPP/618/UIP/12345620200131125\n257/NZP/В том числе НДС 18.00\n:61:2008310828D2,11NTRF652//200828PENN001013\n:86:/ORD/INN 5505208899 ОЛТА ТРЭВЕЛ ООО/NPP/652/UIP/12345620200131125\n257/NZP/В том числе НДС 18.00\n:61:2009020902D2,11NTRF718//200902PENN000003\n:86:/ORD/INN 5505208899 ОЛТА ТРЭВЕЛ ООО/NPP/718/UIP/12345620200131125\n257/NZP/В том числе НДС 18.00\n:90D:3RUB6,33\n:90C:0RUB0,00"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"429": {
"$ref": "#/components/responses/RateLimit"
}
}
}GET /v1/accounts/{account}/statements/mt942/delta — Receive an intraday delta in SWIFT format by account number
{
"tags": [
"IntradayStatementMT942"
],
"summary": "Receive an intraday delta in SWIFT format by account number",
"operationId": "getStatementMt942deltaBySentNumber",
"parameters": [
{
"name": "account",
"description": "Account number",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "lastSentNumber",
"description": "Number of the statement with which a delta should be generated",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "field86",
"in": "query",
"required": false,
"description": "Desired statement format. MT940_OLD - NZP, MT940_SEPA,",
"schema": {
"type": "string",
"enum": [
"MT940_OLD",
"MT940_SEPA",
"DISABLED"
],
"default": "MT940_SEPA"
}
},
{
"name": "transliteration",
"in": "query",
"required": false,
"description": "The need for transliteration of the Cyrillic alphabet in the 86th field",
"schema": {
"type": "boolean",
"default": false
}
},
{
"$ref": "#/components/parameters/IdTokenHeader"
}
],
"responses": {
"200": {
"description": "Delta was successfully received (content encoding UTF-8)",
"headers": {
"X-Rate-Limit-Limit": {
"$ref": "#/components/headers/X-Rate-Limit-Limit"
},
"X-Rate-Limit-Remaining": {
"$ref": "#/components/headers/X-Rate-Limit-Remaining"
},
"X-Rate-Limit-Reset": {
"$ref": "#/components/headers/X-Rate-Limit-Reset"
}
},
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"examples": {
"sepa": {
"value": ":20:SW210122000001\n:25:RZBMRUMM/4070281000000XXXXXXX\n:28C:00002\n:34F:RUB0,\n:13D:2101101229+0300\n:61:2101220922D1000,00NTRF705//190321PCIN044330\nP/O 223,4070281000000XXXXXXX\n:86:020?00Payment Order?10?20НДС 12%?21?22?23?24?25?26?27?28?29?30044\n525700?3140702810700001470239?32ООО Арт Базар Пром?33?34?35?60770\n6804648?61705?62?63Код дохода ?\n:61:2101220922C1000,00NTRF706//190321PCIN044330\nP/O 223,4070281000000XXXXXXX\n:86:020?00Payment Order?10?20НДС 12%?21?22?23?24?25?26?27?28?29?30044\n525700?3140702810700001470239?32ООО Арт Базар Пром?33?34?35?60770\n6804648?61706?62?63Код дохода ?\n:90D:1RUB1000,00\n:90C:1RUB1000,00"
},
"nzp": {
"value": ":20:SW210923000001\n:25:RZBMRUMM/4070281000000XXXXXXX\n:28C:00002\n:34F:RUB0,\n:13D:2101101229+0300\n:61:2009030903D2,11NTRF618//200903PENN000009\n:86:/ORD/INN 5505208899 ОЛТА ТРЭВЕЛ ООО/NPP/618/UIP/12345620200131125\n257/NZP/В том числе НДС 18.00\n:61:2008310828D2,11NTRF652//200828PENN001013\n:86:/ORD/INN 5505208899 ОЛТА ТРЭВЕЛ ООО/NPP/652/UIP/12345620200131125\n257/NZP/В том числе НДС 18.00\n:61:2009020902D2,11NTRF718//200902PENN000003\n:86:/ORD/INN 5505208899 ОЛТА ТРЭВЕЛ ООО/NPP/718/UIP/12345620200131125\n257/NZP/В том числе НДС 18.00\n:90D:3RUB6,33\n:90C:0RUB0,00"
}
}
}
}
},
"204": {
"description": "There are no new transactions (content encoding UTF-8)",
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": ""
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"429": {
"$ref": "#/components/responses/RateLimit"
}
}
}GET /v1/accounts/{account}/statements/1c — Receive 1C statement by account number
This method is deprecated. Use the [new `/bank-statements/v1/reports/1c`](https://developer.raif.ru/docs/api/bank-statements/one-c-request) instead.
{
"tags": [
"1CClientBankExchange"
],
"summary": "Receive 1C statement by account number",
"description": "This method is deprecated. Use the [new `/bank-statements/v1/reports/1c`](https://developer.raif.ru/docs/api/bank-statements/one-c-request) instead.\n",
"operationId": "getStatement1c",
"parameters": [
{
"$ref": "#/components/parameters/IdTokenHeader"
},
{
"name": "account",
"description": "Account number",
"in": "path",
"required": true,
"example": "40702810300000000001",
"schema": {
"type": "string",
"pattern": "^\\d{20}$"
}
},
{
"name": "date",
"description": "Statement date in the format yyyy-MM-dd. Current date by default",
"in": "query",
"required": false,
"schema": {
"type": "string",
"format": "date",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
}
}
],
"responses": {
"200": {
"description": "Statement was successfully received (content encoding UTF-8)",
"headers": {
"X-Rate-Limit-Limit": {
"$ref": "#/components/headers/X-Rate-Limit-Limit"
},
"X-Rate-Limit-Remaining": {
"$ref": "#/components/headers/X-Rate-Limit-Remaining"
},
"X-Rate-Limit-Reset": {
"$ref": "#/components/headers/X-Rate-Limit-Reset"
}
},
"content": {
"text/plain": {
"schema": {
"type": "string",
"format": "1CClientBankExchange"
},
"example": "1CClientBankExchange\nВерсияФормата=1.03\nКодировка=windows-1251\nОтправитель=\nПолучатель=\nДатаСоздания=20.10.2021\nВремяСоздания=17:06:07\nДатаНачала=14.12.2020\nДатаКонца=14.12.2020\nРасчСчет=40702810300000000001\nСекцияРасчСчет\nДатаНачала=14.12.2020\nДатаКонца=14.12.2020\nРасчСчет=40702810300000000001\nНачальныйОстаток=120597.16\nВсегоПоступило=196339.26\nВсегоСписано=0\nКонечныйОстаток=214592.17\nКонецРасчСчет\nСекцияДокумент=Платежное поручение\nНомер=1709\nДата=14.12.2020\nСумма=32223.5\nПлательщикСчет=40802810064580000001\nПлательщик=Тестовый Тест Тестович (ИП)\nПлательщикИНН=615400001013\nПлательщикКПП=\nПлательщикРасчСчет=40802810064580000001\nПлательщикБанк1=ЮГО-ЗАПАДНЫЙ БАНК АО ТЕСТОВЫЙ БАНК Г РОСТОВ-НА-ДОНУ\nПлательщикБИК=046015100\nПлательщикКорсчет=30101810600000000602\nПолучательСчет=40702810300000000001\nДатаПоступило=14.12.2020\nПолучатель=ООО Тестовая Организация 1\nПолучательИНН=3663000014\nПолучательКПП=366301001\nПолучательРасчСчет=40702810300000000001\nПолучательБанк1=АО \"РАЙФФАЙЗЕНБАНК\" Г МОСКВА\nПолучательБИК=044525700\nПолучательКорсчет=30101810200000000700\nВидОплаты=01\nВидПлатежа=\nКодНазПлатежа=\nКод=\nОКАТО=\nОчередность=5\nСтатусСоставителя=\nПоказательДаты=\nПоказательКБК=\nПоказательНомера=\nПоказательОснования=\nПоказательПериода=\nПоказательТипа=\nНазначениеПлатежа=Оплата по накладной №8239 от 04.12.2020 г. сумма 32223-50 без налога (НДС)\nКонецДокумента\nКонецФайла"
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"429": {
"$ref": "#/components/responses/RateLimit"
}
}
}Схемы и примеры
{
"headers": {
"X-Rate-Limit-Limit": {
"description": "Количество запросов в секунду",
"schema": {
"type": "integer"
}
},
"X-Rate-Limit-Remaining": {
"description": "Оставшееся количество запросов.",
"schema": {
"type": "integer"
}
},
"X-Rate-Limit-Reset": {
"description": "Время в миллисекундах до сброса счетчика запросов.",
"schema": {
"type": "integer"
}
}
},
"securitySchemes": {
"bearerAuth": {
"type": "http",
"scheme": "bearer",
"description": "Access token",
"bearerFormat": "JWT"
}
},
"schemas": {
"GatewayErrorResponse": {
"type": "object",
"required": [
"http_status_code",
"message"
],
"properties": {
"http_status_code": {
"description": "HTTP status",
"type": "integer"
},
"message": {
"description": "Error",
"type": "string"
}
}
},
"ServiceErrorResponse": {
"type": "object",
"required": [
"status",
"error"
],
"properties": {
"status": {
"description": "HTTP status",
"type": "integer"
},
"error": {
"description": "Error",
"type": "string"
},
"message": {
"description": "Error details",
"type": "string"
}
}
}
},
"responses": {
"Unauthorized": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GatewayErrorResponse"
},
"example": {
"http_status_code": 401,
"message": "Unauthorized"
}
}
}
},
"RateLimit": {
"description": "Exceeded the maximum number of request",
"headers": {
"X-Rate-Limit-Limit": {
"description": "Request limit per second",
"schema": {
"type": "integer"
}
},
"X-Rate-Limit-Remaining": {
"description": "The remaining number of requests (count).",
"schema": {
"type": "integer"
}
},
"X-Rate-Limit-Reset": {
"description": "The time in milliseconds before the remain rate count is reset.",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GatewayErrorResponse"
},
"example": {
"http_status_code": 429,
"message": "Rate limit exceeded ! You reach the limit of 10 requests per 10 seconds"
}
}
}
},
"BadRequest": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceErrorResponse"
},
"example": {
"status": 400,
"error": "Bad Request",
"message": "Type mismatch."
}
}
}
},
"NotFound": {
"description": "Requested resource is not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceErrorResponse"
},
"example": {
"status": 404,
"error": "Not Found",
"message": "The requested resource is not found"
}
}
}
}
},
"parameters": {
"IdTokenHeader": {
"name": "Id-Token",
"in": "header",
"description": "User ID token",
"required": true,
"schema": {
"type": "string",
"format": "byte",
"example": "SUQgVE9LRU4gRk9SIFRFU1RJTkc="
}
}
}
}