2. REST
В рамках системы Host-to-Host предлагаются следующие ресурсы:
Документ | Описание метода | Метод | Ссылка | Комментарий |
---|---|---|---|---|
Валютный перевод |
Create Payments |
POST |
/API/v1/ISO20022/Payments |
Создание пакета ВП/ПП |
Get Message Status by Id |
GET |
/API/v1/ISO20022/Payments/<MsgId> |
Получение статуса по пакету ВП/ПП |
|
Get Payment Status by Id |
GET |
/API/v1/ISO20022/Payments/Transactions/<InstrId> |
Получение статуса по конкретному ВП/ПП |
|
Get Payment printed form by Id |
GET |
/API/v1/ISO20022/Payments/Print/<InstrId> |
Получение печатной формы ВП/ПП (подробнее: [Print_pmt_rub]) |
|
Отзыв платежа |
Create Recall Payment |
PUT |
/API/v1/ISO20022/Payments/Recall |
Отзыв платежа |
Выписка |
Post Request for Statement |
POST |
/API/v1/ISO20022/Statements |
Запрос выписки |
Get Statement by Id |
GET |
/API/v1/ISO20022/Statements/<MsgID> |
Получение выписки |
|
Онлайн остаток |
Post Request for Account Balance |
POST |
/API/v1/ISO20022/Statements/AccountBalance |
Запрос базового остатка |
Post Request for Extended Account Balance |
POST |
/API/v1/ISO20022/Statements/AccountBalanceExtended |
Получение расширенного остатка |
|
СПД |
Create ConfCertitficate |
POST |
/API/v1/ISO20022/ConfCertificates |
Создание пакета СПД |
Get Message Status by Id |
GET |
/API/v1/ISO20022/ConfCertificates/<MsgId> |
Получение статуса по пакету СПД |
|
Get ConfCertitficate Status by Id |
GET |
/API/v1/ISO20022/ConfCertificates/Transactions/<TxId> |
Получение статуса по конкретной СПД |
|
Вложения к СПД |
Load attaches to Certificate |
POST |
/API/v1/ISO20022/ConfCertificates/Transactions/Files/<SpprtgDocId> |
Отправка вложенных файлов в СПД (Выводится из эксплуатации, используйте: [FILES_WITH]) |
Get attaches' list to Certificate |
GET |
/API/v1/ISO20022/ConfCertificates/Transactions/Files/<SpprtgDocId> |
Получение списка файлов, приложенных к СПД |
|
Get attach to Certificate |
GET |
/API/v1/ISO20022/ConfCertificates/Transactions/Files/<SpprtgDocId>/<FileId> |
Получение контента файла, приложенного к СПД |
|
СВО |
Create COCertificates |
POST |
/API/v1/ISO20022/COCertificates |
Создание пакета СВО |
Get Message Status by Id |
GET |
/API/v1/ISO20022/COCertificates/<MsgId> |
Получение статуса по пакету СВО |
|
Get COCertificate Status by Id |
GET |
/API/v1/ISO20022/COCertificates/Transactions/<TxId> |
Получение статуса по конкретным СВО |
|
Вложения к СВО |
Load attaches to Certificate |
POST |
/API/v1/ISO20022/COCertificates/Transactions/Files/<TxId> |
Отправка вложенных файлов в СВО (Выводится из эксплуатации, используйте: [FILES_WITH]) |
Get attaches' list to Certificate |
GET |
/API/v1/ISO20022/COCertificates/Transactions/Files/<TxId> |
Получение списка файлов, приложенных к СВО |
|
Get attach to Certificate |
GET |
/API/v1/ISO20022/COCertificates/Transactions/Files/<TxId>/<FileId> |
Получение контента файла, приложенного к СВО |
|
РСТС |
Create FCYRLS |
POST |
/API/v1/ISO20022/FCYRLS |
Создание РСТС |
Get Message Status by Id |
GET |
/API/v1/ISO20022/FCYRLS/<MsgId> |
Получение статуса по сообщению, содержащему одно или несколько РСТС |
|
Get RLS Status by Id |
GET |
/API/v1/ISO20022/FCYRLS/Order/<PmtInfId> |
Получение статуса по конкретному РСТС |
|
Письмо |
Create official letter |
POST |
/API/v1/ISO20022/Letters |
Создание письма |
Get message status |
GET |
/API/v1/ISO20022/Letters/<MsgId> |
Получение статуса по пакету писем |
|
Get letter status |
GET |
/API/v1/ISO20022/Letters/OutLetters/<ReqOrLttrId> |
Получение статуса по конкретному письму |
|
Вложения к письму |
Load attaches to letter |
POST |
/API/v1/ISO20022/Letters/OutLetters/Files/<ReqOrLttrId> |
Отправка вложенных файлов (Выводится из эксплуатации, используйте: [FILES_WITH]) |
Get attach’s content to incoming letter |
GET |
/API/v1/ISO20022/Letters/InLetters/Files/<ReqOrLttrId>/<DocNb> |
Получение контента файла, приложенного к входящему письму |
|
Список входящих писем |
Post request for list of letters |
POST |
/API/v1/ISO20022/Letters/Lists |
Запрос на получение списка писем (входящих+ув-ия о ПВВ) |
Get list of letters |
GET |
/API/v1/ISO20022/Letters/Lists/<MsgId> |
Получение списка писем (входящих+ув-ия о ПВВ) |
|
Контракт (УНК) |
Create Contract |
POST |
/API/v1/ISO20022/Contracts |
Постановка на учет внешнеторгового контракта (УНК) |
Get Message Status by Id |
GET |
/API/v1/ISO20022/Contracts/<MsgId> |
Получение статуса по пакету Контракта (УНК) |
|
Get Contract Status by Id |
GET |
/API/v1/ISO20022/Contracts/Contract/<CtrctRegnOpngId> |
Получение статуса по конкретному Контракту (УНК) |
|
Get Сonfirmed Сontract by Id |
GET |
/API/v1/ISO20022/Contracts/Confirmations/<CtrctRegnOpngId> |
Получение подтвержденного Контракта с номером УНК |
|
Вложения к контракту |
Load attaches to contract |
POST |
/API/v1/ISO20022/Contracts/Files/<CtrctRegnOpngId> |
Отправка вложенных файлов (Выводится из эксплуатации, используйте: [FILES_WITH]) |
Get attaches' list to contract |
GET |
/API/v1/ISO20022/Contracts/Files/<CtrctRegnOpngId> |
Получение списка файлов, приложенных к Контракту |
|
Get attach’s content to contract |
GET |
/API/v1/ISO20022/Contracts/Files/<CtrctRegnOpngId>/<FileId> |
Получение контента файла, приложенного к полученному контракту |
|
Поручение на конверсионную операцию |
Create FX |
POST |
/API/v1/ISO20022/ForeignExchanges |
Создание поручения |
Get Message Status by Id |
GET |
/API/v1/ISO20022/ForeignExchanges/<MsgId> |
Получение статуса по сообщению, содержащему одну или несколько конверсионных операций |
|
Get FX Status by Id |
GET |
/API/v1/ISO20022/ForeignExchanges/Instructions/<InstrId> |
Получение статуса по поручению |
|
Зарплатная ведомость |
Send payroll |
POST |
/API/v1/ISO20022/Payroll |
Отправить ЗП ведомость |
Get message status |
GET |
/API/v1/ISO20022/Payroll/<MsgId> |
Получить статус сообщения с зарплатной ведомостью |
|
Открытие ЛС |
Send Employee account application |
POST |
/API/v1/ISO20022/EmployeeAccount |
Отправить заявку на открытие ЛС |
Get message status |
GET |
/API/v1/ISO20022/EmployeeAccount/<MsgId> |
Получить статус сообщения с заявкой на открытие ЛС |
|
Формирование архива со списком ВБК |
Create an archive of bank control statements |
POST |
/API/v1/ISO20022/ContractReports |
Создание архива с ВБК по контрактам |
Get Message Status by Id |
GET |
/API/v1/ISO20022/ContractReports/<MsgId> |
Получение статуса по сообщению, содержащему все переданные номера контрактов |
|
Download file by Id |
GET |
/API/v1/ISO20022/ContractReports/Files/<MsgId> |
Скачивание архива со списком ВБК |