Перелік методів API
Специфікація методів API містить перелік методів взаємодії Систем Клієнта з Системою ЦД.
Увага
При запиті кожного метода потрібно використовувати HTTP-схему Bearer для передачі токена доступу в header (Authorization: Bearer [token]).
- Довідник цінних паперів
- Довідних депозитарних установ
- Довідник типів депозитарних операцій
- Довідник статусів розпоряджень
- Інформація про рахунки депонентів
- Інформація про стан рахунків депонентів
- Журнал надісланих розпоряджень
- Журнал виконаних операцій
- Heartbeat
- Операція створення розпорядження на внутрішній переказ всередині ДУ
- Отримання статусу розпорядження
# Довідник цінних паперів
# Опис методу
# XSD-схема відповіді
| # | Доступність | Ресурс | Методи | Опис | Обов’язковий параметр |
|---|---|---|---|---|---|
| 1 | ДУ | FI | GET | Отримання переліку | |
| GET | Отримання інформації про ЦП | код ISIN |
# Довідних депозитарних установ
# Опис методу
# XSD-схема відповіді
| # | Доступність | Ресурс | Методи | Опис | Обов’язковий параметр |
|---|---|---|---|---|---|
| 2 | ДУ | DI | GET | Отримання переліку | |
| GET | Отримання інформації про ДУ | код МДО |
# Довідник типів депозитарних операцій
# Опис методу
# XSD-схема відповіді
| # | Доступність | Ресурс | Методи | Опис |
|---|---|---|---|---|
| 4 | ДУ | OperType | GET | Отримання переліку типів депозитарних операції |
# Довідник статусів розпоряджень
# Опис методу
# XSD-схема відповіді
| # | Доступність | Ресурс | Методи | Опис |
|---|---|---|---|---|
| 5 | ДУ | InstructionState | GET | Отримання переліку статусів депозитарних операцій |
# Інформація про рахунки депонентів
# Опис методу
# XSD-схема відповіді
| # | Доступність | Ресурс | Методи | Опис | Обов’язковий параметр |
|---|---|---|---|---|---|
| 7 | ДУ | Account | GET | Отримання переліку рахунків | |
| GET | Отримання інформації про Рахунок | Номер рахунку |
# Інформація про стан рахунків депонентів
# Опис методу
# XSD-схема відповіді
| # | Доступність | Ресурс | Методи | Опис | Обов’язковий параметр |
|---|---|---|---|---|---|
| 8 | ДУ | AccountState | GET | Отримання переліку станів пакетів ЦП на рахунках | |
| GET | Отримання інформації про пакети ЦП на Рахунку | Номер рахунку |
# Журнал надісланих розпоряджень
# Опис методу
# XSD-схема відповіді
| # | Доступність | Ресурс | Методи | Опис | Обов’язковий параметр |
|---|---|---|---|---|---|
| 9 | ДУ | Instruction | GET | Отримання журнала надісланих розпоряджень | |
| GET | Отримання журнала надісланих розпоряджень за період | Дата початку періоду, Дата кінця періоду | |||
| GET | Отримання журнала надісланих розпоряджень по рахунку | Номер рахунку | |||
| GET | Отримання журнала надісланих розпоряджень по рахунку за період | Номер рахунку, Дата початку періоду, Дата кінця періоду |
# Журнал виконаних операцій
# Опис методу
# XSD-схема відповіді
| # | Доступність | Ресурс | Методи | Опис | Обов’язковий параметр |
|---|---|---|---|---|---|
| 10 | ДУ | Operation | GET | Отримання журнала операцій | |
| GET | Отримання журнала операцій за період | Дата початку періоду, Дата кінця періоду | |||
| GET | Отримання журнала операцій по рахунку | Номер рахунку | |||
| GET | Отримання журнала операцій по рахунку за період | Номер рахунку, Дата початку періоду, Дата кінця періоду |
# Heartbeat
| # | Доступність | Ресурс | Методи | Опис |
|---|---|---|---|---|
| 13 | ДУ | Ping | GET | Heartbeat API |
# Операція створення розпорядження на внутрішній переказ всередині ДУ
# Опис методу
# XSD-схема відповіді
| # | Доступність | Ресурс | Методи | Опис |
|---|---|---|---|---|
| 23 | ДУ | OWNI | POST | Надання інструкції на внутрішній переказ всередині ДУ |
# Отримання статусу розпорядження
# Опис методу
# XSD-схема відповіді
| # | Доступність | Ресурс | Методи | Опис | Обов’язковий параметр |
|---|---|---|---|---|---|
| 31 | ДУ | OperationState | GET | Отримання статусу розпорядження по ідентифікатору | Id розпорядження |