# Ваше API

### Опис

Ваша платіжна система (баланс, за умовчанням VU-Money USD) підтримує роботу через власне API.

Це ж стосується і всіх додаткових валют балансу, які ви створите.

***

### **Доступні функції**

**Invoice** - операція з виставлення рахунку. Користувач отримує посилання на оплату згенерованого рахунку (інвойсу).

**Callback** - функція повідомлень про оплату інвойсу. Відправляє деталі оплаченого інвойсу на URL, вказаний під час його створення.

**Withdraw** - операція з виплат. В автоматичному режимі здійснює переведення з балансу користувача на вказані реквізити.

**Details** - операція з отримання деталей транзакції або інвойсу.

**Balances** - операція з отримання поточних балансів користувача.

**Ticker** - публічна операція (що не вимагає ключів API), що видає курси з усіх активних напрямків у форматі json.

**Code create** - операція створення коду.

**Code apply** - операція погашення коду.

**Code get** - операція отримання деталей коду.

***

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

Перше, що потрібно зробити, - включити саму API. Це можна зробити тут: Обмін валют - Налаштування модуля - Статус API балансу

Поруч із цим налаштуванням є друге: "Статус функції Виставлення рахунку". Якщо вимкнено, в API буде недоступна операція Invoice.

Друге - налаштування груп. Необхідно активувати "Дозволяти використання API" для всіх груп користувачів, яким ви хочете це дозволити.

Далі - баланси та напрямки. Додайте та налаштуйте всі необхідні валюти балансів (додавання платіжної системи з API "balance").

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

Налаштуйте типи обмінів: автоматичний обов'язковий для виплат (withdraw), виставлення рахунку для invoice.

Увімкніть усі потрібні напрямки, типи в них та налаштуйте курси.

Ви можете налаштовувати напрямки між однією і тією ж платіжною системою для операції invoice.

API враховує всі зазначені комісії.

Якщо ви використовуєте напрямки, для яких обов'язкова верифікація картки - операція withdraw буде видавати помилки при спробі виплати на не верифіковану картку (Card is not verified).

Ви можете вимкнути перевірку верифікації для певної групи користувачів (Опція: "Обов'язкова верифікація платіжної картки").

***

### **Робота API**

Документація вашої API доступна за адресою: **<https://ваш\\_сайт/api/docs>**

У документації автоматично підставляються адреси до вашої API та коди платіжних систем.

Перевірте розділ документації "Коди платіжних систем", щоб переконатися в правильному їх налаштуванні.

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

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

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

Для використання API користувачі повинні згенерувати ключі API. Це можна зробити лише на панелі користувача.

Через адмінку ви можете лише переглядати список відкритих ключів (секретні завжди приховані та закодовані) та видаляти їх (Додатково - API ключі).

Для всіх запитів до API пишуться логи. Якщо виникають проблеми з його роботою, використовуйте логи для пошуку причин (Додатково - Логи API).
