Валютные переводы. Импорт в формате ISO 20022.

Варианты

• Public

Операции API

{
  "tags": [
    "currency-transfer"
  ],
  "summary": "Импорт неподписанного валютного перевода",
  "description": "Отправка XML-файла с неподписанными валютными платежами. \n\n[Документация по неподписанным валютным платежам](https://cdn.rbo.raiffeisen.ru/fs/international_business/rbo-cc/ft-iso-adapter/unsigned-currency-transfers.pdf), \n\n[Guide for sending unsigned currency payments (EN)](https://cdn.rbo.raiffeisen.ru/fs/international_business/rbo-cc/ft-iso-adapter/unsigned-currency-transfers.en.pdf), \n\n[XSD-схема для валидации (XSD validation scheme)](https://cdn.rbo.raiffeisen.ru/fs/international_business/rbo-cc/ft-iso-adapter/pain.001.001.11.raifsig.xsd), \n\n[Документация API по ISO XML](https://cdn.rbo.raiffeisen.ru/fs/international_business/rbo-cc/ft-iso-adapter/pain.001.001.raifsig.spec.xlsx), \n\n[API ISO Documentation XML (EN)](https://cdn.rbo.raiffeisen.ru/fs/international_business/rbo-cc/ft-iso-adapter/pain.001.001.raifsig.spec.en.xlsx).\n",
  "operationId": "unsignedCurrencyTransfer",
  "parameters": [
    {
      "$ref": "#/components/parameters/IdTokenHeader"
    },
    {
      "$ref": "#/components/parameters/AuthorizationHeader"
    }
  ],
  "requestBody": {
    "description": "Информация о валютном переводе в XML-формате. Каждый CdtTrfTxInf может содержать до 10 блоков Attchmnt: DocNm, MIMETp и InclBinryObjct с base64-контентом. Поддерживаются application/pdf, image/tiff, image/png и image/jpeg. Размер одного файла не должен превышать 5 МБ, суммарный размер вложений во всём XML-сообщении — 5 МБ. Расширение DocNm должно соответствовать MIMETp.",
    "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"
    },
    "409": {
      "$ref": "#/components/responses/DuplicateMessage"
    },
    "413": {
      "$ref": "#/components/responses/PayloadTooLarge"
    },
    "500": {
      "$ref": "#/components/responses/InternalError"
    }
  }
}

{
  "tags": [
    "currency-transfer"
  ],
  "summary": "Отправка подписанного валютного перевода",
  "description": "Отправка XML-файла с подписанными валютными платежами. \n\n[Документация по подписанным валютным платежам](https://cdn.rbo.raiffeisen.ru/fs/international_business/rbo-cc/ft-iso-adapter/signed-currency-transfers.pdf), \n\n[Guide for sending signed currency payments (EN)](https://cdn.rbo.raiffeisen.ru/fs/international_business/rbo-cc/ft-iso-adapter/signed-currency-transfers.en.pdf) \n\n[XSD-схема для валидации (XSD validation scheme)](https://cdn.rbo.raiffeisen.ru/fs/international_business/rbo-cc/ft-iso-adapter/pain.001.001.11.raifsig.xsd), \n\n[Документация API по ISO XML](https://cdn.rbo.raiffeisen.ru/fs/international_business/rbo-cc/ft-iso-adapter/pain.001.001.raifsig.spec.xlsx), \n\n[API ISO Documentation XML (EN)](https://cdn.rbo.raiffeisen.ru/fs/international_business/rbo-cc/ft-iso-adapter/pain.001.001.raifsig.spec.en.xlsx). \n\n",
  "operationId": "signedCurrencyTransfer",
  "parameters": [
    {
      "$ref": "#/components/parameters/IdTokenHeader"
    },
    {
      "$ref": "#/components/parameters/AuthorizationHeader"
    }
  ],
  "requestBody": {
    "description": "Информация о валютном переводе в XML-формате. Каждый CdtTrfTxInf может содержать до 10 блоков Attchmnt: DocNm, MIMETp и InclBinryObjct с base64-контентом. Поддерживаются application/pdf, image/tiff, image/png и image/jpeg. Размер одного файла не должен превышать 5 МБ, суммарный размер вложений во всём XML-сообщении — 5 МБ. Расширение DocNm должно соответствовать MIMETp. Base64-контент входит в подписываемую часть 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"
    },
    "409": {
      "$ref": "#/components/responses/DuplicateMessage"
    },
    "413": {
      "$ref": "#/components/responses/PayloadTooLarge"
    },
    "500": {
      "$ref": "#/components/responses/InternalError"
    }
  }
}

{
  "tags": [
    "currency-transfer"
  ],
  "summary": "Получение детального статуса группового платежа",
  "description": "Получение детального статуса группового платежа. \n\n[XSD-схема для валидации (XSD validation scheme)](https://cdn.rbo.raiffeisen.ru/fs/international_business/rbo-cc/ft-iso-adapter/pain.002.001.12.xsd), \n\n[Документация API по ISO XML](https://cdn.rbo.raiffeisen.ru/fs/international_business/rbo-cc/ft-iso-adapter/pain.002.001.12.spec.xlsx), \n\n[API ISO Documentation XML](https://cdn.rbo.raiffeisen.ru/fs/international_business/rbo-cc/ft-iso-adapter/pain.002.001.12.spec.en.xlsx). \n\n",
  "operationId": "currencyTransferStatus",
  "parameters": [
    {
      "name": "msgId",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string"
      },
      "example": "ORCRUWIRE0170202229000030"
    },
    {
      "$ref": "#/components/parameters/IdTokenHeader"
    },
    {
      "$ref": "#/components/parameters/AuthorizationHeader"
    }
  ],
  "responses": {
    "200": {
      "description": "Статус успешно получен. Для документов с ошибкой вложения ответ содержит опциональный SplmtryData/rai:AttachmentError с полями pmtInfId, errorCode и errorFileName. Namespace расширения: urn:raiffeisen:iso:adapter:status.",
      "content": {
        "application/xml": {
          "schema": {
            "type": "string"
          },
          "examples": {
            "ACSC": {
              "summary": "ACSC - Все платежи исполнены",
              "description": "ACSC",
              "value": "<Document>...<GrpSts>ACSC</GrpSts>...</Document>"
            },
            "PDNG": {
              "summary": "PDNG - Платежи обрабатываются",
              "description": "PDNG",
              "value": "<Document>...<GrpSts>PDNG</GrpSts>...</Document>"
            },
            "RJCT": {
              "summary": "RJCT - Все платежи отклонены",
              "description": "RJCT",
              "value": "<Document>...<GrpSts>RJCT</GrpSts>...</Document>"
            },
            "CANC": {
              "summary": "CANC - Все платежи отозваны",
              "description": "CANC",
              "value": "<Document>...<GrpSts>CANC</GrpSts>...</Document>"
            },
            "DELT": {
              "summary": "DELT - Все платежи помечены к удалению",
              "description": "DELT",
              "value": "<Document>...<GrpSts>DELT</GrpSts>...</Document>"
            },
            "ACWC": {
              "summary": "ACWC - Платежи имеют ошибки",
              "description": "ACWC",
              "value": "<Document>...<GrpSts>ACWC</GrpSts>...</Document>"
            },
            "PART": {
              "summary": "PART - Часть платежей исполнена",
              "description": "PART",
              "value": "<Document>...<GrpSts>PART</GrpSts>...</Document>"
            },
            "PERR": {
              "summary": "PERR - Платежи имеют ошибку ожидания",
              "description": "PERR",
              "value": "<Document>...<GrpSts>PERR</GrpSts>...</Document>"
            },
            "ATTACHMENT_REJECTED": {
              "summary": "RJCT - Вложение платежа отклонено",
              "description": "Management отклонил вложение. Для повторной отправки клиент должен использовать новые MsgId и pmtInfId.",
              "value": "<Document>...<GrpSts>RJCT</GrpSts>...<SplmtryData><PlcAndNm>AttachmentError</PlcAndNm><Envlp><rai:AttachmentError xmlns:rai=\"urn:raiffeisen:iso:adapter:status\"><rai:pmtInfId>ORCRUWIRE0040203219700010</rai:pmtInfId><rai:errorCode>ATTACHMENT_REJECTED</rai:errorCode><rai:errorFileName>invoice.pdf</rai:errorFileName></rai:AttachmentError></Envlp></SplmtryData>...</Document>"
            }
          }
        }
      }
    },
    "401": {
      "$ref": "#/components/responses/Unauthorized"
    },
    "404": {
      "$ref": "#/components/responses/DocumentNotFound"
    },
    "500": {
      "$ref": "#/components/responses/InternalError"
    }
  }
}

{
  "tags": [
    "currency-transfer"
  ],
  "summary": "Получение статуса платежа в формате ISO20022",
  "description": "Получение статуса платежа. \n\n[XSD-схема для валидации (XSD validation scheme)](https://cdn.rbo.raiffeisen.ru/fs/international_business/rbo-cc/ft-iso-adapter/pain.002.001.12.xsd), \n\n[Документация API по ISO XML](https://cdn.rbo.raiffeisen.ru/fs/international_business/rbo-cc/ft-iso-adapter/pain.002.001.12.spec.xlsx), \n\n[API ISO Documentation XML (EN)](https://cdn.rbo.raiffeisen.ru/fs/international_business/rbo-cc/ft-iso-adapter/pain.002.001.12.spec.en.xlsx).\n",
  "operationId": "currencyTransferPaymentStatus",
  "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": "Статус успешно получен. При ошибке вложения ответ содержит опциональный SplmtryData/rai:AttachmentError с полями errorCode и errorFileName. Namespace расширения: urn:raiffeisen:iso:adapter:status.",
      "content": {
        "application/xml": {
          "schema": {
            "type": "string"
          },
          "examples": {
            "ACWC": {
              "summary": "ACWC - Документ создан, найдены ошибки",
              "description": "ACWC",
              "value": "<Document> ... <DtldSts>ACWC</DtldSts> ... </Document>"
            },
            "ACCP": {
              "summary": "ACCP - Документ ждет подписи",
              "description": "ACCP",
              "value": "<Document>...<DtldSts>ACCP</DtldSts>...</Document>"
            },
            "PSGN": {
              "summary": "PSGN - Документ ждет доп. подписи",
              "description": "PSGN",
              "value": "<Document> ... <DtldSts>PSGN</DtldSts> ... </Document>"
            },
            "FSGN": {
              "summary": "FSGN - Документ ждет отправки",
              "description": "FSGN",
              "value": "<Document> ... <DtldSts>FSGN</DtldSts> ... </Document>"
            },
            "ACSP": {
              "summary": "ACSP - Документ в работе у банка",
              "description": "ACSP",
              "value": "<Document> ... <DtldSts>ACSP</DtldSts> ... </Document>"
            },
            "ACSC": {
              "summary": "ACSC - Документ исполнен",
              "description": "ACSC",
              "value": "<Document> ... <DtldSts>ACSC</DtldSts> ... </Document>"
            },
            "CANC": {
              "summary": "CANC - Документ отклонен",
              "description": "CANC",
              "value": "<Document> ... <DtldSts>CANC</DtldSts> ... </Document>"
            },
            "DELT": {
              "summary": "DELT - Документ удален",
              "description": "DELT",
              "value": "<Document> ... <DtldSts>DELT</DtldSts> ... </Document>"
            },
            "RJCT": {
              "summary": "RJCT - Документ отклонен",
              "description": "RJCT",
              "value": "<Document> ... <DtldSts>RJCT</DtldSts> ... </Document>"
            },
            "PDNG": {
              "summary": "PDNG - Документ обрабатывается",
              "description": "PDNG",
              "value": "<Document> ... <DtldSts>PDNG</DtldSts> ... </Document>"
            },
            "PERR": {
              "summary": "PERR - Документ имеет ошибку ожидания",
              "description": "PERR",
              "value": "<Document> ... <DtldSts>PERR</DtldSts> ... </Document>"
            },
            "ACTC": {
              "summary": "ACTC - Документ принят",
              "description": "ACTC",
              "value": "<Document> ... <DtldSts>ACTC</DtldSts> ... </Document>"
            },
            "RCVD": {
              "summary": "RCVD - Документ получен",
              "description": "RCVD",
              "value": "<Document> ... <DtldSts>RCVD</DtldSts> ... </Document>"
            },
            "ATTN": {
              "summary": "ATTN - Документ принят",
              "description": "ATTN",
              "value": "<Document> ... <DtldSts>ATTN</DtldSts> ... </Document>"
            },
            "NPMT": {
              "summary": "NPMT - Документ не оплачен",
              "description": "NPMT",
              "value": "<Document> ... <DtldSts>NPMT</DtldSts> ... </Document>"
            },
            "DBLC": {
              "summary": "DBLC - Документ является дубликатом",
              "description": "DBLC",
              "value": "<Document> ... <DtldSts>DBLC</DtldSts> ... </Document>"
            },
            "ATTACHMENT_REJECTED": {
              "summary": "RJCT - Вложение платежа отклонено",
              "description": "Management отклонил вложение. Для повторной отправки клиент должен использовать новые MsgId и pmtInfId.",
              "value": "<Document>...<DtldSts>RJCT</DtldSts>...<SplmtryData><PlcAndNm>AttachmentError</PlcAndNm><Envlp><rai:AttachmentError xmlns:rai=\"urn:raiffeisen:iso:adapter:status\"><rai:errorCode>ATTACHMENT_REJECTED</rai:errorCode><rai:errorFileName>invoice.pdf</rai:errorFileName></rai:AttachmentError></Envlp></SplmtryData>...</Document>"
            }
          }
        }
      }
    },
    "401": {
      "$ref": "#/components/responses/Unauthorized"
    },
    "404": {
      "$ref": "#/components/responses/DocumentNotFound"
    },
    "500": {
      "$ref": "#/components/responses/InternalError"
    }
  }
}

Схемы и примеры

{
  "responses": {
    "ValidationError": {
      "description": "Ошибки валидации",
      "content": {
        "text/plain": {
          "schema": {
            "type": "string",
            "description": "Сообщение об ошибке"
          },
          "example": "XML validation error"
        }
      }
    },
    "Unauthorized": {
      "description": "Аутентификация не пройдена"
    },
    "Forbidden": {
      "description": "Доступ запрещён"
    },
    "DuplicateMessage": {
      "description": "Дубликат сообщения или платежа. После ошибки вложения повторная отправка допускается только с новыми MsgId и pmtInfId.",
      "content": {
        "text/plain": {
          "schema": {
            "type": "string",
            "description": "Сообщение об ошибке"
          },
          "example": "Duplicate message id or payment id"
        }
      }
    },
    "PayloadTooLarge": {
      "description": "Размер тела XML-запроса превышает установленный лимит"
    },
    "InternalError": {
      "description": "Внутренняя ошибка"
    },
    "DocumentNotFound": {
      "description": "Документ не найден",
      "content": {
        "text/plain": {
          "schema": {
            "type": "string",
            "description": "Сообщение об ошибке"
          },
          "example": "Message not found with id = ... for current user"
        }
      }
    }
  },
  "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="
      }
    }
  }
}