Перейти до вмісту

Мережі та токени

Перед створенням рахунку або депозиту оберіть мережу й токен з API. Самої назви токена недостатньо: запиту потрібна його адреса в цій мережі.

Прочитайте доступні мережі

Section titled “Прочитайте доступні мережі”
Terminal window
curl 'https://platform.invoise.me/api/v1/networks'

Використовуйте ці поля з кожної мережі:

Поле Призначення
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 відхиляє створення рахунку або депозиту в недоступній мережі чи на недоступному активі.

Solana і Tron потребують отримувача, заданого в магазині до першого рахунку. Див. Solana і Tron.

Мережі й токени змінюються через налаштування платформи. Читайте доступність, адреси та кількість знаків після коми з API під час вибору активу; не тримайте фіксований список.

minimum_payment — ціле число токенів, наприклад "1". Рахунок нижче цього значення повертає 400 amount_below_minimum. Обидва списки мереж повертають це значення. Воно відрізняється між мережами й може змінюватися, тож читайте його, а не зашивайте в код.

Суми платежів — це рядки цілих чисел у найменших одиницях токена:

Знаків після коми в токені 10 токенів у запиті
6 "10000000"
18 "10000000000000000000"

Не надсилайте "10.5". При 6 знаках після коми 10,5 токена — це "10500000". Для сум API використовуйте арифметику цілих чисел (BigInt у JavaScript); числа з рухомою комою можуть втрачати точність.

Один виняток: рахунок, що пропонує кілька токенів або мереж, приймає дробову суму токена, наприклад "10.5". Див. кілька токенів або мереж.

Читання комісій і порогів виплат

Section titled “Читання комісій і порогів виплат”
Terminal window
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".

Максимальна комісія — це не максимальна сума платежу. Тримайте комісії, суми рахунків і пороги депозитів окремо.