Мережі та токени
Перед створенням рахунку або депозиту оберіть мережу й токен з API. Самої назви токена недостатньо: запиту потрібна його адреса в цій мережі.
Прочитайте доступні мережі
Section titled “Прочитайте доступні мережі”curl 'https://platform.invoise.me/api/v1/networks'Якщо потрібні лише ціни, GET /api/v1/pricing повертає комісії, з яких новий мерчант починає в кожній мережі, реферальну знижку й ціни картки — у доларах. Він не потребує облікових даних, викликати його може будь-який сайт, а відповідь кешується на п’ять хвилин.
Використовуйте ці поля з кожної мережі:
| Поле | Призначення |
|---|---|
chain_id |
ID мережі. |
family |
solana або tron для цих мереж; відсутнє або evm для мереж EVM. |
tokens[].address |
адреса токена: контракт в EVM і Tron, mint у Solana. |
tokens[].decimals |
кількість знаків після коми. |
tokens[].status |
готовність, якщо присутнє. Для реальних платежів використовуйте активи зі статусом ready. |
minimum_payment |
найменша сума рахунку в цій мережі, у цілих токенах. |
Публічний каталог описує налаштовані мережі. У мерчанта може бути менший набір увімкнених мереж; перевіряйте GET /api/v1/merchants/{merchant_id}/networks під час налаштування із сесією або API-ключем магазину з правом read (ID мерчанта ключа є в GET /api/v1/me). API відхиляє створення рахунку або депозиту в недоступній мережі чи на недоступному активі.
Solana і Tron потребують отримувача, заданого в магазині до першого рахунку. Див. Solana і Tron.
Мережі й токени змінюються через налаштування платформи. Читайте доступність, адреси та кількість знаків після коми з API під час вибору активу; не тримайте фіксований список.
Мінімальний платіж
Section titled “Мінімальний платіж”minimum_payment — ціле число токенів, наприклад "1". Рахунок нижче цього значення повертає 400 amount_below_minimum. Обидва списки мереж повертають це значення. Воно відрізняється між мережами й може змінюватися, тож читайте його, а не зашивайте в код.
Форматування суми
Section titled “Форматування суми”Суми платежів — це рядки цілих чисел у найменших одиницях токена:
| Знаків після коми в токені | 10 токенів у запиті |
|---|---|
| 6 | "10000000" |
| 18 | "10000000000000000000" |
Не надсилайте "10.5". При 6 знаках після коми 10,5 токена — це "10500000". Для сум API використовуйте арифметику цілих чисел (BigInt у JavaScript); числа з рухомою комою можуть втрачати точність.
Один виняток: рахунок, що пропонує кілька токенів або мереж, приймає дробову суму токена, наприклад "10.5". Див. кілька токенів або мереж.
Стандартні комісії
Section titled “Стандартні комісії”Це загальні комісії, з якими починає новий мерчант; у різних мерчантів умови можуть відрізнятися, тож свої отримуйте з API (нижче). Комісія — 0,5% від кожного рахунку або кожної виплати депозиту, але не менше за мінімальну комісію мережі й не більше $10. Мінімум покриває газ на вашу виплату.
| Мережа | Комісія | Мінімальна комісія | Максимальна комісія | Мінімальний платіж |
|---|---|---|---|---|
| Ethereum | 0,5% | $1 | $10 | $10 |
| Arbitrum | 0,5% | $0,05 | $10 | $1 |
| Base | 0,5% | $0,03 | $10 | $1 |
| Optimism | 0,5% | $0,03 | $10 | $1 |
| Polygon | 0,5% | $0,05 | $10 | $1 |
| BNB Chain | 0,5% | $0,05 | $10 | $1 |
| Avalanche | 0,5% | $0,02 | $10 | $1 |
| Solana | 0,5% | $1 | $10 | $2 |
| Tron | 0,5% | $4,50 | $10 | $10 |
Наприклад, $100 у Base коштують $0,50, $4 — мінімальні $0,03, а $5 000 — $10 замість $25.
Мерчант, який прийшов за реферальним посиланням, починає з 0,49%. У мерчанта лишаються комісії, з якими його створено, а Invoise може призначити індивідуальні умови, тож читайте умови свого магазину з API, як показано нижче.
Читання комісій і порогів виплат
Section titled “Читання комісій і порогів виплат”curl 'https://platform.invoise.me/api/v1/shops/{shop_id}/terms' \ -H 'Authorization: Bearer ivk_...'Відповідь перелічує умови для кожної мережі:
| Поле | Призначення |
|---|---|
invoice і deposit |
налаштування комісії: bps, minimum, maximum. |
sweep_threshold |
скільки потрібно на депозиті, перш ніж заплановано виплату. |
minimum_sweep і maximum_sweep |
заявлений діапазон для цього налаштування. |
bps означає соті частки відсотка: 50 bps = 0,5%. minimum і maximum комісії використовують вісімнадцятизнакові одиниці незалежно від кількості знаків токена; 10000000000000000 означає комісію 0,01 токена. sweep_threshold — сума токена в зручному для читання вигляді, наприклад "1". Щоб змінити поріг, надішліть PATCH /api/v1/shops/{shop_id} з {"sweep_thresholds":{"<chain_id>":"25"}} у межах minimum_sweep і maximum_sweep цієї мережі; значення поза ними повертає 400 invalid_sweep_threshold.
Максимальна комісія — це не максимальна сума платежу. Тримайте комісії, суми рахунків і пороги депозитів окремо.