Raiffeisen bank integration API
OpenAPI
Documentation Raiffeisen bank Integration API
Варианты
- Паблик
Операции API
GET /v1/organizations — Получить список организаций пользователя
{
"tags": [
"Organizations"
],
"summary": "Получить список организаций пользователя",
"operationId": "getOrganizations",
"parameters": [
{
"name": "fields",
"in": "query",
"required": true,
"schema": {
"type": "array",
"description": ".[ID в системе Банка, CNUM, Полное наименование организации, Сокращённое наименование организации, Международное наименование, ИНН, фактический адрес, юридический адрес, международный адрес, КПП (По умолчанию), Отметка о КПП крупнейшего налогоплательщика, Организационно-правовая форма (краткая), ОГРН, Ключ branches содержит не отделения банка в чистом виде, а связку Контракт-Отделение-Услуги ]",
"items": {
"type": "string",
"description": "Возвращаемые параметры.",
"enum": [
"Id",
"Cnum",
"Name",
"ShortName",
"InternationalName",
"Inn",
"Address",
"JuridicalAddress",
"InternationalAddress",
"Kpp",
"KppOfBiggestTaxpayer",
"LawType",
"Ogrn",
"Branches"
]
}
}
},
{
"$ref": "#/components/parameters/IdTokenHeader"
}
],
"responses": {
"200": {
"description": "Список организаций успешно получен.",
"content": {
"application/json": {
"example": "[\n {\n \"id\": \"91852905-2668-4587-90f9-6dbc025e77c0\",\n \"cnum\": \"AAA1AR\",\n \"name\": \"Общество с ограниченной ответственностью тестовая-компания\",\n \"shortName\": \"ООО тестовая-компания\",\n \"internationalName\": \"Test-Company LLC\",\n \"inn\": \"7997777718\",\n \"address\": \"000001, московская обл, г москва, ул Гушкина, д. 0, кв.(оф.) 00\",\n \"juridicalAddress\": \"000001, московская обл, г москва, ул Гушкина, д. 0, кв.(оф.) 00\",\n \"internationalAddress\": \"GUSHKINA UL. D.0 KV.00 000001 MOSCOW RUSSIA\",\n \"kpp\": \"000001000\",\n \"kppOfBiggestTaxpayer\": \"200000000\",\n \"lawType\": \"ООО\",\n \"ogrn\": \"1000006000000\",\n \"branches\": [\n {\n \"id\": \"3002\",\n \"shortName\": \"АО \\\"РАЙФФАЙЗЕНБАНК\\\"\",\n \"fullName\": \"Филиал \\\"Московский\\\" Акционерного общества \\\"Райффайзенбанк\\\" в г. Москва\",\n \"internationalName\": \"Филиал \\\"Московский\\\" Акционерного общества \\\"Райффайзенбанк\\\" в г. Москва\",\n \"nameFor52\": \"AO RAIFFEISENBANK\",\n \"bic\": \"044525700\",\n \"payName\": \"АО \\\"РАЙФФАЙЗЕНБАНК\\\"\",\n \"internationalPayName\": \"AO RAIFFEISENBANK\",\n \"correspondentAccount\": \"30101810200000000700\",\n \"city\": \"МОСКВА\",\n \"internationalCity\": \"MOSCOW\",\n \"swift\": \"RZBMRUMM\",\n \"country\": \"RU\",\n \"countryCode\": \"643\",\n \"address\": \"\",\n \"internationalAddress\": \"BLDG.1 TROITSKAYA STR. 17\",\n \"timeZone\": \"10800\",\n \"contractId\": \"\",\n \"services\": [\n \"mobile-bank\",\n \"templates\",\n \"deposit-request\",\n \"accr-cur\",\n \"accr-rub\",\n \"sms-otp\",\n \"statements\",\n \"order\",\n \"curtransfers\",\n \"conversion\",\n \"rpays\",\n \"reissue-deal-contracts\",\n \"dealpasscredit\",\n \"deal-pass-close\",\n \"confdoccerts\",\n \"reissuedealcredit\",\n \"dealpasscontracts\",\n \"curr-control-info\",\n \"currdealcerts\",\n \"messages-income\",\n \"messages-outcome\",\n \"masspayments\",\n \"certs-regen-req\",\n \"certs-gen-req\",\n \"certs-revocation\",\n \"notifications\",\n \"attach-request\",\n \"salary-payroll\",\n \"detach-request\",\n \"guarantee\"\n ],\n \"accounts\": [\n \"40702978600000000000\",\n \"40702810000001000000\"\n ]\n }\n\n\n ]\n }\n]",
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrganizationResponse"
}
}
}
}
},
"400": {
"description": "Некорректный запрос"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"500": {
"description": "Ошибка на сервере"
}
}
}GET /v1/users — Получение данных пользователя
{
"tags": [
"User"
],
"summary": "Получение данных пользователя",
"operationId": "getUser",
"parameters": [
{
"$ref": "#/components/parameters/IdTokenHeader"
}
],
"responses": {
"200": {
"description": "Пользователь успешно получен",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserResponse"
},
"example": "{\n \"fullName\": \"Тестовый аккаунт для SAP\",\n \"userId\": \"0c0ccccc-cc0c-000e-a000-0000000000ce\",\n \"login\": \"test_account\",\n \"services\": [\n {\n \"id\": \"rpays\",\n \"actions\": {\n \"createByTemplate\": true,\n \"create\": true,\n \"scrollerToExcel\": true,\n \"export\": true,\n \"import\": true\n }\n },\n {\n \"id\": \"masspayments\",\n \"actions\": {\n \"createByTemplate\": false,\n \"create\": true,\n \"scrollerToExcel\": true,\n \"export\": true,\n \"import\": true\n }\n }\n\n ]\n}"
}
}
},
"400": {
"description": "Некорректный запрос"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"500": {
"description": "Ошибка на сервере"
}
}
}GET /v1/users/cryptoprofiles — Получение полномочий и средств подписи клиента.
{
"tags": [
"Cryptoprofiles"
],
"summary": "Получение полномочий и средств подписи клиента.",
"operationId": "getCertificates",
"parameters": [
{
"$ref": "#/components/parameters/IdTokenHeader"
}
],
"responses": {
"200": {
"description": "Список полномочий и средств подписи успешно получен",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SignaturesResponse"
}
},
"example": "{\n \"cryptoProfiles\": [\n {\n \"id\": \"0с00с00с-000с-000с-00сс-0c00сссс00с0\",\n \"certificate\": {\n \"name\": \"КриптоПро 3.6 CSP для Ивана\",\n \"serialNumber\": \"0000СС000CСС00С00СС0С0СС0СС0С00С\",\n \"validTill\": \"2022-04-16T17:27:00+0300\",\n \"content\": \"TUlJQ2N6Q0NBaUtnQXdJQkFnSVFOMEdJZ3ZVNXBaSksxRTQ5NEFMcVBEQUlCZ1lxaFFNQ0FnTXdmekVqTUNFRwpDU3FHU0liM0RRRUpBUllVYzNWd2NHOXlkRUJqY25sd2RHOXdjbTh1Y25VeEN6QUpCZ05WQkFZVEFsSlZNUTh3CkRRWURWUVFIRXdaTmIzTmpiM2N4RnpBVkJnTlZCQW9URGtOU1dWQlVUeTFRVWs4Z1RFeERNU0V3SHdZRFZRUUQKRXhoRFVsbFFWRTh0VUZKUElGUmxjM1FnUTJWdWRHVnlJREl3SGhjTk1Ua3dOVEkzTURjeU5ESTJXaGNOTWpRdwpOVEkyTURjek5EQTFXakIvTVNNd0lRWUpLb1pJaHZjTkFRa0JGaFJ6ZFhCd2IzSjBRR055ZVhCMGIzQnlieTV5CmRURUxNQWtHQTFVRUJoTUNVbFV4RHpBTkJnTlZCQWNUQmsxdmMyTnZkekVYTUJVR0ExVUVDaE1PUTFKWlVGUlAKTFZCU1R5Qk1URU14SVRBZkJnTlZCQU1UR0VOU1dWQlVUeTFRVWs4Z1ZHVnpkQ0JEWlc1MFpYSWdNakJqTUJ3RwpCaXFGQXdJQ0V6QVNCZ2NxaFFNQ0FpTUJCZ2NxaFFNQ0FoNEJBME1BQkVBVW54WUVxS3QyVVR1ZllqdVJ4THk4CnlheGdMR2Q2dzBVRjd1YW95aTdWNjN2QzlJbUJNMUt6SzhmSzRHM0tCTllyczljUi9zUEQxSTI4R3h2emU4T1MKbzNnd2RqQUxCZ05WSFE4RUJBTUNBWVl3RHdZRFZSMFRBUUgvQkFVd0F3RUIvekFkQmdOVkhRNEVGZ1FVVG9NKwpGR252N0YxNmxTdGZFZjQzTWhaSlZTc3dFZ1lKS3dZQkJBR0NOeFVCQkFVQ0F3RUFBVEFqQmdrckJnRUVBWUkzCkZRSUVGZ1FVQkdKVktRc09zYzNSZVgyYXVNZ2ZhWjQyaC9Nd0NBWUdLb1VEQWdJREEwRUF4TVd5MWJFN2Y2RW8KS29QdWMzUHlhdEQyYUk0ZFh4RjFXbnQxRVU4RG54Ymw3ajRsV0NGU25EN3QvRTRHUS9IMVFWNHBHV2NDSkxzagozZVN1V0VwYVNBPT0=\"\n },\n \"signatureType\": \"FIRST\",\n \"orgId\": \"00c0cc00-c000-4e2e-b515-b8c3c53d0741\"\n },\n {\n \"id\": \"0с00с00с-000с-000с-00сс-0c00сссс00с1\",\n \"certificate\": {\n \"name\": \"КриптоПро 3.6 CSP для Ивана 2\",\n \"serialNumber\": \"0000СС000CСС00С00СС0С0СС0СС0С00B\",\n \"validTill\": \"2022-05-31T17:49:01+0300\",\n \"content\": \"TUlJQ2N6Q0NBaUtnQXdJQkFnSVFOMEdJZ3ZVNXBaSksxRTQ5NEFMcVBEQUlCZ1lxaFFNQ0FnTXdmekVqTUNFRwpDU3FHU0liM0RRRUpBUllVYzNWd2NHOXlkRUJqY25sd2RHOXdjbTh1Y25VeEN6QUpCZ05WQkFZVEFsSlZNUTh3CkRRWURWUVFIRXdaTmIzTmpiM2N4RnpBVkJnTlZCQW9URGtOU1dWQlVUeTFRVWs4Z1RFeERNU0V3SHdZRFZRUUQKRXhoRFVsbFFWRTh0VUZKUElGUmxjM1FnUTJWdWRHVnlJREl3SGhjTk1Ua3dOVEkzTURjeU5ESTJXaGNOTWpRdwpOVEkyTURjek5EQTFXakIvTVNNd0lRWUpLb1pJaHZjTkFRa0JGaFJ6ZFhCd2IzSjBRR055ZVhCMGIzQnlieTV5CmRURUxNQWtHQTFVRUJoTUNVbFV4RHpBTkJnTlZCQWNUQmsxdmMyTnZkekVYTUJVR0ExVUVDaE1PUTFKWlVGUlAKTFZCU1R5Qk1URU14SVRBZkJnTlZCQU1UR0VOU1dWQlVUeTFRVWs4Z1ZHVnpkQ0JEWlc1MFpYSWdNakJqTUJ3RwpCaXFGQXdJQ0V6QVNCZ2NxaFFNQ0FpTUJCZ2NxaFFNQ0FoNEJBME1BQkVBVW54WUVxS3QyVVR1ZllqdVJ4THk4CnlheGdMR2Q2dzBVRjd1YW95aTdWNjN2QzlJbUJNMUt6SzhmSzRHM0tCTllyczljUi9zUEQxSTI4R3h2emU4T1MKbzNnd2RqQUxCZ05WSFE4RUJBTUNBWVl3RHdZRFZSMFRBUUgvQkFVd0F3RUIvekFkQmdOVkhRNEVGZ1FVVG9NKwpGR252N0YxNmxTdGZFZjQzTWhaSlZTc3dFZ1lKS3dZQkJBR0NOeFVCQkFVQ0F3RUFBVEFqQmdrckJnRUVBWUkzCkZRSUVGZ1FVQkdKVktRc09zYzNSZVgyYXVNZ2ZhWjQyaC9Nd0NBWUdLb1VEQWdJREEwRUF4TVd5MWJFN2Y2RW8KS29QdWMzUHlhdEQyYUk0ZFh4RjFXbnQxRVU4RG54Ymw3ajRsV0NGU25EN3QvRTRHUS9IMVFWNHBHV2NDSkxzagozZVN1V0VwYVNBPT0=\"\n },\n \"signatureType\": \"SINGLE\",\n \"orgId\": \"00c0cc00-c000-4e2e-b515-b8c3c53d0000\"\n }\n ]\n}"
}
}
},
"400": {
"description": "Некорректный запрос"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"500": {
"description": "Ошибка на сервере"
}
}
}Схемы и примеры
{
"schemas": {
"BranchResponse": {
"required": [
"accounts",
"address",
"bic",
"city",
"correspondentAccount",
"country",
"countryCode",
"fullName",
"id",
"internationalAddress",
"internationalCity",
"internationalName",
"internationalPayName",
"nameFor52",
"payName",
"services",
"shortName",
"swift",
"timeZone"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Идентификатор филиала",
"example": 3002
},
"shortName": {
"type": "string",
"description": "Краткое наименование филиала",
"example": "АО \"РАЙФФАЙЗЕНБАНК"
},
"fullName": {
"type": "string",
"description": "Полное наименование филиала",
"example": "Филиал \"Московский\" Акционерного общества \"Райффайзенбанк\" в г. Москва"
},
"internationalName": {
"type": "string",
"description": "Международное наименование филиала",
"example": "Филиал \"Московский\" Акционерного общества \"Райффайзенбанк\" в г. Москва"
},
"nameFor52": {
"type": "string",
"description": "Наименование банка перевододателя для поля 52 валютного перевода",
"example": "AO RAIFFEISENBANK"
},
"bic": {
"type": "string",
"description": "БИК филиала",
"example": 44525700
},
"payName": {
"type": "string",
"example": "АО \"РАЙФФАЙЗЕНБАНК\""
},
"internationalPayName": {
"type": "string",
"example": "AO RAIFFEISENBANK"
},
"correspondentAccount": {
"type": "string",
"description": "Корреспондентский счёт",
"example": 30101810200000000000
},
"city": {
"type": "string",
"description": "Город филиала",
"example": "МОСКВА"
},
"internationalCity": {
"type": "string",
"description": "Междунардное наименование города филиала",
"example": "MOSCOW"
},
"swift": {
"type": "string",
"description": "Свифт код филиала",
"example": "RZBMRUMM"
},
"country": {
"type": "string",
"description": "ISO код страны филиала",
"example": "RU"
},
"countryCode": {
"type": "string",
"description": "Код страны филиала",
"example": 643
},
"address": {
"type": "string",
"description": "Адрес филиала",
"example": ""
},
"internationalAddress": {
"type": "string",
"description": "Международный адрес филиала",
"example": "BLDG.1 TROITSKAYA STR. 17"
},
"timeZone": {
"type": "string",
"description": "Временная зона филиала",
"example": 10800
},
"contractId": {
"type": "string",
"description": "Идентификатор контракта организации открытом в этом филиале (может быть пустым)",
"example": "<пустая строка>"
},
"services": {
"type": "array",
"description": "Доступные услуги",
"example": [
"mobile-bank",
"templates\"",
"deposit-request",
"accr-cur",
"accr-rub",
"sms-otp",
"statements",
"order",
"curtransfers",
"conversion",
"rpays",
"reissue-deal-contracts",
"dealpasscredit",
"deal-pass-close",
"confdoccerts",
"reissuedealcredit",
"dealpasscontracts",
"curr-control-info",
"currdealcerts",
"messages-income",
"messages-outcome",
"masspayments",
"certs-regen-req",
"certs-gen-req",
"certs-revocation",
"notifications",
"attach-request",
"salary-payroll",
"detach-request",
"guarantee"
],
"items": {
"type": "string",
"description": "Услуга"
}
},
"accounts": {
"type": "array",
"description": "Список счетов организации открытых в этом филиале",
"items": {
"type": "string",
"description": "счет организации открытый в этом филиале",
"example": [
"40702978600000000000",
"40702810000001000000"
]
}
}
},
"description": "Список филиалов в которых обслуживается организация"
},
"OrganizationResponse": {
"required": [
"address",
"branches",
"cnum",
"id",
"inn",
"internationalAddress",
"internationalName",
"juridicalAddress",
"kpp",
"kppOfBiggestTaxpayer",
"lawType",
"name",
"ogrn",
"shortName"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID в системе Банка",
"example": "91852905-2668-4587-90f9-6dbc025e77c0"
},
"cnum": {
"type": "string",
"description": "Клиентский номер",
"example": "AAA1AR"
},
"name": {
"type": "string",
"description": "Полное наименование организации",
"example": "Общество с ограниченной ответственностью тестовая-компания"
},
"shortName": {
"type": "string",
"description": "Сокращённое наименование организации",
"example": "ООО тестовая-компания"
},
"internationalName": {
"type": "string",
"description": "Международное наименование",
"example": "Test-Company LLC"
},
"inn": {
"type": "string",
"description": "ИНН",
"example": 7997777718
},
"address": {
"type": "string",
"description": "Фактический адрес",
"example": "000001, московская обл, г москва, ул Гушкина, д. 0, кв.(оф.) 00"
},
"juridicalAddress": {
"type": "string",
"description": "Юридический адрес",
"example": "000001, московская обл, г москва, ул Гушкина, д. 0, кв.(оф.) 00"
},
"internationalAddress": {
"type": "string",
"description": "Международный адрес",
"example": "GUSHKINA UL. D.0 KV.00 000001 MOSCOW RUSSIA"
},
"kpp": {
"type": "string",
"description": "КПП (по умолчанию)",
"example": 1000
},
"kppOfBiggestTaxpayer": {
"type": "string",
"description": "КПП (Крупн. налогоплат.)",
"example": 200000000
},
"lawType": {
"type": "string",
"description": "Организационно-правовая форма (краткая)",
"example": "ООО"
},
"ogrn": {
"type": "string",
"description": "ОГРН",
"example": 1000006000000
},
"branches": {
"type": "array",
"description": "Список филиалов в которых обслуживается организация",
"items": {
"$ref": "#/components/schemas/BranchResponse"
}
}
}
},
"Actions": {
"required": [
"create",
"createByTemplate",
"export",
"import",
"scrollerToExcel"
],
"type": "object",
"description": "Доступные действия",
"properties": {
"createByTemplate": {
"type": "boolean",
"description": "Создать по шаблону"
},
"create": {
"type": "boolean",
"description": "Создание"
},
"scrollerToExcel": {
"type": "boolean",
"description": "Доступ к разделу"
},
"export": {
"type": "boolean",
"description": "Экспорт"
},
"import": {
"type": "boolean",
"description": "Импорт"
}
}
},
"ServiceActions": {
"required": [
"actions",
"id"
],
"type": "object",
"description": "доступ к услугам",
"properties": {
"id": {
"type": "string",
"example": [
"rpays",
"masspayments"
]
},
"actions": {
"$ref": "#/components/schemas/Actions"
}
}
},
"UserResponse": {
"required": [
"services"
],
"type": "object",
"properties": {
"fullName": {
"type": "string",
"description": "ФИО пользователя",
"example": "Иванов Иван Иванович"
},
"userId": {
"type": "string",
"description": "Id пользователя",
"example": "0c0ccccc-cc0c-000e-a000-0000000000ce"
},
"login": {
"type": "string",
"description": "Логин пользователя",
"example": "test_account"
},
"services": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceActions"
}
}
}
},
"Certificate": {
"required": [
"name",
"serialNumber",
"validTill",
"content"
],
"type": "object",
"description": "Сертификат пользователя",
"properties": {
"name": {
"type": "string",
"description": "Имя сертификата",
"example": "КриптоПро 3.6 CSP для Ивана"
},
"serialNumber": {
"type": "string",
"description": "Серийный номер сертификата",
"example": "0000СС000CСС00С00СС0С0СС0СС0С00С"
},
"validTill": {
"type": "string",
"description": "Время жизни сертификата",
"example": "2022-04-16T17:27:00+0300"
},
"content": {
"type": "string",
"description": "Контент сертификата криптопрофиля (тело сертификата закодировано в base64)",
"example": "TUlJQ2N6Q0NBaUtnQXdJQkFnSVFOMEdJZ3ZVNXBaSksxRTQ5NEFMcVBEQUlCZ1lxaFFNQ0FnTXdmek....."
}
}
},
"CryptoProfile": {
"required": [
"certificate",
"id",
"orgId",
"signatureType"
],
"type": "object",
"description": "Полномочия и средства подписи пользователя",
"properties": {
"id": {
"type": "string",
"description": "Уникальный идентификатор сертификата",
"example": "0с00с00с-000с-000с-00сс-0c00сссс00с0"
},
"certificate": {
"$ref": "#/components/schemas/Certificate"
},
"signatureType": {
"type": "string",
"description": "Тип подписи (единственная, первая или вторая)",
"enum": [
"SINGLE",
"FIRST",
"SECOND"
]
},
"orgId": {
"type": "string",
"description": "Уникальный идентификатор организации",
"example": "00c0cc00-c000-4e2e-b515-b8c3c53d0741"
}
}
},
"SignaturesResponse": {
"required": [
"cryptoProfiles"
],
"type": "object",
"description": "Список полномочий и средств подписи пользователя в разрезе организаций",
"properties": {
"cryptoProfiles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CryptoProfile"
}
}
}
}
},
"responses": {
"Unauthorized": {
"description": "Авторизация не пройдена",
"content": {
"application/json": {
"schema": {
"required": [
"http_status_code",
"message"
],
"type": "object",
"properties": {
"http_status_code": {
"description": "HTTP статус",
"type": "integer",
"format": "int32"
},
"message": {
"description": "Ошибка",
"type": "string"
}
}
}
}
}
},
"BadRequest": {
"description": "Некорректный запрос",
"content": {
"application/json": {
"schema": {
"required": [
"status",
"eror"
],
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "HTTP статус",
"format": "int32"
},
"error": {
"type": "string",
"description": "Ошибка"
},
"message": {
"type": "string",
"description": "Детали ошибки"
}
}
}
}
}
},
"NotFound": {
"description": "Запрашиваемый ресурс не найден",
"content": {
"application/json": {
"schema": {
"required": [
"status",
"eror"
],
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "HTTP статус",
"format": "int32"
},
"error": {
"type": "string",
"description": "Ошибка"
},
"message": {
"type": "string",
"description": "Детали ошибки"
}
}
}
}
}
}
},
"parameters": {
"IdTokenHeader": {
"name": "Id-Token",
"description": "Идентификационный токен пользователя",
"in": "header",
"required": true,
"schema": {
"type": "string"
}
}
},
"securitySchemes": {
"bearerAuth": {
"type": "http",
"scheme": "bearer",
"description": "Токен доступа",
"bearerFormat": "JWT"
}
}
}