Рублевые переводы. Импорт платежей в формате ISO 20022
OpenAPI 0.3.0
## Описание API Это API предназначено для загрузки и проверки пакетов платежей в формате **ISO 20022**, используемом в системе РПП (Рублёвые платежные поручения) Райффайзенбанка.
Варианты
- Паблик
Операции API
POST /v2/transfers/iso20022/unsigned — Импорт неподписанного платежа в формате ISO20022
ВАЖНО: Данный функционал недоступен для клиентов сегмента Финансовые институты! Отправка XML-файла с неподписанными платежами. [Документация по неподписанным платежам на английском](https://cdn.rbo.raiffeisen.ru/fs/cashmanagement/unsigned-payments-en.pdf), [Документация по неподписанным платежам на русском](https://cdn.rbo.raiffeisen.ru/fs/cashmanagement/unsigned-payments-ru.pdf), [XSD-схема для валидации](https://cdn.rbo.raiffeisen.ru/fs/cashmanagement/pain.001.001.raif.xsd), [Документация API по ISO XML](https://cdn.rbo.raiffeisen.ru/fs/cashmanagement/Raiffeisen_API_isoxml_signed_V2.xlsx).
{
"tags": [
"domestic-payments"
],
"summary": "Импорт неподписанного платежа в формате ISO20022",
"operationId": "unsignedDomesticPayment",
"description": "ВАЖНО: Данный функционал недоступен для клиентов сегмента Финансовые институты! \nОтправка XML-файла с неподписанными платежами. \n[Документация по неподписанным платежам на английском](https://cdn.rbo.raiffeisen.ru/fs/cashmanagement/unsigned-payments-en.pdf), \n[Документация по неподписанным платежам на русском](https://cdn.rbo.raiffeisen.ru/fs/cashmanagement/unsigned-payments-ru.pdf), \n[XSD-схема для валидации](https://cdn.rbo.raiffeisen.ru/fs/cashmanagement/pain.001.001.raif.xsd), \n[Документация API по ISO XML](https://cdn.rbo.raiffeisen.ru/fs/cashmanagement/Raiffeisen_API_isoxml_signed_V2.xlsx).\n",
"parameters": [
{
"$ref": "#/components/parameters/IdTokenHeader"
},
{
"$ref": "#/components/parameters/AuthorizationHeader"
}
],
"requestBody": {
"description": "XML-документ установленного формата, представляющий данные неподписанного платежного поручения",
"content": {
"application/xml": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Задача для рублевого платежа успешно создана"
},
"400": {
"$ref": "#/components/responses/ValidationError"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"413": {
"$ref": "#/components/responses/FileIsTooLarge"
},
"500": {
"$ref": "#/components/responses/InternalError"
}
}
}POST /v2/transfers/iso20022/signed — Импорт подписанного с помощью XmlDSig платежа в формате ISO20022
ВАЖНО: Данный функционал недоступен для клиентов сегмента Финансовые институты! Отправка XML-файла, подписанного с использованием **XmlDSig**. [API Документация на английском](https://cdn.rbo.raiffeisen.ru/fs/cashmanagement/api-eng.pdf), [API Документация на русском](https://cdn.rbo.raiffeisen.ru/fs/cashmanagement/api-rus.pdf), [XSD-схема для валидации](https://cdn.rbo.raiffeisen.ru/fs/cashmanagement/pain.001.001.raifsig.xsd), [Документация API по подписанным ISO XML](https://cdn.rbo.raiffeisen.ru/fs/cashmanagement/Raiffeisen_API_isoxml_signed_V2.xlsx), [Инструкция по подписи (Примеры на Java)](https://cdn.rbo.raiffeisen.ru/fs/cashmanagement/xmldsig_sign_instruction.md).
{
"tags": [
"domestic-payments"
],
"summary": "Импорт подписанного с помощью XmlDSig платежа в формате ISO20022",
"operationId": "signedDomesticPayment",
"description": "ВАЖНО: Данный функционал недоступен для клиентов сегмента Финансовые институты! \nОтправка XML-файла, подписанного с использованием **XmlDSig**. \n[API Документация на английском](https://cdn.rbo.raiffeisen.ru/fs/cashmanagement/api-eng.pdf), \n[API Документация на русском](https://cdn.rbo.raiffeisen.ru/fs/cashmanagement/api-rus.pdf), \n[XSD-схема для валидации](https://cdn.rbo.raiffeisen.ru/fs/cashmanagement/pain.001.001.raifsig.xsd), \n[Документация API по подписанным ISO XML](https://cdn.rbo.raiffeisen.ru/fs/cashmanagement/Raiffeisen_API_isoxml_signed_V2.xlsx), \n[Инструкция по подписи (Примеры на Java)](https://cdn.rbo.raiffeisen.ru/fs/cashmanagement/xmldsig_sign_instruction.md).\n",
"parameters": [
{
"$ref": "#/components/parameters/IdTokenHeader"
},
{
"$ref": "#/components/parameters/AuthorizationHeader"
}
],
"requestBody": {
"description": "XML-документ установленного формата, представляющий данные подписанного платежного поручения\n",
"content": {
"application/xml": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Задача для рублевого платежа успешно создана"
},
"400": {
"$ref": "#/components/responses/ValidationError"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"413": {
"$ref": "#/components/responses/FileIsTooLarge"
},
"500": {
"$ref": "#/components/responses/InternalError"
}
}
}GET /v2/transfers/iso20022/{msgId}/status — Получение краткой квитанции по пакету платежей в формате ISO20022
ВАЖНО: Данный функционал недоступен для клиентов сегмента Финансовые институты! Получение краткой квитанции по пакету платежей в формате ISO20022. [API Документация на английском](https://cdn.rbo.raiffeisen.ru/fs/cashmanagement/api-eng.pdf), [API Документация на русском](https://cdn.rbo.raiffeisen.ru/fs/cashmanagement/api-rus.pdf).
{
"tags": [
"domestic-payments"
],
"summary": "Получение краткой квитанции по пакету платежей в формате ISO20022",
"operationId": "domesticPackageStatus",
"description": "ВАЖНО: Данный функционал недоступен для клиентов сегмента Финансовые институты! \nПолучение краткой квитанции по пакету платежей в формате ISO20022. \n[API Документация на английском](https://cdn.rbo.raiffeisen.ru/fs/cashmanagement/api-eng.pdf), \n[API Документация на русском](https://cdn.rbo.raiffeisen.ru/fs/cashmanagement/api-rus.pdf).\n",
"parameters": [
{
"name": "msgId",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "Уникальный идентификатор пакета",
"example": "ORCRUWIRE0170202229000030"
},
{
"$ref": "#/components/parameters/IdTokenHeader"
},
{
"$ref": "#/components/parameters/AuthorizationHeader"
}
],
"responses": {
"200": {
"description": "Статус успешно получен",
"content": {
"application/xml": {
"schema": {
"type": "string"
},
"examples": {
"RJCT": {
"summary": "RJCT - Документ отклонен",
"value": "<Document> ... <DtldSts>RJCT</DtldSts> ... </Document>\n"
},
"PDNG": {
"summary": "PDNG - Документ в очереди на обработку",
"value": "<Document>...<DtldSts>PDNG</DtldSts>...</Document>\n"
},
"FSGN": {
"summary": "FSGN - Документ ждет отправки",
"value": "<Document> ... <DtldSts>FSGN</DtldSts> ... </Document>\n"
},
"ACSP": {
"summary": "ACSP - Документ в работе у банка",
"value": "<Document> ... <DtldSts>ACSP</DtldSts> ... </Document>\n"
},
"ATTN": {
"summary": "ATTN - Требует внимания",
"value": "<Document> ... <DtldSts>ATTN</DtldSts> ... </Document>\n"
},
"ACSC": {
"summary": "ACSC - Документ исполнен",
"value": "<Document> ... <DtldSts>ACSC</DtldSts> ... </Document>\n"
},
"CANC": {
"summary": "CANC - Документ отозван",
"value": "<Document> ... <DtldSts>CANC</DtldSts> ... </Document>\n"
},
"DBLC": {
"summary": "DBLC - Платеж не был создан так как является дубликатом",
"value": "<Document> ... <DtldSts>DBLC</DtldSts> ... </Document>\n"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/ValidationError"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/DocumentNotFound"
},
"500": {
"$ref": "#/components/responses/InternalError"
}
}
}GET /v2/transfers/iso20022/{msgId}/status/full — Получение полной квитанции по пакету и платежам внутри пакета в формате ISO20022
ВАЖНО: Данный функционал недоступен для клиентов сегмента Финансовые институты! Получение полной квитанции по пакету и платежам внутри пакета в формате ISO20022, подробная информация по каждому платежу в пакете. [API Документация на английском](https://cdn.rbo.raiffeisen.ru/fs/cashmanagement/api-eng.pdf), [API Документация на русском](https://cdn.rbo.raiffeisen.ru/fs/cashmanagement/api-rus.pdf).
{
"tags": [
"domestic-payments"
],
"summary": "Получение полной квитанции по пакету и платежам внутри пакета в формате ISO20022",
"operationId": "domesticPackageStatusFull",
"description": "ВАЖНО: Данный функционал недоступен для клиентов сегмента Финансовые институты! \nПолучение полной квитанции по пакету и платежам внутри пакета в формате ISO20022, подробная информация по каждому платежу в пакете. \n[API Документация на английском](https://cdn.rbo.raiffeisen.ru/fs/cashmanagement/api-eng.pdf), \n[API Документация на русском](https://cdn.rbo.raiffeisen.ru/fs/cashmanagement/api-rus.pdf).\n",
"parameters": [
{
"name": "msgId",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "Уникальный идентификатор пакета",
"example": "ORCRUWIRE0170202229000030"
},
{
"$ref": "#/components/parameters/IdTokenHeader"
},
{
"$ref": "#/components/parameters/AuthorizationHeader"
}
],
"responses": {
"200": {
"description": "Статус успешно получен",
"content": {
"application/xml": {
"schema": {
"type": "string"
},
"examples": {
"RJCT": {
"summary": "RJCT - Документ отклонен",
"value": "<Document> ... <DtldSts>RJCT</DtldSts> ... </Document>\n"
},
"PDNG": {
"summary": "PDNG - Документ в очереди на обработку",
"value": "<Document>...<DtldSts>PDNG</DtldSts>...</Document>\n"
},
"FSGN": {
"summary": "FSGN - Документ ждет отправки",
"value": "<Document> ... <DtldSts>FSGN</DtldSts> ... </Document>\n"
},
"ACSP": {
"summary": "ACSP - Документ в работе у банка",
"value": "<Document> ... <DtldSts>ACSP</DtldSts> ... </Document>\n"
},
"ATTN": {
"summary": "ATTN - Требует внимания",
"value": "<Document> ... <DtldSts>ATTN</DtldSts> ... </Document>\n"
},
"ACSC": {
"summary": "ACSC - Документ исполнен",
"value": "<Document> ... <DtldSts>ACSC</DtldSts> ... </Document>\n"
},
"CANC": {
"summary": "CANC - Документ отозван",
"value": "<Document> ... <DtldSts>CANC</DtldSts> ... </Document>\n"
},
"DBLC": {
"summary": "DBLC - Платеж не был создан так как является дубликатом",
"value": "<Document> ... <DtldSts>DBLC</DtldSts> ... </Document>\n"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/ValidationError"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/DocumentNotFound"
},
"500": {
"$ref": "#/components/responses/InternalError"
}
}
}GET /v2/transfers/iso20022/{msgId}/payments/{pmtInfId}/status — Получение статуса конкретного платежа по его идентификатору в рамках ранее загруженного пакета в формате ISO20022
ВАЖНО: Данный функционал недоступен для клиентов сегмента Финансовые институты! Получение статуса конкретного платежа по его идентификатору в рамках ранее загруженного пакета. [API Документация на английском](https://cdn.rbo.raiffeisen.ru/fs/cashmanagement/api-eng.pdf), [API Документация на русском](https://cdn.rbo.raiffeisen.ru/fs/cashmanagement/api-rus.pdf), Примеры ответов: [pain002_001_payments_status](https://cdn.rbo.raiffeisen.ru/fs/cashmanagement/Raiffeisen_pain002_001_payments_status.xlsx).
{
"tags": [
"domestic-payments"
],
"summary": "Получение статуса конкретного платежа по его идентификатору в рамках ранее загруженного пакета в формате ISO20022",
"operationId": "domesticPaymentStatus",
"description": "ВАЖНО: Данный функционал недоступен для клиентов сегмента Финансовые институты! \nПолучение статуса конкретного платежа по его идентификатору в рамках ранее загруженного пакета. \n[API Документация на английском](https://cdn.rbo.raiffeisen.ru/fs/cashmanagement/api-eng.pdf), \n[API Документация на русском](https://cdn.rbo.raiffeisen.ru/fs/cashmanagement/api-rus.pdf), \nПримеры ответов: [pain002_001_payments_status](https://cdn.rbo.raiffeisen.ru/fs/cashmanagement/Raiffeisen_pain002_001_payments_status.xlsx).\n",
"parameters": [
{
"name": "msgId",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "ORCRUWIRE0170202229000030"
},
{
"name": "pmtInfId",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "ORCRUWIRE0040203219700010"
},
{
"$ref": "#/components/parameters/IdTokenHeader"
},
{
"$ref": "#/components/parameters/AuthorizationHeader"
}
],
"responses": {
"200": {
"description": "Статус успешно получен",
"content": {
"application/xml": {
"schema": {
"type": "string"
},
"examples": {
"RJCT": {
"summary": "RJCT - Документ отклонен",
"value": "<Document> ... <DtldSts>RJCT</DtldSts> ... </Document>\n"
},
"PDNG": {
"summary": "PDNG - Документ в очереди на обработку",
"value": "<Document>...<DtldSts>PDNG</DtldSts>...</Document>\n"
},
"FSGN": {
"summary": "FSGN - Документ ждет отправки",
"value": "<Document> ... <DtldSts>FSGN</DtldSts> ... </Document>\n"
},
"ACSP": {
"summary": "ACSP - Документ в работе у банка",
"value": "<Document> ... <DtldSts>ACSP</DtldSts> ... </Document>\n"
},
"ATTN": {
"summary": "ATTN - Требует внимания",
"value": "<Document> ... <DtldSts>ATTN</DtldSts> ... </Document>\n"
},
"ACSC": {
"summary": "ACSC - Документ исполнен",
"value": "<Document> ... <DtldSts>ACSC</DtldSts> ... </Document>\n"
},
"CANC": {
"summary": "CANC - Документ отозван",
"value": "<Document> ... <DtldSts>CANC</DtldSts> ... </Document>\n"
},
"DBLC": {
"summary": "DBLC - Платеж не был создан так как является дубликатом",
"value": "<Document> ... <DtldSts>DBLC</DtldSts> ... </Document>\n"
}
}
}
}
},
"400": {
"$ref": "#/components/responses/ValidationError"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/DocumentNotFound"
},
"500": {
"$ref": "#/components/responses/InternalError"
}
}
}Схемы и примеры
{
"parameters": {
"IdTokenHeader": {
"name": "Id-Token",
"in": "header",
"description": "Идентификационный токен пользователя",
"required": true,
"schema": {
"type": "string",
"format": "byte",
"example": "SUQgVE9LRU4gRk9SIFRFU1RJTkc="
}
},
"AuthorizationHeader": {
"name": "Authorization",
"in": "header",
"description": "Токен доступа",
"required": true,
"schema": {
"type": "string",
"format": "byte",
"example": "Bearer QXV0aG9yaXphdGlvbiBIZWFkZXIgRm9yIFRlc3Rpbmc="
}
}
},
"responses": {
"ValidationError": {
"description": "Ошибки валидации",
"content": {
"application/xml": {
"schema": {
"type": "string"
}
}
}
},
"Forbidden": {
"description": "Доступ запрещён"
},
"Unauthorized": {
"description": "Аутентификация не пройдена"
},
"FileIsTooLarge": {
"description": "Размер файла превышает допустимый лимит"
},
"InternalError": {
"description": "Внутренняя ошибка"
},
"DocumentNotFound": {
"description": "Документ не найден"
}
}
}