Вступ

Switch to English

Ласкаво просимо до документації Ukrcard APIs!

Ця документація містить технічну інформацію для інтеграції з API-сервісами УКРКАРТ, зокрема для виконання платіжних операцій, а також для роботи з картками, рахунками та пов’язаними сервісами.

З чого почати

Якщо ви вперше інтегруєтесь із сервісами УКРКАРТ, рекомендуємо почати з розділу "Початок роботи".

У ньому описано загальний процес інтеграції:
▪️ первинне узгодження бізнесових і технічних параметрів;
▪️ робота з пісочницею або Mock-середовищем;
▪️ інтеграційне тестування у тестовому середовищі;
▪️ підготовка до продуктивного запуску;
▪️ перехід до продуктивного середовища;
▪️ вимоги безпеки та PCI DSS.

Напрями інтеграції

Документація UKRCARD охоплює декілька основних напрями інтеграції:

WSGATE (Payments API) - REST API для інтеграції з платіжними сервісами УКРКАРТ.

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

У розділі "WSGATE (Payments API)" наведено опис методів API, форматів запитів і відповідей, параметрів інтеграції, кодів відповідей та рекомендацій щодо обробки операцій.

UAPI (Cards & Accounts API) - REST API для інтеграції з картковими та рахунковими сервісами процесингового центру УКРКАРТ.

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

У розділі "UAPI (Cards & Accounts API" наведено опис доступних методів, форматів запитів і відповідей, а також особливостей інтеграції.

Середовища інтеграції

Залежно від API та погодженого сценарію інтеграції можуть використовуватися такі середовища:

Середовище	Призначення
Mock / Пісочниця	Первинне ознайомлення зі структурою API та перевірка базової логіки інтеграції
Sandbox / Тестове середовище	Повноцінне інтеграційне тестування в умовах, наближених до продуктивного середовища
Live / Продуктивне середовище	Виконання реальних операцій після завершення тестування та погодження готовності

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

Підключення та безпека

Усі API UKRCARD використовують захищену взаємодію через HTTPS і клієнтську сертифікатну автентифікацію.

Параметри підключення, URL сервісів, порядок використання сертифікатів і доступні мережеві канали можуть відрізнятися залежно від API.

Детальна інформація щодо підключення наведена у відповідному розділі документації:

WSGATE (Payments API) → Підключення та mTLS-сертифікати;
UAPI (Cards & Accounts API) → Підключення та mTLS-сертифікати.

Додаткові матеріали

У документації відповідного напрямку API також доступні:

▪️ опис методів;
▪️ приклади запитів і відповідей;
▪️ рецепти інтеграції;
▪️ довідники кодів відповідей;
▪️ рекомендації щодо обробки webhook / callback-повідомлень.

Продукти по напрямках

	E-Commerce Еквайрингактивно Повністю контролюйте процес оформлення замовлення, для прийому платежів. Колекція Postman > Довідник API > Завантажити PDF документацію >
	Грошові переказиактивно Ми надаємо різні варіанти переказів коштів між платіжними картками та рахунками всередині країни та за картками, що емітовані банками різних країн. Колекція Postman > Довідник API > Завантажити PDF документацію >
	Платежі з цифрового гаманцявдосконалюється Ці методи дозволяють здійснювати платежі в Інтернеті без використання банківських карток, використовуючи цифрові гаманці як засіб платежу Колекція Postman > Довідник API > Завантажити PDF документацію >
	UAPI: Картки та рахункиактивно Керуйте життєвим циклом картки, та контролюйте використання карток та рахунків вашими клієнтами. Колекція Postman > Довідник API > Завантажити PDF документацію >
	Перекази SEPAу розробці сервіс для управління платежами по всій Європі. Колекція Postman > Довідник API > Завантажити PDF документацію >