logo
API docs by Redocly

AML.point Platform API (1.9.4)

Download OpenAPI specification:Download

E-mail: [email protected]

Вступ

Короткий огляд

AML.point – це обліково-реєструюча система, призначена для зберігання, обліку та моніторингу платежів компанії, її контрагентів, укладених договорів, та ведення звітності.

AML.point AРI – це інтерфейс, що дозволяє взаємодіяти з платформою AML. point за допомогою спеціальних запитів. Використання цих запитів дозволяє виконати безліч дій, наприклад, отримати список всіх контрактів, створити контрагента, оновити фінансову операцію тощо. І це все можна зробити без безпосередньої взаємодії з графічним інтерфейсом платформи AML.point.

Призначення документу

В цьому документі зібрана вся інформація, необхідна для інтеграції платформи AML.point з вашим програмним забезпеченням чи веб-сайтом. Тут містяться дані про ресурси, особливості формування запитів, опис відповідей. Крім цього, тут представлені приклади запитів та відповідей, для кращого розуміння АРІ. Документ корисний для розробників І технічних спеціалістів, які будуть проводити інтеграцію.

Основні поняття

Список понять, що використовуються в цьому документі:

  • Довідник – систематизований збірник можливих значень параметрів для певних ресурсів.
  • Договір – документ, що засвідчує угоду між СПФМ та її контрагентами про надання фінансових послуг та виконання відповідних обов'язків.
  • Контрагент – це сторона, яка отримує фінансові послуги від СПФМ згідно з умовами договору. Контрагентами можуть бути ФОП, юридичні та фізичні особи (резиденти чи нерезиденти), органи влади, відокремлені підрозділи.
  • СПФМ – всі суб'єкти (компанії, фірми, кредитні спілки, організації, установи), що надають фінансові послуги та щодо яких здійснюється фінансовий моніторинг.
  • Профіль СПФМ – профайл суб'єкта первинного фінансового моніторингу в системі AML.point.
  • Фінансовий моніторинг – система заходів, спрямована на контроль фінансових операцій, верифікацію клієнтів, виявлення спроби фінансування тероризму та легалізації коштів, отриманих незаконним шляхом.

Загальна інформація

API-протокол

Робота AML.point АРІ побудована за всіма принципами REST – архітектурного стилю, який передбачає використання певних HTTP-запитів для того, щоб зробити конкретну дію. Запити мають попередньо визначені URLs, що ведуть до ресурсів з якими і буде виконана певна дія. Більше інформації про REST API можна знайти в цій статті.

AML.point АРІ дозволяє працювати з такими ресурсами:

AML.point має два сервери для прийому HTTP-запитів: https://amlpoint.com.ua/ (основний, підходить для постійної роботи) та https://demo.amlpoint.com.ua/ (рекомендований для використання на тестовому періоді). Всі ресурси на обох серверах ідентичні.

API-запити

Відповідно до принципів REST API всі запити на https://amlpoint.com.ua/[resource] дозволяють проводити певну дію зі всім списком елементів цього ресурсу, а запити відправлені на https://amlpoint.com.ua/[resource]/{ID} дозволяють проводити дію із елементом ресурсу що має конкретний ID.

Всі АРІ-запити вимагають авторизованого доступу. Для авторизації в системі та отримання прав на маніпуляцію з ресурсами, в заголовку необхідно вказати: Authorization: Bearer (токен доступу). Про те, як отримати токен доступу, описано в розділі Авторизація.

AML.point API приймає PUT і POST методи з тілами запиту формату JSON. Тому для таких типів запиту використовуйте заголовок Content type: application/json. Система повертає відповіді також у форматі JSON. Отже, не забудьте додати заголовок Accept:application/json в запит.

АPІ-відповіді

AML.point API використовує стандартні HTTP статус-коди, щоб показати результат запиту. Кожна відповідь містить певне числове значення, що відображає статус-код, та поле з більш детальним поясненням відповіді. Успішні запити маркуються кодом в діапазоні 200-202. Про проблеми з обробкою запиту (наприклад, не було вказано необхідні параметри або були допущені неточності в посиланні на сервер) говорять статус-коди в діапазоні 400-499. Про помилки на стороні сервера AML.point свідчать статус-коди в діапазоні 500-599.

З детальною інформацією про всі HTTP статус-коди можна ознайомитися в цій статті.

Обробка поширених помилок

Якщо при створенні запиту ви отримали неуспішну відповідь, ознайомтеся із таблицею нижче.

HTTP-код Опис Причини Рекомендації
401 Запит не авторизовано токен відсутній або вказаний невірно перевірити наявність та коректність токена в запиті
403 Не вистачає прав обмежені права на виконання певного запиту виконати запит від імені іншого користувача
404 Не знайдено сервер не може знайти ресурс по вказаному ID перевірити правильність ID ресурсу
406 Не вистачає даних некоректні параметри виділених полів перевірити правильність параметрів полів

Реєстрація в AML.point

Перед початком роботи з AML.point, створіть акаунт в системі:

  1. Перейдіть за посиланням https://amlpoint.com.ua/register.
  2. Вкажіть ЄДРПОУ вашої компанії, номер телефону та пошту, а також придумайте пароль.

    Примітка: вказуйте номер телефону та пошту співробітника, який буде відповідальний за керування роботою в системі.

  3. Натисніть кнопку Зареєструватися.

registration

Надалі під час входу в систему необхідно також вказати код, який система відправить на пошту.

Auth. code

Авторизація

Щоб отримати доступ до AML.point АРІ та користуватися всіма його функціями, необхідно пройти авторизацію. Сам процес авторизації базується на використанні спеціального ключа – Bearer token, який відкриває доступ до ресурсів АРІ та дозволяє проводити певні маніпуляції із ними. Для отримання Bearer token, виконайте вхід в систему AML point і, будучи в ній, відкрийте Dev. tools. Перейдіть у вкладку Applications, далі Local Storage. Щоб отримати доступ до ресурсів, в заголовку вказуйте ваш Bearer token.

Bearer token

Термін дії токена – 60 хв. Після завершення цього періоду, доступ до ресурсів закривається і система автоматично вилогінює користувача із платформи. Для продовження роботи з АРІ, необхідно пройти процедуру заново та отримати новий токен.

Зверніть увагу: ваш Bearer token є секретним, адже він надає доступ до приватних даних. Не діліться токеном з іншими та не розкривайте його у публічно доступних місцях такий як форуми, GiTHub, браузери, додатки, соціальні мережі.

Опис ресурсів

Токени постійного доступу

AML.point АРІ використовує два види токенів для авторизації запитів:

  • тимчасові токени – відкривають доступ до АРІ на 60 хв (більше деталей в розділі Авторизація);
  • токени постійного доступу – відкривають доступ до АРІ на 2 роки.

Для підтвердження прав користування AML.point АРІ, отриманий токен постійного доступу передають в заголовку.

Постійний токен наділяє користувача такими ж правами і можливостями роботи в АРІ, як і тимчасовий. Після завершення терміну дії постійного токену варто згенерувати новий. Функціонал AML.point АРІ дозволяє користувачу мати кілька токенів постійного доступу.

Зверніть увагу: як і тимчасовий токен, токен постійного доступу є секретною інформацією, тому тримайте його в надійному місці та не розголошуйте нікому.

Отримати токен постійного доступу

Використовуйте цей ресурс для генерації токена постійного доступу. В цьому випадку, запит на створення токена з постійним доступом відбувається з використанням тимчасового токена, який вказується в заголовку. А вже після отримання постійного токена, його можна використовувати для подальшої роботи з іншими ресурсами. Придумайте назву токена та передайте його в тілі запиту. АРІ поверне постійний токен та його деталі (ID, назву, дату створення та дату завершення терміну його дії).

Authorizations:
bearerAuth
Request Body schema: application/json
name
required
string <= 255

назва токену постійного доступу

Responses

Request samples

Content type
application/json
{
  • "name": "Персональний токен"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Отримати список токенів постійного доступу

Цей ресурс повертає список всіх постійних токенів, які є в наявності в користувача. Токени, термін дії яких завершився, в цьому списку не відображаються, оскільки вони одразу видаляються з бази.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Видалити токен постійного доступу

Ресурс дозволяє видалити певний токен постійного доступу до АРІ (наприклад, у випадках, коли в цілях безпеки потрібно провести заміну ключів доступу). В параметрах шляху вказуйте ID токену, що бажаєте видалити. Статус-код 204 означатиме успішне видалення токена.

Authorizations:
bearerAuth
path Parameters
id
required
string

унікальний ідентифікатор постійного токену

Responses

Response samples

Content type
application/problem+json
{
  • "message": "Unauthenticated."
}

Профілі СПФМ

Ця функціональність АРІ відкриває доступ до профілів суб'єктів первинного фінансового моніторингу. Компанія заводить цей профіль з метою подання звітності та забезпечення фінансового моніторингу.
У відповіді ви знайдете загальну інформацію про компанію, наприклад, її назву, ЄДРПОУ, телефон, email. Окрім цього, тут можна переглянути вид послуги, що надає компанія, ПІБ осіб, відповідальних за фінансовий моніторинг, дані банківського акаунту. Одна компанія може мати кілька профілів СПФМ.

Отримати список профілів СПФМ

Цей ресурс повертає список профілів СПФМ компанії і детальну інформацію по кожному із них.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Контрагенти

Ресурси цієї функціональності АРІ дозволяють працювати з контрагентами. В системі AML.point для кожного контрагенту створюється його картка. В ній міститься основна інформація про контрагента, наприклад, назва компанії чи підприємства, форма власності, ЄДРПОУ, дата реєстрації, юридичний статус компанії, номер телефону. Уповноважена за фінансовий моніторинг особа здійснює перевірку контрагентів на предмет наявності необхідних ліцензій, зв'язків з країною-агресором, терористичними угрупуваннями, приналежності до осіб компанії до санкційних списків тощо. Результати перевірки фіксуються в картці контрагента.

Створити картку контрагента

За допомогою цього ресурсу відбувається створення картки контрагента. Оскільки в системі AML.point контрагенти можуть мати різний юридичний тип, набір параметрів запиту та відповіді можуть дещо відрізнятися.

Authorizations:
bearerAuth
Request Body schema: application/json
One of
type
required
string
Default: "legal-person"

юридичний тип контрагента (див. довідник)

usreou_code
required
string^[\d]{8}$

код ЄДРПОУ

financial_model_id
required
string

ID профілю СПФМ

обов'язково вказувати лише якщо наявні кілька профілів СПФМ

iban
string or null <iban> ^UA\d{8}[A-Z0-9]{19}$

номер банківського рахунку контрагента

is_terrorist
boolean or null

додати ознаку "терорист"

has_sanctions
boolean or null

додати ознаку "має санкції"

Responses

Request samples

Content type
application/json
Example
{
  • "type": "legal-person",
  • "usreou_code": "38657536",
  • "iban": "UA123405670000000026001234567",
  • "financial_model_id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
  • "is_terrorist": false,
  • "has_sanctions": true
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Оновити картку контрагента

Цей ресурс призначений для оновлення ідентифікаційних даних контрагента. В параметрах шляху передавайте ID контрагента, для якого варто внести зміни. Набір параметрів тіла запиту та відповіді залежить від типу контрагента.

Authorizations:
bearerAuth
path Parameters
id
required
string

унікальний ідентифікатор контрагента

Request Body schema: application/json
One of
name
string or null <= 255

назва контрагента

property_form_id
string or null <uuid>

унікальний ідентифікатор форми власності (див. довідник)

state_id
string or null <uuid>

унікальний ідентифікатор юридичного стану (див. довідник)

status_id
string or null <uuid>

унікальний ідентифікатор статусу ділових відносин (див. довідник)

state_registration_date
string or null <date>

дата запису контрагента в ЄДРПОУ

state_registration_number
string or null^(\d{17}(\d{2})?)$

номер запису контрагента в ЄДРПОУ

postal_code
string or null^[\d]{5}$

поштовий індекс контрагента

city
string or null <= 255

населений пункт контрагента

address
string or null <= 255

адреса

mfo
string or null^[\d]{6}$

код МФО банку контрагента

bank
string or null <= 255

банк, в якому відкрито рахунок

iban
string or null <iban> ^UA\d{8}[A-Z0-9]{19}$

номер банківського рахунку

phone
string or null <phone>

корпоративний номер телефону

email
string or null <email>

корпоративна пошта

is_terrorist
boolean or null

додати ознаку "терорист"

has_sanctions
boolean or null

додати ознаку "має санкції"

Responses

Request samples

Content type
application/json
Example
{
  • "name": "ТОВ Аметист",
  • "property_form_id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
  • "state_id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
  • "status_id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
  • "state_registration_date": "2013-04-01",
  • "state_registration_number": "10234020000011234",
  • "postal_code": "03000",
  • "city": "місто Київ",
  • "address": "Україна, 03000, місто Київ",
  • "mfo": "123456",
  • "bank": "АТ «Банк»",
  • "iban": "UA123405670000000026001234567",
  • "phone": "+380440000000",
  • "email": "[email protected]",
  • "is_terrorist": false,
  • "has_sanctions": true
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Переглянути картку контрагента

Використовуйте цей ресурс щоб ознайомитися із деталями конкретного контрагента. В параметрах шляху не забудьте передати унікальний ідентифікатор.

Authorizations:
bearerAuth
path Parameters
id
required
string

унікальний ідентифікатор контрагента

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Видалити картку контрагента

Використовуючи цей ресурс, можна видалити контрагента із системи. В параметрах шляху потрібно передати ID контрагента, якого бажаєте видалити. Відповідь 204 означатиме успішне видалення.

Authorizations:
bearerAuth
path Parameters
id
required
string

унікальний ідентифікатор контрагента

Responses

Response samples

Content type
application/problem+json
{
  • "message": "Unauthenticated."
}

Відновити картку контрагента

З використанням цього ресурсу можна відновити попередньо видалену картку контрагента. Після відновлення, вона знову з'явиться в системі AML.point. Обов'язково в параметрах шляху передавайте ID контрагента, якого потрібно відновити.

Authorizations:
bearerAuth
path Parameters
id
required
string

унікальний ідентифікатор контрагента

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Договори

За допомогою ресурсів цієї функціональності, ви зможете керувати договорами. В AML.point кожен договір має окрему картку, де вказані головні його деталі. Тут містяться дані про ПІБ керівника компанії контрагента, номер договору, дата його укладення, його тип, деталі здійснення платежу. Реальний документ договору з печатками та підписами завантажується в систему AML.point в картку договору.

Створити картку договору

Використовуйте цей ресурс для створення договору. В параметрах шляху вкажіть ID контрагента, договір з яким потрібно створити. В тілі запиту необхідно передати основні деталі договору.

Authorizations:
bearerAuth
path Parameters
id
required
string

унікальний ідентифікатор контрагента

Request Body schema: application/json
issued_date
required
string <date-time>

дата укладання договору

number
required
string <= 255

номер договору

type_id
required
string <uuid>

унікальний ідентифікатор типу договору (див. довідник)

internal_fee
number or null <float>

внутрішня комісія

internal_fee_comment
string or null <= 255

коментар до внутрішньої комісії

external_fee
number or null <float>

зовнішня комісія

external_fee_comment
string or null <= 255

коментар до зовнішньої комісії

payment_destination_note
string or null <= 255

опис коду призначення платежу

payout_destination_note
string or null <= 255

опис коду призначення виплати

state_id
string or null <uuid>

унікальний ідентифікатор статусу договору (див. довідник)

payout_period_id
string or null <uuid>

унікальний іддентифікатор періоду виплати (див. довідник)

payment_destination_code_id
required
string or null <uuid>

унікальний ідентифікатор коду призначення платежу - F108 (див. довідник)

параметр обов'язкий для договорів з операціями на прийом коштів

payment_iban
required
string or null <iban> ^UA\d{8}[A-Z0-9]{19}$

рахунок платежу

параметр обов'язкий для договорів з операціями на прийом коштів

payout_destination_code_id
required
string or null <uuid>

унікальний ідентифікатор коду призначення виплати - F108 (див. довідник)

параметр обов'язкий для договорів з операціями на виплату коштів

payout_iban
required
string or null <iban> ^UA\d{8}[A-Z0-9]{19}$

рахунок виплати

параметр обов'язкий для договорів з операціями на виплату коштів

auto_payout
boolean or null

Дозволити автоматичне формування виплат

last_name
string or null <= 255

прізвище

first_name
string or null <= 255

ім’я

middle_name
string or null <= 255

по-батькові

ceo_type
string or null

унікальний ідентифікатор типу директора (див. довідник)

ceo
string or null <= 255

директор

Responses

Request samples

Content type
application/json
{
  • "issued_date": "2022-07-20",
  • "number": "1234",
  • "type_id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
  • "payment_destination_code_id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
  • "payout_destination_code_id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
  • "payment_iban": "UA012345000000000000001234567",
  • "payout_iban": "UA012345000000000000001234567",
  • "last_name": "Тарасенко",
  • "first_name": "Тарас",
  • "middle_name": "Тарасович",
  • "ceo_type": "legal-entity",
  • "ceo": "Тарасенко Тарас Тарасович"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Оновити картку договору

Цей ресурс дозволяє оновити договір. Наприклад, можна змінити ПІБ керівника компанії-контрагента, платіжний метод, % комісії за надання послуг. В параметрах шляху необхідно передавати ID договору, який бажаєте оновити, а в тілі запиту вказувати нові деталі договору.

Authorizations:
bearerAuth
path Parameters
id
required
string

унікальний ідентифікатор договору

Request Body schema: application/json
issued_date
required
string <date-time>

дата укладання договору

internal_fee
required
number or null <float>

внутрішня комісія

internal_fee_comment
string or null <= 255

коментар до внутрішньої комісії

external_fee
required
number or null <float>

зовнішня комісія

external_fee_comment
string or null <= 255

коментар до зовнішньої комісії

payment_destination_note
string or null <= 255

опис коду призначення платежу

payout_destination_note
string or null <= 255

опис коду призначення виплати

state_id
string or null <uuid>

унікальний ідентифікатор статусу договору (див. довідник)

payout_period
string or null <uuid>

унікальний іддентифікатор періоду виплати (див. довідник)

payment_methods
Array of arrays or null or null

унікальний ідентифікатор платіжних методів (див. довідник)

last_name
string or null <= 255

прізвище

first_name
string or null <= 255

ім’я

middle_name
string or null <= 255

по-батькові

ended_at
string <date-time>

дата закінчення договору

ceo_type
string or null

унікальний ідентифікатор типу директора (див. довідник)

ceo
string or null <= 255

директор

Responses

Request samples

Content type
application/json
{
  • "issued_date": "2022-06-13",
  • "internal_fee": "1.0",
  • "internal_fee_comment": null,
  • "external_fee": "2.1",
  • "external_fee_comment": null,
  • "payment_destination_note": null,
  • "payout_destination_note": null,
  • "state_id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
  • "payout_period_id": "0ca00000-a000-000e-0d0f-0d0d00bab000",
  • "payment_methods": [
    ],
  • "last_name": "Тарасенко",
  • "first_name": "Ігор",
  • "middle_name": "Павлович",
  • "ceo_type": "legal-entity",
  • "ceo": "Тарасенко Ігор Павлович"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Переглянути картку договору

Цей ресурс повертає картку договору з усіма його деталями. В параметрах шляху не забудьте передати ID договору, інформація про який вас цікавить.

Authorizations:
bearerAuth
path Parameters
id
required
string

унікальний ідентифікатор договору

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Видалити картку договору

Якщо виникла необхідність видалити договір, то таку дію можна зробити за допомогою цього ресурсу. Після видалення, контракт більше не буде відображатися в системі AML.point. В параметрах шляху необхідно передавати ID договору. Відповідь 204 означатиме успішне видалення договору.

Authorizations:
bearerAuth
path Parameters
id
required
string

унікальний ідентифікатор договору

Responses

Response samples

Content type
application/problem+json
{
  • "message": "Unauthenticated."
}

Відновити картку договору

Цей ресурс дозволяє відновити договір, що був попередньо видалений з системи AML.point. В параметрах шляху потрібно передавати ID договору, який бажаєте відновити.

Authorizations:
bearerAuth
path Parameters
id
required
string

унікальний ідентифікатор договору

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Операції

Ця функціональність АРІ використовується для реєстрації фінансових операцій в системі AML.point. Необхідно реєструвати успішні платежі прийому та виплат коштів, а також ті, що були заблоковані внаслідок приналежності власника карти до списку терористів, підсанкційних чи публічних осіб. Ресурси цього АРІ отримують інформацію про операції з платіжних провайдерів та передають в систему AML.point. Тут можна переглянути ідентифікаційні дані отримувача та платника, суму операцій, платіжний метод, призначення платежу, ІР тощо. В існуючу операцію є можливість внесення змін. Інформація про операції є основою фінансового моніторингу та подання звітності до НБУ.

Зареєструвати успішну операцію

Цей ресурс дозволяє реєструвати в системі нові успішні фінансові операції, згідно з договором. Відповідь 202 означатиме, що дані прийняті в обробку і невдовзі операція буде зареєстрована в системі.

Authorizations:
bearerAuth
Request Body schema: application/json
paysystem_id
required
string <= 255

унікальний ідентифікатор операції у вашій системі

paysystem_name
required
string <= 255

назва платіжної системи

type
required
string
Enum: "registerPayment" "ptks" "cash" "epz" "other" "sdbo"

платіжні методи (див. довідник). Пояснення типів:

  • epz - електронний платіжний засiб;
  • sdbo - система дистанційного банківського обслуговування;
  • ptks - програмно-технічний комплекс самообслуговування;
  • registerPayment - реєстрові платежі (безнал + реестр);
  • cash - готівка;
  • other - інший учасник платіжної системи.
terminal_id
string or null <= 100

віртуальний ID терміналу банку

terminal_name
required
string <= 100

назва віртуального терміналу банку

auth_code
string or null <= 100

код авторизації операції, отриманий від банку

registry_reference_number
string or null <= 100

РРН-код операції, отриманий від банку

mcc
string or null <= 4

код категорії мерчанта або mcc-терміналу, по якому пройшла операція

required
OperationCard (object) or OperationContract (object)

узагальнений об'єкт, що відображає деталі платника

required
OperationCard (object) or OperationContract (object) or OperationFinancialModel (object)

узагальнений об'єкт, що відображає деталі отримувача

amount
required
number <float>

загальна сума операції (включно із комісією)

original_amount
required
number <float>

сума платежу

payout_amount
number <float>

сума виплати/відшкодування мерчанту

fee_external_amount
number <float>

зовнішня комісія

fee_internal_amount
number <float>

внутрішня комісія

currency
required
string
Value: "UAH"

валюта операції

initiator_ip
string <ip>

ІР, з якого операція була проведена

initiator_email
string <email>

пошта платника в системі, де він створює платіж

initiator_account_number
string <= 100

ідентифікатор платника в системі, де він створює платіж

order_description
required
string <= 1024

призначення платежу

received_at
string <date-time>

дата та час взаєморозрахунку з банком

processed_at
required
string <date-time>

дата та час коли операція отримала фінальний статус в платіжній системі, де вона проводилася

country
string
Value: "UKR"

код країни, де була випущена карта платника

payee_is_public
boolean

приналежність отримувача до публічних осіб

payer_is_public
boolean

приналежність платника до публічних осіб

Responses

Request samples

Content type
application/json
{
  • "paysystem_id": "paysystem_operation_abc_1",
  • "paysystem_name": "amlsystem",
  • "type": "epz",
  • "terminal_id": "terminal_abc_2",
  • "terminal_name": "The terminal name",
  • "auth_code": "A0901",
  • "registry_reference_number": "11111111112",
  • "mcc": "9876",
  • "payer": {
    },
  • "payee": {
    },
  • "amount": 999999.99,
  • "original_amount": 999999.99,
  • "fee_external_amount": 999999.99,
  • "fee_internal_amount": 999999.99,
  • "payout_amount": 999999.99,
  • "currency": "UAH",
  • "initiator_ip": "1.1.1.1",
  • "initiator_email": "[email protected]",
  • "initiator_account_number": "307546162244",
  • "order_description": "Invoice for the order #78453.",
  • "received_at": "2022-06-08T11:18:51+0000",
  • "processed_at": "2022-06-08T11:18:51+0000",
  • "country": "UKR",
  • "payee_is_public"": true,
  • "payer_is_public"": false
}

Response samples

Content type
application/problem+json
{
  • "code": 400,
  • "description": {
    }
}

Оновити операцію

Використовуйте цей ресурс щоб внести зміни в існуючу операцію. В тілі запиту передавайте ті дані, які бажаєте оновити. Відповідь 202 означатиме, що дані прийняті в обробку і невдовзі операція буде оновлена.

Authorizations:
bearerAuth
Request Body schema: application/json
paysystem_id
required
string <= 255

унікальний ідентифікатор операції у вашій системі

amount
number <float>

загальна сума операції (включно з комісією)

original_amount
number <float>

сума платежу

payout_amount
number <float>

сума виплати/відшкодування мерчанту

fee_external_amount
number <float>

зовнішня комісія

fee_internal_amount
number <float>

внутрішня комісія

currency
string
Value: "UAH"

валюта операції

received_at
string

дата та час формування операції

Responses

Request samples

Content type
application/json
{
  • "paysystem_id": "paysystem_operation_abc_1",
  • "amount": 999999.99,
  • "original_amount": 999999.99,
  • "fee_external_amount": 999999.99,
  • "fee_internal_amount": 999999.99,
  • "payout_amount": 999999.99,
  • "currency": "UAH",
  • "received_at": "2022-06-08T11:18:51+0000"
}

Response samples

Content type
application/problem+json
{
  • "code": 400,
  • "description": {
    }
}

Зареєструвати заблоковану операцію

Цей ресурс відповідає за реєстрацію операції, що була заблокована внаслідок приналежності особи до списку терористів, публічних чи підсанкційних осіб. Відповідь 202 означатиме, що дані прийняті в обробку і невдовзі операція буде зареєстрована в системі.

Authorizations:
bearerAuth
Request Body schema: application/json
paysystem_id
required
string <= 255

унікальний ідентифікатор операції у вашій системі

paysystem_name
required
string <= 255

назва платіжної системи

type
required
string
Enum: "registerPayment" "epz" "ptks" "cash" "other" "sdbo"

платіжні методи (див. довідник). Пояснення типів:

  • epz - електронний платіжний засiб;
  • sdbo - система дистанційного банківського обслуговування;
  • ptks - програмно-технічний комплекс самообслуговування;
  • registerPayment - реєстрові платежі (безнал + реестр);
  • cash - готівка;
  • other - інший учасник платіжної системи.
terminal_name
required
string <= 100

назва віртуального терміналу банку

required
OperationCard (object) or OperationContract (object)

узагальнений об'єкт, що відображає деталі платника

required
OperationCard (object) or OperationContract (object) or OperationFinancialModel (object)

узагальнений об'єкт, що відображає деталі отримувача

amount
required
number <float>

загальна сума операції (включно із комісією)

currency
required
string
Value: "UAH"

валюта операції

initiator_ip
string <ip>

ІР, з якого операція була проведена

initiator_email
string <email>

пошта платника в системі, де він створює платіж

initiator_account_number
string <= 100

ідентифікатор платника в системі, де він створює платіж

order_description
required
string <= 1024

примітка

reason
required
string <= 1000

причина блокування операції

processed_at
required
string <date-time>

дата та час коли операція отримала фінальний статус в платіжній системі, де вона проводилася

Responses

Request samples

Content type
application/json
{
  • "paysystem_id": "paysystem_operation_abc_1",
  • "paysystem_name": "amlsystem",
  • "type": "epz",
  • "terminal_name": "The terminal name.",
  • "payer": {
    },
  • "payee": {
    },
  • "amount": 999999.9999,
  • "currency": "UAH",
  • "initiator_ip": "1.1.1.1",
  • "initiator_email": "[email protected]",
  • "initiator_account_number": "307546162244",
  • "order_description": "Invoice for the order #78453.",
  • "reason": "Match with RNBOU list.",
  • "processed_at": "2022-06-08T11:18:51+0000"
}

Response samples

Content type
application/problem+json
{
  • "code": 400,
  • "description": {
    }
}

Довідники

Для зручної систематизації та класифікації різних об'єктів АРІ, в системі AML.point створені довідники двох видів:

  • внутрішні – розроблені для опису значень внутрішніх параметрів. Наприклад, типів платіжних систем, форм власності, юридичних станів, організаційно-правових форм, статусів договору;

  • зовнішні – дублюють значення параметрів з довідників НБУ F108 та H020, що використовуються для подання статистичної звітності.

По суті, кожен довідник – це окремий об'єкт певного ресурсу з масивом можливих значень. Для роботи з довідниками доступний лише метод GET.

Переглянути довідник типів фінансових послуг

Цей ресурс повертає список кодів фінансових послуг відповідно до довідника H020. Отримані значення із цього довідника використовують для подання статистичної звітності до НБУ.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Переглянути довідник типів контрагентів

Ресурс повертає список юридичних типів контрагента.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Переглянути довідник форм власності

Використовуйте цей ресурс, щоб переглянути форми власності контрагента. Довідник актуальний для юридичних осіб.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Переглянути довідник статусів ділових відносин

Ресурс дозволяє переглянути статус ділових відносин контрагента.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Переглянути довідник юридичних станів

За допомогою цього ресурсу, ви можете ознайомитися із можливими юридичними станами контрагента.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Переглянути довідник типів публічних осіб

Використовуючи цей ресурс, ви можете переглянути список типів публічних осіб.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Переглянути довідник типів документа

Використовуючи цей ресурс, ви отримаєте список можливих типів документа, що посвідчують особу.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Переглянути довідник статусів документа

Ресурс дозволяє переглянути статуси документа, що посвідчує особу.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Переглянути довідник статусів ідентифікації та верифікації контрагента

Цей ресурс дозволяє переглянути можливі статуси ідентифікації та верифікації контрагента.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Переглянути довідник систем оподаткування

Ресурс повертає список систем оподаткування контрагента.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Переглянути довідник видів діяльності

Ресурс дозволяє переглянути список видів діяльності контрагента.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Переглянути довідник рівнів ризику

Цей ресурс повертає список рівнів ризику контрагента.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Переглянути довідник оцінки відповідності фін.операцій контрагента змісту його діяльності

Ресурс повертає масив оцінок відповідності фінансових операцій контрагента змісту його діяльності.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Переглянути довідник оцінки відповідності фін.операцій контрагента його фінансовому стану

Ресурс повертає масив оцінок відповідності фінансових операцій контрагента його фінансовому стану.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Переглянути довідник типів договорів

Цей ресурс надає список можливих типів договорів.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Переглянути довідник статусів договору

Ресурс повертає список статусів договору.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Переглянути довідник кодів призначення платежу

Цей ресурс повертає масив кодів призначення платежу відповідно до довідника F108. Отримані значення із цього довідника використовують для подання звітності до НБУ.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Переглянути довідник періодів виплат

За допомогою цього ресурсу можна переглянути список можливих періодів виплат згідно з договором.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Переглянути довідник платіжних методів

Цей ресурс повертає масив можливих платіжних методів.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Переглянути довідник платіжних систем

Ресурс повертає масив видів платіжних систем.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}