Основные варианты использования
API позволяет осуществить:
- отправку в банк пакета неподписанных валютных переводов в формате pain.001.001
- запрос статуса отдельного валютного платежа в составе пакета неподписанных валютных переводов в формате pain.002.001
- запрос статуса пакета неподписанных валютных переводов и входящих в него валютных платежей
Отправка неподписанного платежа в Банк
Чтобы загрузить неподписанный платеж в банк, вам необходимо:
- получить AccessToken
- сгенерировать XML в формате pain.001.001 см. формат на странице Формат импорта
- отправить POST-запрос
- получить синхронный ответ со статусом сообщения
Загрузка неподписанных валютных переводов
Запрос
| Запрос | POST /v1/iso20022/currency-transfer |
|---|---|
| Описание |
Импорт неподписанных валютных платежей в формате Pain.001.001 Примечание: с помощью одного POST /v1/iso20022/currency-transfer можно загрузить только одно сообщение в формате pain.001.001. Но сообщение может содержать несколько платежей |
| Content-Type | application/xml |
| Тело запроса | xml в формате pain.001.001 |
Ответ
Банк вернет синхронный ответ, который будет содержать:
- HTTP статус код в соответствии со стандартом
| HTTP статус код | Статус получения сообщения | Описание причины |
|---|---|---|
| 200 | Created | Задача на создание валютного перевода была успешно создана |
| 400 | Bad request | Ошибка валидации XML |
| 401 | Unauthorized | Ошибка авторизации |
| 403 | Forbidden | Доступ к запрошенному ресурсу запрещен |
| 409 | Conflict | Идентификатор сообщения или идентификатор платежа дублируется |
| 500 | Internal Server Error | Произошла непредвиденная ошибка (недоступность сервера и т.д.) |
Запрос статуса пакета неподписанных валютных переводов и статус отдельного валютного платежа
Вы можете запросить следующие статусы обработки платежных документов:
- статус пакета неподписанных валютных переводов и входящих в него валютных платежей
- статус отдельного валютного платежа в составе пакета неподписанных валютных переводов в формате pain.002.001
Запрос статуса пакета неподписанных валютных переводов и всех входящих в него валютных платежей
Для получения статуса необходимо:
- получить AccessToken
- сформировать и отправить GET запрос
v1/iso20022/message/{msgId}/status/full, где msgId - идентификатор отправленного вами сообщения с платежами - получить синхронный ответ со статусами документов: пакета валютных переводов и валютных платежей.
Вам будут доступны следующие статусы:
| ISO CODE | STATUS | DESCRIPTION |
|---|---|---|
| RJCT | REJECTED | Если все платежи в статусе REJECTED: все платежи в составе сообщения были отклонены |
| CANC | REVOKED | Если все платежи в статусе REVOKED: все платежи в составе сообщения были отозваны |
| DELT | DELETED | Если все платежи в статусе DELETED: все платежи в составе сообщения были помечены к удалению |
| ACSC | DONE | Если все платежи в статусе DONE: все платежи в составе сообщения были исполнены |
| ACWC | DRAFT | Если какие-либо платежи имеют ошибки (в статусе DRAFT): платежи в составе сообщения имеют ошибки и требуют исправления |
| PART | Если есть платежи в статусе DONE: часть платежей в составе сообщения были исполнены | |
| PDNG | PENDING | Платежи обрабатываются |
Запрос статуса отдельного валютного платежа в составе пакета неподписанных валютных переводов
Для получения статуса обработки отдельного Валютного платежа, отправленного в составе пакета неподписанных валютных переодов, необходимо:
- получить AccessToken
- сформировать и отправить GET запрос
v1/iso20022/message/{msgId}/payment/{PmtInfId}/status, где msgId-идентификатор отправленного вами сообщения с платежами, а PmtInfId - идентификатор Валютного платежа - получить синхронный ответ о статусе приема сообщения
Вам будут доступны следующие статусы:
| ISO CODE | STATUS | DESCRIPTION |
|---|---|---|
| ACWC | DRAFT | Документ создан, при валидации найдены ошибки |
| ACCP | READY FOR SIGNING | Ждет подписи |
| PSGN | NEEDS OTHER SIGNATURES | Ждет доп. подписи |
| FSGN | READY FOR SENDING | Ждет отправки |
| ACSP | PROCESSING | В работе у банка |
| ACSC | DONE | Исполнен |
| CANC | REVOKED | Отклонен |
| DELT | DELETED | Удален |
Подробно с форматом сообщений вы можете ознакомиться в разделе Формат импорта загрузив файл ISO 20022 PAIN.002.001.12- описание формата и примеры сообщений.