Счета и балансы
OpenAPI 1.0
API для получения данных по счетам и их балансам
Варианты
- Черновик
Операции API
POST /v1/accounts/query — Возвращает пользователю счета c учетом фильтров
Если "onlyBalances":true, то на выходе - только данные по балансам, движениям и остаткам. Если "onlyBalances":false, то на выходе - полный ответ. По умолчанию "onlyBalances" установлены в false. Возвращает список доступных пользователю счетов во всех его организациях, включая "Единый налоговый счет" Если "checkArrests":true, то дополнительно проверяются аресты по счетам. Если "checkIncasso":true, то дополнительно проверяется инкассо по счетам. Если "showCorpCards":true, то в ответе отображаются счета корпоративных карт. Если "showPools":true, то в проверяются пулы для счетов и отображаются при их наличии. По умолчанию "checkArrests", "checkIncasso", "showPools" и "showCorpCards" установлены в false, что ускоряет выполнение метода. Детальную информацию по конкретному счету можно получить из GET /v1/accounts/{accountNumber}.
{
"description": "Если \"onlyBalances\":true, то на выходе - только данные по балансам, движениям и остаткам.\nЕсли \"onlyBalances\":false, то на выходе - полный ответ.\nПо умолчанию \"onlyBalances\" установлены в false.\nВозвращает список доступных пользователю счетов во всех его организациях, включая \"Единый налоговый счет\"\nЕсли \"checkArrests\":true, то дополнительно проверяются аресты по счетам.\nЕсли \"checkIncasso\":true, то дополнительно проверяется инкассо по счетам.\nЕсли \"showCorpCards\":true, то в ответе отображаются счета корпоративных карт.\nЕсли \"showPools\":true, то в проверяются пулы для счетов и отображаются при их наличии.\nПо умолчанию \"checkArrests\", \"checkIncasso\", \"showPools\" и \"showCorpCards\" установлены в false, что ускоряет выполнение метода.\nДетальную информацию по конкретному счету можно получить из GET /v1/accounts/{accountNumber}.\n",
"operationId": "queryAccountsV1",
"parameters": [
{
"$ref": "#/components/parameters/X-Cnum"
},
{
"$ref": "#/components/parameters/AuthorizationHeader"
},
{
"$ref": "#/components/parameters/IdTokenHeader"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountsQueryV1Request"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountsQueryV1Response"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorV1Response"
}
}
},
"description": "Bad Request"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"description": "Forbidden"
},
"500": {
"$ref": "#/components/responses/InternalError"
}
},
"security": [
{
"OpenId_Access_Token": [],
"OpenId_Id-Token": []
},
{
"RaifApiAuthorization": [],
"RaifApiIdToken": []
}
],
"servers": [
{
"url": "https://api.raiffeisen.ru/host/client-details"
}
],
"summary": "Возвращает пользователю счета c учетом фильтров",
"tags": [
"accounts-v1"
]
}GET /v1/accounts/{accountNumber} — Возвращает данные счета по номеру
Возвращает данные счета по номеру (реквизиты, балансы, движения)
{
"description": "Возвращает данные счета по номеру (реквизиты, балансы, движения)\n",
"operationId": "getAccountByNumberV1",
"parameters": [
{
"$ref": "#/components/parameters/AccountNumber"
},
{
"$ref": "#/components/parameters/X-Cnum"
},
{
"$ref": "#/components/parameters/AuthorizationHeader"
},
{
"$ref": "#/components/parameters/IdTokenHeader"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountDataFullResponse"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorV1Response"
}
}
},
"description": "Bad Request"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"description": "Forbidden"
},
"500": {
"$ref": "#/components/responses/InternalError"
}
},
"security": [
{
"OpenId_Access_Token": [],
"OpenId_Id-Token": []
},
{
"RaifApiAuthorization": [],
"RaifApiIdToken": []
}
],
"servers": [
{
"url": "https://api.raiffeisen.ru/host/client-details"
}
],
"summary": "Возвращает данные счета по номеру",
"tags": [
"accounts-v1"
]
}Схемы и примеры
{
"parameters": {
"AccountNumber": {
"description": "Номер счета",
"in": "path",
"name": "accountNumber",
"required": true,
"schema": {
"example": "40702810400000146666",
"type": "string"
}
},
"AuthorizationHeader": {
"description": "Токен доступа",
"in": "header",
"name": "Authorization",
"required": true,
"schema": {
"example": "Bearer QXV0aG9yaXphdGlvbiBIZWFkZXIgRm9yIFRlc3Rpbmc=",
"format": "byte",
"type": "string"
}
},
"IdTokenHeader": {
"description": "Идентификационный токен пользователя",
"in": "header",
"name": "Id-Token",
"required": true,
"schema": {
"example": "SUQgVE9LRU4gRk9SIFRFU1RJTkc=",
"format": "byte",
"type": "string"
}
},
"X-Cnum": {
"description": "Клиентский номер организации (необязательный заголовок)",
"in": "header",
"name": "X-Cnum",
"required": false,
"schema": {
"example": "400002",
"type": "string"
}
}
},
"responses": {
"InternalError": {
"description": "Внутренняя ошибка"
},
"Unauthorized": {
"description": "Аутентификация не пройдена"
}
},
"schemas": {
"AccountBalance": {
"description": "Текущий баланс счета",
"example": 111.11,
"type": "number"
},
"AccountBalanceDate": {
"description": "Дата и время получения баланса",
"example": "2024-02-28T11:03:01+03:00",
"format": "date-time",
"type": "string"
},
"AccountCloseDate": {
"description": "Время закрытия счета",
"example": "2024-02-28T00:00:00+03:00",
"format": "date-time",
"type": "string"
},
"AccountCurrencyCode": {
"description": "Код валюты счета в цифровом и буквенном формате",
"example": {
"digital": "810",
"letter": "RUR"
},
"properties": {
"digital": {
"$ref": "#/components/schemas/AccountCurrencyCodeDigital",
"description": "Цифровой код валюты счета"
},
"letter": {
"$ref": "#/components/schemas/AccountCurrencyCodeLetter",
"description": "Буквенный код валюты счета"
}
},
"required": [
"digital",
"letter"
],
"type": "object"
},
"AccountCurrencyCodeDigital": {
"description": "Цифровой код валюты счета",
"example": "810",
"type": "string"
},
"AccountCurrencyCodeLetter": {
"description": "Буквенный код валюты счета",
"example": "RUR",
"type": "string"
},
"AccountDataCommon": {
"description": "Общая информация о счете",
"properties": {
"closeDate": {
"$ref": "#/components/schemas/AccountCloseDate",
"description": "Время закрытия счета"
},
"currency": {
"$ref": "#/components/schemas/AccountCurrencyCode",
"description": "Код валюты счета"
},
"id": {
"$ref": "#/components/schemas/AccountId",
"description": "Внутренний идентификатор счета"
},
"number": {
"$ref": "#/components/schemas/AccountNumber",
"description": "Номер счета"
},
"openDate": {
"$ref": "#/components/schemas/AccountOpenDate",
"description": "Время открытия счета"
},
"replenishmentEnabled": {
"description": "Признак возможности пополнения счета",
"example": true,
"type": "boolean"
},
"sequenceNumber": {
"$ref": "#/components/schemas/AccountSequenceNumber",
"description": "Последовательность счета"
},
"statementKey": {
"$ref": "#/components/schemas/StatementAccountKey",
"description": "Ключ для запроса выписок"
},
"status": {
"$ref": "#/components/schemas/AccountStatus",
"description": "Статус счета"
},
"type": {
"$ref": "#/components/schemas/AccountType",
"description": "Тип счета"
}
},
"required": [
"id",
"number",
"type",
"currency",
"status",
"sequenceNumber",
"openDate",
"statementKey",
"replenishmentEnabled"
],
"type": "object"
},
"AccountDataFullResponse": {
"allOf": [
{
"$ref": "#/components/schemas/AccountDataCommon"
},
{
"description": "Полная информация о счете",
"properties": {
"branch": {
"$ref": "#/components/schemas/BranchData",
"description": "Информация о подразделении банка, в котором открыт счет"
},
"corpCards": {
"description": "Список корпоративных карт, выпущенных к счету",
"items": {
"$ref": "#/components/schemas/CorporateCard"
},
"type": "array"
},
"movements": {
"$ref": "#/components/schemas/AccountMovements",
"description": "Информация о движениях по счету"
},
"organization": {
"$ref": "#/components/schemas/OrganizationDataFull",
"description": "Информация об организации"
},
"poolBalance": {
"description": "Баланс пула по счёту (в режиме POOLS)",
"example": 222.22,
"type": "number"
},
"prevMovements": {
"$ref": "#/components/schemas/AccountMovements",
"description": "Информация о предыдущих движениях по счету"
}
},
"required": [
"movements"
],
"type": "object"
}
]
},
"AccountDataV1": {
"description": "Информация о счете (версия 1)",
"properties": {
"currency": {
"$ref": "#/components/schemas/AccountCurrencyCode",
"description": "Код валюты счета"
},
"id": {
"$ref": "#/components/schemas/AccountId",
"description": "Внутренний идентификатор счета"
},
"inPool": {
"$ref": "#/components/schemas/AccountInPool",
"description": "Признак участия счета в пуле"
},
"movements": {
"$ref": "#/components/schemas/AccountMovements",
"description": "Информация о движениях по счету"
},
"number": {
"$ref": "#/components/schemas/AccountNumber",
"description": "Номер счета"
},
"poolNumber": {
"$ref": "#/components/schemas/AccountPoolNumber",
"description": "Номер пула, в котором состоит счёт"
},
"prevMovements": {
"$ref": "#/components/schemas/AccountMovements",
"description": "Информация о предыдущих движениях по счету"
},
"replenishmentAmount": {
"$ref": "#/components/schemas/ENSReplenishmentAmount",
"description": "Сумма задолженности для счета ENS"
},
"status": {
"$ref": "#/components/schemas/AccountStatus",
"description": "Статус счета"
},
"type": {
"$ref": "#/components/schemas/AccountType",
"description": "Тип счета"
}
},
"required": [
"id"
],
"type": "object"
},
"AccountId": {
"description": "Внутренний идентификатор счета",
"example": "da2fdc9e-6456-42ab-bb6b-ef618a7d9a76",
"type": "string"
},
"AccountInPool": {
"description": "Признак, что счёт участвует в пуле (доступен только в /v1/account-widget/accounts/query)",
"example": true,
"type": "boolean"
},
"AccountMovements": {
"description": "Информация о движениях по счету",
"example": {
"balance": 111.11,
"balanceDate": "2024-02-28T11:03:01+03:00",
"creditSum": 111.11,
"debetSum": 111.11,
"rest": 111.11
},
"properties": {
"balance": {
"$ref": "#/components/schemas/AccountBalance",
"description": "Текущий баланс счета"
},
"balanceDate": {
"$ref": "#/components/schemas/AccountBalanceDate",
"description": "Дата и время получения баланса"
},
"creditSum": {
"$ref": "#/components/schemas/CreditSum",
"description": "Сумма оборотов по кредиту"
},
"debetSum": {
"$ref": "#/components/schemas/DebetSum",
"description": "Сумма оборотов по дебету"
},
"rest": {
"$ref": "#/components/schemas/AccountRest",
"description": "Исходящий остаток по последней итоговой выписке"
}
},
"type": "object"
},
"AccountNumber": {
"description": "Номер счета",
"example": "40702810400000146666",
"type": "string"
},
"AccountOpenDate": {
"description": "Время открытия счета",
"example": "2024-02-28T00:00:00+03:00",
"format": "date-time",
"type": "string"
},
"AccountPoolNumber": {
"description": "Номер пула, в котором состоит счёт (доступен только в /v1/account-widget/accounts/query)",
"example": 6788,
"type": "integer"
},
"AccountRest": {
"description": "Исходящий остаток по последней итоговой выписке",
"example": 111.11,
"type": "number"
},
"AccountSequenceNumber": {
"description": "Последовательность счета",
"example": "01",
"type": "string"
},
"AccountStatus": {
"description": "Статус счета",
"example": {
"code": "HAS_ARREST",
"en": "Has arrest",
"ru": "Есть арест"
},
"properties": {
"code": {
"$ref": "#/components/schemas/AccountStatusCode",
"description": "Код статуса счета"
},
"en": {
"$ref": "#/components/schemas/AccountStatusNameEN",
"description": "Наименование статуса счета на английском языке"
},
"ru": {
"$ref": "#/components/schemas/AccountStatusNameRU",
"description": "Наименование статуса счета на русском языке"
}
},
"required": [
"code"
],
"type": "object"
},
"AccountStatusCode": {
"description": "Код статуса счета (для счета ENS - OPENED, NEEDS_REPLENISHMENT, HAS_DEBT, для счета DIGITAL_RUBLE - OPENED, REGISTRATION_PROGRESS, CLOSING, BLOCKING, BLOCKED, UNBLOCKING, для закрывающегося счёта - CLOSING_IN_PROCESS, CLOSING_SUCCESS, CLOSING_ERROR, CLOSING_TECH_ERROR, CLOSING_NONE)",
"enum": [
"OPENED",
"BLOCKED",
"CLOSED",
"HAS_ARREST",
"HAS_INCASSO",
"HAS_RESTRICTIONS",
"NEEDS_REPLENISHMENT",
"HAS_DEBT",
"REGISTRATION_PROGRESS",
"CLOSING",
"BLOCKING",
"UNBLOCKING",
"CLOSING_IN_PROCESS",
"CLOSING_SUCCESS",
"CLOSING_ERROR",
"CLOSING_TECH_ERROR",
"CLOSING_NONE"
],
"example": "OPENED",
"type": "string"
},
"AccountStatusNameEN": {
"description": "Англоязычное наименование статуса счета",
"example": "Opened",
"type": "string"
},
"AccountStatusNameRU": {
"description": "Русскоязычное наименование статуса счета",
"example": "Открыт",
"type": "string"
},
"AccountType": {
"description": "Тип счета",
"example": {
"code": "TRANSIT",
"en": "Transit account",
"ru": "Транзитный счет"
},
"properties": {
"code": {
"$ref": "#/components/schemas/AccountTypeCode",
"description": "Код типа счета"
},
"en": {
"$ref": "#/components/schemas/AccountTypeNameEN",
"description": "Наименование типа счета на английском языке"
},
"ru": {
"$ref": "#/components/schemas/AccountTypeNameRU",
"description": "Наименование типа счета на русском языке"
}
},
"required": [
"code"
],
"type": "object"
},
"AccountTypeCode": {
"description": "Код типа счета",
"enum": [
"BROKERAGE",
"TAX_PIGGY_BANK",
"CHECKING",
"OVERDRAFT",
"TRANSIT",
"DEPOSIT",
"OTHER",
"ENS",
"DIGITAL_RUBLE",
"PROCUREMENT_PARTICIPANT",
"TRUST_MANAGEMENT",
"TYPE_C",
"TRUST_MANAGEMENT_TYPE_C",
"INSURANCE_RESERVE",
"DEPOSITORY",
"COLLATERAL",
"CORRESPONDENT",
"BANK_PAYMENT_AGENT",
"CORPORATE_DEBIT_CARDS",
"CORPORATE_CREDIT_CARDS",
"CUSTOMS_CARDS",
"ESCROW",
"DEBTOR",
"DEVELOPER",
"INVESTMENT_PARTNERSHIP",
"MORTGAGE_COVERAGE",
"PENSION_RESERVE",
"PAYMENT_AGENT",
"SUPPLIER",
"INSURANCE_BROKER",
"ISSUER"
],
"example": "TRANSIT",
"type": "string"
},
"AccountTypeNameEN": {
"description": "Англоязычное наименование счета",
"example": "Transit account",
"type": "string"
},
"AccountTypeNameRU": {
"description": "Русскоязычное наименование счета",
"example": "Транзитный счет",
"type": "string"
},
"AccountsQueryV1Request": {
"description": "Запрос на поиск счетов (выбранные организации определяются из JWT токена)",
"properties": {
"checkArrests": {
"default": false,
"description": "Проверять аресты по счетам. По умолчанию false, что ускоряет выполнение метода",
"example": false,
"type": "boolean"
},
"checkIncasso": {
"default": false,
"description": "Проверять инкассо по счетам. По умолчанию false, что ускоряет выполнение метода",
"example": false,
"type": "boolean"
},
"onlyBalances": {
"default": false,
"description": "Если true, то возвращаются только данные по балансам и движениям, false - полный ответ",
"example": false,
"type": "boolean"
},
"showCorpCards": {
"default": false,
"description": "Отображать счета корпоративных карт. По умолчанию false, что ускоряет выполнение метода (не у всех клиентов есть такие счета)",
"example": false,
"type": "boolean"
},
"showPools": {
"default": false,
"description": "Показывать пулы или нет",
"example": false,
"type": "boolean"
}
},
"type": "object"
},
"AccountsQueryV1Response": {
"description": "Список организаций со счетами",
"example": [
{
"accounts": [
{
"currency": {
"digital": "810",
"letter": "RUR"
},
"id": "da2fdc9e-6456-42ab-bb6b-ef618a7d9a76",
"movements": {
"balance": 111.11,
"balanceDate": "2024-02-28T11:03:01+03:00",
"creditSum": 111.11,
"debetSum": 111.11,
"rest": 111.11
},
"number": "40702810400000146666",
"replenishmentAmount": 111.11,
"status": {
"code": "HAS_ARREST",
"en": "Has arrest",
"ru": "Есть арест"
},
"type": {
"code": "TRANSIT",
"en": "Transit account",
"ru": "Транзитный счет"
}
}
],
"cnum": "1234",
"hasPool": false,
"id": "da2fdc9e-6456-42ab-bb6b-ef618a7d9a76",
"inn": "7784685950",
"name": {
"en": "Raiffeisenbank AO",
"ru": "Райффайзенбанк AO"
}
}
],
"items": {
"$ref": "#/components/schemas/OrganizationDataV1"
},
"type": "array"
},
"BranchAddress": {
"description": "Адрес подразделения банка на русском и английском языках",
"example": {
"en": "Russian Federation, 119002, Moscow, Smolenskaya-Sennaya sq., 28",
"ru": "119002, г. Москва, Смоленская-Сенная пл., д. 28"
},
"properties": {
"en": {
"$ref": "#/components/schemas/BranchAddressEN",
"description": "Адрес подразделения банка на английском языке"
},
"ru": {
"$ref": "#/components/schemas/BranchAddressRU",
"description": "Адрес подразделения банка на русском языке"
}
},
"required": [
"ru"
],
"type": "object"
},
"BranchAddressEN": {
"description": "Англоязычный адрес подразделения банка",
"example": "Russian Federation, 119002, Moscow, Smolenskaya-Sennaya sq., 28",
"type": "string"
},
"BranchAddressRU": {
"description": "Русскоязычный адрес подразделения банка",
"example": "119002, г. Москва, Смоленская-Сенная пл., д. 28",
"type": "string"
},
"BranchBIC": {
"description": "БИК подразделения банка",
"example": "044525700",
"type": "string"
},
"BranchCode": {
"description": "Код подразделения банка",
"example": "100",
"type": "string"
},
"BranchCorrAccount": {
"description": "Корреспондентский счет подразделения банка",
"example": "30101810200000000700",
"type": "string"
},
"BranchData": {
"description": "Информация о подразделении банка, в котором открыт счет",
"example": {
"BIC": "044525700",
"address": {
"en": "Russian Federation, 119002, Moscow, Smolenskaya-Sennaya sq., 28",
"ru": "119002, г. Москва, Смоленская-Сенная пл., д. 28"
},
"code": "100",
"corrAccount": "30101810200000000700",
"headOfficeAddress": "Russian Federation, 119002, Moscow, Smolenskaya-Sennaya sq., 28",
"headOfficeSWIFT": "RZBMRUMMXXX",
"id": "da2fdc9e-6456-42ab-bb6b-ef618a7d9a76",
"name": {
"en": "AO RAIFFEISENBANK",
"ru": "АО Райффайзенбанк"
}
},
"properties": {
"BIC": {
"$ref": "#/components/schemas/BranchBIC",
"description": "БИК подразделения банка"
},
"address": {
"$ref": "#/components/schemas/BranchAddress",
"description": "Адрес подразделения банка"
},
"code": {
"$ref": "#/components/schemas/BranchCode",
"description": "Код подразделения банка"
},
"corrAccount": {
"$ref": "#/components/schemas/BranchCorrAccount",
"description": "Корреспондентский счет подразделения банка"
},
"headOfficeAddress": {
"$ref": "#/components/schemas/BranchHeadOfficeAddress",
"description": "Адрес головного офиса банка"
},
"headOfficeSWIFT": {
"$ref": "#/components/schemas/BranchHeadOfficeSWIFT",
"description": "SWIFT головного офиса банка"
},
"id": {
"$ref": "#/components/schemas/BranchId",
"description": "Идентификатор подразделения банка"
},
"name": {
"$ref": "#/components/schemas/BranchName",
"description": "Наименование подразделения банка"
}
},
"required": [
"id",
"code",
"BIC",
"corrAccount",
"name",
"address"
],
"type": "object"
},
"BranchHeadOfficeAddress": {
"description": "Адрес головного офиса банка",
"example": "Russian Federation, 119002, Moscow, Smolenskaya-Sennaya sq., 28",
"type": "string"
},
"BranchHeadOfficeSWIFT": {
"description": "SWIFT головного офиса банка",
"example": "RZBMRUMMXXX",
"type": "string"
},
"BranchId": {
"description": "Идентификатор подразделения банка",
"example": "da2fdc9e-6456-42ab-bb6b-ef618a7d9a76",
"type": "string"
},
"BranchName": {
"description": "Наименование подразделения банка на русском и английском языках",
"example": {
"en": "AO RAIFFEISENBANK",
"ru": "АО Райффайзенбанк"
},
"properties": {
"en": {
"$ref": "#/components/schemas/BranchNameEN",
"description": "Наименование подразделения банка на английском языке"
},
"ru": {
"$ref": "#/components/schemas/BranchNameRU",
"description": "Наименование подразделения банка на русском языке"
}
},
"required": [
"ru"
],
"type": "object"
},
"BranchNameEN": {
"description": "Англоязычное наименование подразделения банка",
"example": "AO RAIFFEISENBANK",
"type": "string"
},
"BranchNameRU": {
"description": "Русскоязычное наименование подразделения банка",
"example": "АО Райффайзенбанк",
"type": "string"
},
"CardOwner": {
"description": "Держатель корпоративной карты",
"example": {
"embossedName": "IVAN IVANOV",
"name": "Иванов Иван Иванович"
},
"properties": {
"embossedName": {
"description": "Имя держателя карты, нанесенное на карту",
"example": "IVAN IVANOV",
"type": "string"
},
"name": {
"description": "ФИО держателя карты",
"example": "Иванов Иван Иванович",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"CardStatus": {
"description": "Статус корпоративной карты",
"example": {
"code": "BLOCKED",
"en": "Blocked",
"ru": "Заблокирована"
},
"properties": {
"code": {
"description": "Код статуса карты",
"enum": [
"ACTIVE",
"BLOCKED",
"CLOSED"
],
"example": "BLOCKED",
"type": "string"
},
"en": {
"description": "Наименование статуса карты на английском языке",
"example": "Blocked",
"type": "string"
},
"ru": {
"description": "Наименование статуса карты на русском языке",
"example": "Заблокирована",
"type": "string"
}
},
"required": [
"code"
],
"type": "object"
},
"CorporateCard": {
"description": "Корпоративная карта, выпущенная к счету",
"example": {
"maskedNumber": "220000******1111",
"mediaType": "PLASTIC",
"owner": {
"embossedName": "IVAN IVANOV",
"name": "Иванов Иван Иванович"
},
"paymentSystem": "MIR",
"product": "Корпоративная карта",
"status": {
"code": "BLOCKED",
"en": "Blocked",
"ru": "Заблокирована"
},
"type": "DEBIT"
},
"properties": {
"maskedNumber": {
"description": "Маскированный номер карты",
"example": "220000******1111",
"type": "string"
},
"mediaType": {
"description": "Формат выпуска карты",
"enum": [
"VIRTUAL",
"PLASTIC"
],
"example": "PLASTIC",
"type": "string"
},
"owner": {
"$ref": "#/components/schemas/CardOwner",
"description": "Держатель карты"
},
"paymentSystem": {
"description": "Платежная система карты",
"enum": [
"MIR",
"VISA",
"MASTERCARD"
],
"example": "MIR",
"type": "string"
},
"product": {
"description": "Продукт, под который выпущена карта",
"example": "Корпоративная карта",
"type": "string"
},
"status": {
"$ref": "#/components/schemas/CardStatus",
"description": "Статус карты"
},
"type": {
"description": "Тип карты",
"enum": [
"DEBIT",
"CREDIT"
],
"example": "DEBIT",
"type": "string"
}
},
"required": [
"maskedNumber",
"status",
"type",
"mediaType",
"paymentSystem",
"product",
"owner"
],
"type": "object"
},
"CreditSum": {
"description": "Сумма оборотов по кредиту",
"example": 111.11,
"type": "number"
},
"DebetSum": {
"description": "Сумма оборотов по дебету",
"example": 111.11,
"type": "number"
},
"ENSReplenishmentAmount": {
"description": "Сумма задолженности для счета ENS",
"example": 111.11,
"type": "number"
},
"ErrorV1Response": {
"description": "Ответ с ошибкой",
"properties": {
"error": {
"description": "Информация об ошибке",
"example": {
"code": "JSON_SCHEME_ERROR",
"errorId": "80f198ee56343ba8",
"errors": [
"Текст одной из ошибок валидации"
],
"message": "Ошибки валидации запроса"
},
"properties": {
"code": {
"description": "Код ошибки",
"example": "JSON_SCHEME_ERROR",
"type": "string"
},
"errorId": {
"description": "Идентификатор ошибки",
"example": "80f198ee56343ba8",
"type": "string"
},
"errors": {
"description": "Список деталей ошибки",
"example": [
"Текст одной из ошибок валидации"
],
"items": {
"description": "Деталь ошибки",
"example": "Текст одной из ошибок валидации",
"type": "string"
},
"type": "array"
},
"message": {
"description": "Сообщение об ошибке",
"example": "Ошибки валидации запроса",
"type": "string"
}
},
"required": [
"code",
"message",
"errorId"
],
"type": "object"
}
},
"required": [
"error"
],
"type": "object"
},
"OrgCnum": {
"description": "Клиентский номер организации",
"example": "1234",
"type": "string"
},
"OrgHasPool": {
"description": "Признак, что в организации есть хотя бы один счёт, участвующий в пуле (доступен только в /v1/account-widget/accounts/query)",
"example": true,
"type": "boolean"
},
"OrgINN": {
"description": "ИНН организации",
"example": "7784685950",
"type": "string"
},
"OrgId": {
"description": "Идентификатор организации",
"example": "da2fdc9e-6456-42ab-bb6b-ef618a7d9a76",
"type": "string"
},
"OrgName": {
"description": "Наименование организации на русском и английском языках",
"example": {
"en": "Raiffeisenbank AO",
"ru": "Райффайзенбанк AO"
},
"properties": {
"en": {
"$ref": "#/components/schemas/OrgNameEN",
"description": "Наименование организации на английском языке"
},
"ru": {
"$ref": "#/components/schemas/OrgNameRU",
"description": "Наименование организации на русском языке"
}
},
"required": [
"ru"
],
"type": "object"
},
"OrgNameEN": {
"description": "Англоязычное наименование организации",
"example": "Raiffeisenbank AO",
"type": "string"
},
"OrgNameRU": {
"description": "Русскоязычное наименование организации",
"example": "Райффайзенбанк AO",
"type": "string"
},
"OrganizationDataFull": {
"description": "Полная информация об организации",
"example": {
"address": {
"en": "ANDROPOVA PR-KT, 18-1 115432, MOSCOW, RF",
"ru": "115432, ВН.ТЕР.Г. МУНИЦИПАЛЬНЫЙ ОКРУГ ДАНИЛОВСКИЙ, Москва г, Андропова пр-кт, 18, 1"
},
"cnum": "1234",
"id": "da2fdc9e-6456-42ab-bb6b-ef618a7d9a76",
"inn": "7784685950",
"name": {
"en": "Raiffeisenbank AO",
"ru": "Райффайзенбанк AO"
}
},
"properties": {
"address": {
"description": "Адрес организации",
"properties": {
"en": {
"description": "Адрес организации на английском языке",
"example": "ANDROPOVA PR-KT, 18-1 115432, MOSCOW, RF",
"type": "string"
},
"ru": {
"description": "Адрес организации на русском языке",
"example": "115432, ВН.ТЕР.Г. МУНИЦИПАЛЬНЫЙ ОКРУГ ДАНИЛОВСКИЙ, Москва г, Андропова пр-кт, 18, 1",
"type": "string"
}
},
"required": [
"ru"
],
"type": "object"
},
"cnum": {
"$ref": "#/components/schemas/OrgCnum",
"description": "Клиентский номер организации"
},
"id": {
"$ref": "#/components/schemas/OrgId",
"description": "Идентификатор организации"
},
"inn": {
"$ref": "#/components/schemas/OrgINN",
"description": "ИНН организации"
},
"name": {
"$ref": "#/components/schemas/OrgName",
"description": "Наименование организации"
}
},
"required": [
"id",
"cnum",
"inn",
"name",
"address"
],
"type": "object"
},
"OrganizationDataV1": {
"description": "Информация об организации (версия 1)",
"example": {
"accounts": [
{
"currency": {
"digital": "810",
"letter": "RUR"
},
"id": "da2fdc9e-6456-42ab-bb6b-ef618a7d9a76",
"movements": {
"balance": 111.11,
"balanceDate": "2024-02-28T11:03:01+03:00",
"creditSum": 111.11,
"debetSum": 111.11,
"rest": 111.11
},
"number": "40702810400000146666",
"replenishmentAmount": 111.11,
"status": {
"code": "HAS_ARREST",
"en": "Has arrest",
"ru": "Есть арест"
},
"type": {
"code": "TRANSIT",
"en": "Transit account",
"ru": "Транзитный счет"
}
}
],
"cnum": "1234",
"hasPool": false,
"id": "da2fdc9e-6456-42ab-bb6b-ef618a7d9a76",
"inn": "7784685950",
"name": {
"en": "Raiffeisenbank AO",
"ru": "Райффайзенбанк AO"
}
},
"properties": {
"accounts": {
"description": "Список счетов организации",
"example": [
{
"currency": {
"digital": "810",
"letter": "RUR"
},
"id": "da2fdc9e-6456-42ab-bb6b-ef618a7d9a76",
"movements": {
"balance": 111.11,
"balanceDate": "2024-02-28T11:03:01+03:00",
"creditSum": 111.11,
"debetSum": 111.11,
"rest": 111.11
},
"number": "40702810400000146666",
"replenishmentAmount": 111.11,
"status": {
"code": "OPENED",
"en": "Opened",
"ru": "Открыт"
},
"type": {
"code": "TRANSIT",
"en": "Transit account",
"ru": "Транзитный счет"
}
}
],
"items": {
"$ref": "#/components/schemas/AccountDataV1"
},
"type": "array"
},
"cnum": {
"$ref": "#/components/schemas/OrgCnum",
"description": "Клиентский номер организации"
},
"hasPool": {
"$ref": "#/components/schemas/OrgHasPool",
"description": "Признак наличия пула в организации"
},
"id": {
"$ref": "#/components/schemas/OrgId",
"description": "Идентификатор организации"
},
"inn": {
"$ref": "#/components/schemas/OrgINN",
"description": "ИНН организации"
},
"name": {
"$ref": "#/components/schemas/OrgName",
"description": "Наименование организации"
}
},
"required": [
"id",
"cnum"
],
"type": "object"
},
"StatementAccountKey": {
"description": "Ключ для запроса выписок",
"example": "40702810400000146666:1234",
"type": "string"
}
},
"securitySchemes": {
"OpenId_Access_Token": {
"bearerFormat": "JWT",
"description": "OAuth 2.0 Bearer JWT-токен, передаваемый в заголовке Authorization",
"scheme": "bearer",
"type": "http"
},
"OpenId_Id-Token": {
"description": "ID token в формате JWT, передаваемый в заголовке Id-Token",
"in": "header",
"name": "Id-Token",
"type": "apiKey"
},
"RaifApiAuthorization": {
"scheme": "bearer",
"type": "http"
},
"RaifApiIdToken": {
"in": "header",
"name": "Id-Token",
"type": "apiKey"
}
}
}