Platix — платіжні посилання по IBAN для бізнесу

Початок роботи

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

1Перейдіть на сторінку реєстрації та заповніть ім'я, email і пароль.
2Після реєстрації ви потрапите в панель керування (дашборд).
3Додайте реквізити вашого бізнесу (ФОП або юридичної особи).
4Створіть перше платіжне посилання та поділіться ним з клієнтом.

Пароль має містити щонайменше 8 символів, включаючи велику літеру, малу літеру та цифру.

Головна панель Platix — Дашборд: огляд статистики та швидкі дії

Реквізити (Мерчанти)

Мерчант = реквізити вашого бізнесу (ФОП, ТОВ тощо), на які клієнти переказують оплату. Можна додати кілька мерчантів для різних напрямків.

Додавання мерчанта

1Перейдіть у розділ «Мої реквізити» в бічному меню.
2Натисніть «Додати реквізити».
3Заповніть обов'язкові поля: юридична назва, ЄДРПОУ (8 цифр) або РНОКПП (10 цифр), IBAN.
4Банк визначиться автоматично за IBAN. За потреби введіть назву банку вручну.
5Додатково можна вказати публічну назву, телефон, email, сайт.
6Натисніть «Зберегти».

Форма створення мерчанта — Форма додавання реквізитів бізнесу

Публічна назва видна клієнтам на сторінці оплати. Якщо не заповнити, буде використано юридичну назву.

Список мерчантів — Перелік ваших реквізитів

Платіжні посилання

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

Створення посилання

1Відкрийте «Посилання» і натисніть «Створити посилання».
2Оберіть мерчанта (якщо їх кілька).
3Вкажіть суму (грн) та опис платежу.
4За потреби додайте номер замовлення та дані клієнта.
5Оберіть тип посилання та натисніть «Створити».

Типи посилань

Тип	Опис
Одноразове	Посилання деактивується після першої оплати
Багаторазове	Необмежена кількість оплат (наприклад, для донатів)
З лімітом	Фіксована кількість оплат (наприклад, 10 квитків)

Розклад та термін дії

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

Поширення

Після створення ви отримаєте URL-адресу та QR-код. Поширюйте через:

Копіювання URL та надсилання в месенджерах
QR-код для друку або показу на екрані
Кнопки швидкого поширення: Telegram, Viber, WhatsApp
Вбудовування на сайт через embed-віджет

Посилання створено — Після створення: URL, QR-код та кнопки поширення

Статуси посилань

Статус	Значення
Активне	Посилання доступне для оплати
Оплачене	Одноразове посилання вже оплачено
Завершене	Термін дії закінчився
Скасоване	Посилання деактивовано вручну

Список посилань — Перелік посилань з фільтрацією за статусом

CRM дошка

CRM у форматі Kanban-дошки. Створюйте колонки, додавайте ліди та перетягуйте їх між етапами.

Основні можливості

Колонки: створюйте власні етапи (наприклад, «Нові», «В роботі», «Завершено»)
Ліди: додавайте контакти з іменем, телефоном, email
Drag & Drop: перетягуйте ліди між колонками
Теги: позначайте лідів для швидкої фільтрації
Нотатки: додавайте коментарі до кожного ліда
Кастомні поля: створюйте власні поля (текст, вибір, число)
Пошук: шукайте по імені, телефону чи email

CRM дошка — Kanban-дошка для управління клієнтами

При створенні платіжного посилання з CRM, дані клієнта (ім'я, телефон, email) підставляються автоматично.

Аналітика

Статистика по вашим посиланням та оплатам.

Що відстежується

Воронка конверсії: перегляди → ініціювання → завершені оплати
Графік виручки: динаміка надходжень за обраний період
Розподіл по банках: з яких банківських додатків оплачують клієнти
Топ посилань: найпопулярніші та найприбутковіші посилання

Використовуйте фільтр по датах для аналізу конкретних періодів.

Сторінка аналітики — Аналітика: воронка, графіки та розподіл по банках

Команда

Запрошуйте учасників і розподіляйте ролі з різним рівнем доступу.

Як запросити учасника

1Перейдіть у розділ «Команда».
2Натисніть «Запросити учасника».
3Введіть email та оберіть роль.
4Учасник отримає посилання для приєднання.

Ролі та дозволи

Роль	Посилання	CRM	Аналітика	Команда	Реквізити	API	Налаштування
Власник (Owner)	✓	✓	✓	✓	✓	✓	✓
Адміністратор	✓	✓	✓	✓	✓	✓	—
Менеджер	✓	✓	✓	—	—	—	—
Переглядач	—	—	✓	—	—	—	—

Ви не можете призначити роль вище або рівну вашій. Наприклад, Менеджер може запрошувати тільки Переглядачів.

Управління командою — Учасники команди та їхні ролі

Налаштування

У розділі налаштувань ви можете змінити профіль, пароль та переглянути інформацію про ваш план.

Профіль

Змінюйте ваше ім'я, яке відображається в панелі та для учасників команди.

Безпека

Для зміни пароля введіть поточний пароль та новий. Вимоги до пароля:

Мінімум 8 символів
Хоча б одна велика літера (A-Z)
Хоча б одна мала літера (a-z)
Хоча б одна цифра (0-9)

Після зміни пароля всі інші сеанси (на інших пристроях) будуть завершені автоматично.

Налаштування — Профіль, безпека та інформація про план

Віджет оплати (Embed)

Вбудуйте форму оплати на ваш сайт через iframe. Клієнти оплачують прямо на вашому сайті.

Налаштування

1Перейдіть в редагування мерчанта.
2Увімкніть опцію «Дозволити embed».
3Вкажіть дозволені домени (ваш сайт) через кому.
4Скопіюйте код для вставки на ваш сайт.

Код для вставки

html

<iframe
  src="https://platix.online/embed/ВАШ_SHORTCODE"
  width="100%"
  height="600"
  frameborder="0"
  style="border: none; border-radius: 12px;">
</iframe>

JavaScript події

Віджет надсилає повідомлення батьківському вікну через postMessage:

Подія	Опис
platix:loaded	Віджет завантажено
platix:resize	Змінилась висота (для адаптивного iframe)
platix:payment:initiated	Клієнт почав процес оплати

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

Сторінка оплати

Коли клієнт переходить за платіжним посиланням, він бачить публічну сторінку оплати з реквізитами та QR-кодом.

Що бачить клієнт

Назва вашого бізнесу (публічна назва мерчанта)
Сума та опис платежу
QR-код для сканування банківським додатком
Реквізити для ручного введення: IBAN, отримувач, ЄДРПОУ, призначення
Кнопки копіювання для кожного поля

Брендування

Налаштуйте зовнішній вигляд сторінки оплати в редагуванні мерчанта:

Основний колір: колір кнопок та акцентів
Фон: колір фону сторінки
QR-код: стиль (квадратний, округлений, точковий), кольори
Текст у футері: довільний текст під формою оплати

Публічна сторінка оплати — Так бачить сторінку оплати ваш клієнт

REST API

Огляд API

Platix REST API дозволяє програмно створювати платіжні посилання, отримувати дані про оплати та управляти мерчантами. Інтегруйте з CRM, сайтом або Telegram-ботом.

Base URL

https://platix.online

Аутентифікація

Кожен запит до API має містити заголовки X-Api-Key та X-Api-Secret. Ключі можна згенерувати у розділі API панелі керування.

bash

curl https://platix.online/api/payment-links \
  -H "X-Api-Key: pk_live_ваш_ключ" \
  -H "X-Api-Secret: sk_live_ваш_секрет"

API Secret показується лише один раз при генерації або регенерації ключів. Зберігайте його у безпечному місці. Ніколи не передавайте Secret у клієнтському коді.

Платіжні посилання

Створити посилання

POST /api/payment-links

Параметр	Тип	Опис
merchantId *	string	ID мерчанта (реквізитів)
amount *	number	Сума (1 - 999 999.99 грн)
description *	string	Призначення платежу (3–200 символів)
orderNumber	string?	Номер замовлення (до 50 символів)
activatesAt	string?	Дата активації (ISO 8601)
expiresAt	string?	Дата закінчення (ISO 8601)
maxPayments	number?	Максимум оплат за посиланням
clientName	string?	ПІБ клієнта
clientPhone	string?	Телефон клієнта (+380XXXXXXXXX)
clientEmail	string?	Email клієнта
metadata	object?	Довільні дані (JSON)

bash

curl -X POST https://platix.online/api/payment-links \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: pk_live_ваш_ключ" \
  -H "X-Api-Secret: sk_live_ваш_секрет" \
  -d '{
    "merchantId": "clx...",
    "amount": 1500,
    "description": "Замовлення №42",
    "orderNumber": "ORD-42"
  }'

Відповідь (201)

json

{
  "paymentLink": {
    "id": "clx...",
    "shortCode": "b7g2k9",
    "amount": "1500",
    "description": "Замовлення №42",
    "status": "ACTIVE",
    "url": "https://platix.online/pay/b7g2k9",
    "qrCodeUrl": "https://platix.online/api/qr/b7g2k9",
    "createdAt": "2026-03-12T10:00:00.000Z"
  }
}

Список посилань

GET /api/payment-links

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

Параметр	Тип	Опис
page	number?	Сторінка (за замовчуванням 1)
limit	number?	Кількість на сторінці (за замовчуванням 20, макс. 100)
status	string?	Фільтр за статусом: ACTIVE, PAID, EXPIRED, CANCELLED
search	string?	Пошук за описом або номером замовлення
merchantId	string?	Фільтр за мерчантом

bash

curl "https://platix.online/api/payment-links?status=ACTIVE&limit=10" \
  -H "X-Api-Key: pk_live_ваш_ключ" \
  -H "X-Api-Secret: sk_live_ваш_секрет"

Деталі посилання

GET /api/payment-links/:id

Повертає повну інформацію про платіжне посилання включно з історією оплат. Доступний лише через JWT авторизацію (панель керування).

Змінити статус

PATCH /api/payment-links/:id

Змінює статус посилання. Дозволені переходи: ACTIVE → PAID, EXPIRED, CANCELLED. Доступний лише через JWT авторизацію (панель керування).

json

{ "status": "CANCELLED" }

Видалити посилання

DELETE /api/payment-links/:id

М'яке видалення: змінює статус на CANCELLED та скасовує всі активні оплати. Доступний лише через JWT авторизацію (панель керування).

Оплати

Список оплат

GET /api/payments

Повертає список оплат з пагінацією та фільтрами. Включає дані про пов'язане платіжне посилання.

Параметр	Тип	Опис
page	number?	Сторінка (за замовчуванням 1)
limit	number?	Кількість на сторінці (за замовчуванням 20)
status	string?	Фільтр: PENDING, PROCESSING, COMPLETED, FAILED, CANCELLED
dateFrom	string?	Дата початку (ISO 8601)
dateTo	string?	Дата закінчення (ISO 8601)
merchantId	string?	Фільтр за мерчантом
search	string?	Пошук за інфо платника, описом, номером замовлення

bash

curl "https://platix.online/api/payments?status=COMPLETED&limit=50" \
  -H "X-Api-Key: pk_live_ваш_ключ" \
  -H "X-Api-Secret: sk_live_ваш_секрет"

Мерчанти

Управління бізнес-профілями. Кожен мерчант має окремий IBAN, ЄДРПОУ та набір API ключів.

Список мерчантів

GET /api/merchants

bash

curl https://platix.online/api/merchants \
  -H "X-Api-Key: pk_live_ваш_ключ" \
  -H "X-Api-Secret: sk_live_ваш_секрет"

Деталі мерчанта

GET /api/merchants/:id

Повертає повну інформацію про мерчанта включно з налаштуваннями брендування.

Оновити мерчанта

PUT /api/merchants/:id

Часткове оновлення даних мерчанта. Можна передати будь-яке поле окремо.

Параметр	Тип	Опис
legalName	string?	Юридична назва
publicName	string?	Публічна назва (видно клієнтам)
edrpou	string?	ЄДРПОУ / РНОКПП
iban	string?	IBAN рахунку
bankName	string?	Назва банку
phone	string?	Контактний телефон (+380XXXXXXXXX)
email	string?	Контактний email
website	string?	URL вебсайту
branding	object?	Налаштування брендування (див. розділ Брендування)
embedEnabled	boolean?	Дозволити вбудовування через iframe
embedAllowedDomains	string?	Дозволені домени для iframe (через кому)

Генерація / регенерація ключів

POST /api/merchants/:id/regenerate-keys

Генерує нову пару API Key + Secret. Якщо ключі вже існують, старі деактивуються одразу. Доступний лише через панель керування (JWT авторизація).

Брендування

Кастомізуйте зовнішній вигляд сторінки оплати та QR-кодів під ваш бренд. Передайте об'єкт branding при оновленні мерчанта.

Параметр	Тип	Опис
primaryColor	string?	Основний колір бренду (#RRGGBB), за замовч. #2b878a
backgroundColor	string?	Колір фону сторінки оплати (#RRGGBB)
buttonRadius	string?	Форма кнопок: 'rounded' або 'square'
footerText	string?	Текст у футері сторінки оплати (до 100 символів)
qrForegroundColor	string?	Колір точок QR-коду (#RRGGBB)
qrBackgroundColor	string?	Колір фону QR-коду (#RRGGBB)
qrTransparentBg	boolean?	Прозорий фон QR-коду (за замовч. false)
qrLogoOverlay	boolean?	Накладання лого на QR-код (за замовч. false)
qrStyle	string?	Стиль точок QR: 'square', 'rounded' або 'dots'
qrCaption	string?	Підпис під QR-кодом (до 60 символів)

bash

curl -X PUT https://platix.online/api/merchants/clx... \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: pk_live_ваш_ключ" \
  -H "X-Api-Secret: sk_live_ваш_секрет" \
  -d '{
    "branding": {
      "primaryColor": "#FF6600",
      "qrStyle": "dots",
      "qrForegroundColor": "#FF6600",
      "qrCaption": "Скануйте для оплати",
      "footerText": "Дякуємо за покупку!"
    }
  }'

QR-коди

Для кожного платіжного посилання автоматично доступний QR-код. Не потребує аутентифікації. Можна вставляти на сайт або друкувати.

Отримати QR-код

GET /api/qr/:shortCode

Параметр	Тип	Опис
format	string?	Формат: 'png' (за замовч.) або 'svg'
size	number?	Розмір у пікселях (100–1000, за замовч. 300)
fg	string?	Колір точок (hex без #, наприклад ff6600)
bg	string?	Колір фону (hex без #, наприклад ffffff)
style	string?	Стиль точок: 'square', 'rounded' або 'dots' (тільки SVG)
type	string?	'nbu': QR з реквізитами у форматі НБУ (BCD/UCT)

text

# Стандартний QR (посилання на сторінку оплати)
PNG: https://platix.online/api/qr/{shortCode}
SVG: https://platix.online/api/qr/{shortCode}?format=svg

# Кольоровий QR з округленими точками
https://platix.online/api/qr/{shortCode}?format=svg&fg=2b878a&style=rounded&size=500

# NBU QR для банківських додатків (Приват24, monobank, Sense, ПУМБ)
https://platix.online/api/qr/{shortCode}?type=nbu
https://platix.online/api/qr/{shortCode}?type=nbu&format=svg&style=dots

NBU QR: Формат BCD/002/1/UCT, стандарт НБУ для переказів. QR містить IBAN, отримувача, суму та призначення. Підтримується основними банківськими додатками в Україні. Якщо у мерчанта налаштовано брендування, кольори QR застосовуються автоматично.

Аналітика

Ендпоінти аналітики для отримання статистики та звітів. Доступні лише через JWT авторизацію (панель керування).

Загальна статистика

GET /api/analytics/overview

Повертає агреговану статистику: кількість посилань, оплат, переглядів, конверсію та суму.

Параметр	Тип	Опис
dateFrom	string?	Початок періоду (ISO 8601)
dateTo	string?	Кінець періоду (ISO 8601)
merchantId	string?	Фільтр за мерчантом

Графік доходу

GET /api/analytics/revenue-chart

Дані для побудови графіку доходу за день. Підтримує фільтрацію за періодом.

Параметр	Тип	Опис
days	number?	Кількість днів (7, 30, 90; за замовч. 30)
dateFrom	string?	Початок довільного періоду (ISO 8601)
dateTo	string?	Кінець довільного періоду (ISO 8601)

Воронка конверсій

GET /api/analytics/funnel

Повертає дані воронки: перегляди → ініціювання оплати → завершені оплати.

Параметр	Тип	Опис
dateFrom	string?	Початок періоду (ISO 8601)
dateTo	string?	Кінець періоду (ISO 8601)

Розподіл по банках

GET /api/analytics/by-bank

Топ посилань

GET /api/analytics/top-links

Остання активність

GET /api/analytics/recent-activity

Коди помилок

API повертає помилки у стандартному форматі:

json

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Мінімальна сума: 1.00 грн"
  }
}

HTTP	Код	Опис
400	VALIDATION_ERROR	Невалідні дані запиту
401	UNAUTHORIZED	Відсутній або невалідний API ключ
403	FORBIDDEN	Немає доступу до ресурсу
404	NOT_FOUND	Ресурс не знайдено
409	CONFLICT	Конфлікт (дублікат)
422	INVALID_TRANSITION	Невалідний перехід статусу
429	RATE_LIMIT	Перевищено ліміт запитів
500	INTERNAL_ERROR	Внутрішня помилка сервера

Ліміти запитів

Для захисту від зловживань API обмежує кількість запитів:

Ендпоінт	Ліміт	Вікно
POST /api/payment-links	100 запитів	1 хвилина
GET /api/payment-links	1000 запитів	1 хвилина
GET /api/payments	1000 запитів	1 хвилина
GET /api/merchants	1000 запитів	1 хвилина

При перевищенні ліміту API повертає 429 Too Many Requests.

Документація Platix

Початок роботи

Реквізити (Мерчанти)

Додавання мерчанта

Платіжні посилання

Створення посилання

Типи посилань

Розклад та термін дії

Поширення

Статуси посилань

CRM дошка

Основні можливості

Аналітика

Що відстежується

Команда

Як запросити учасника

Ролі та дозволи

Налаштування

Профіль

Безпека

Віджет оплати (Embed)

Налаштування

Код для вставки

JavaScript події

Сторінка оплати

Що бачить клієнт

Брендування

Огляд API

Аутентифікація

Платіжні посилання

Створити посилання

Список посилань

Деталі посилання

Змінити статус

Видалити посилання

Оплати

Список оплат

Мерчанти

Список мерчантів

Деталі мерчанта

Оновити мерчанта

Генерація / регенерація ключів

Брендування

QR-коди

Отримати QR-код

Аналітика

Загальна статистика

Графік доходу

Воронка конверсій

Розподіл по банках

Топ посилань

Остання активність

Коди помилок

Ліміти запитів