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

Авторизація та обмеження

Як отримати API ключ Bitsby, передати його в заголовку Authorization і розібрати відповідь сервера. Ліміти: 1 запит на секунду та 10 ключів на акаунт.

Область дії

Обмеження API ключа Bitsby: прив’язка до конкретного проєкту й область дії (Scope). Як обмеження працюють разом і що сервер віддає в разі відмови.

Тестування в Postman

Готова колекція Postman для API Bitsby: імпорт проєкту, підстановка API ключа й власного домену, затримка між запитами.

Створення рахунку

Метод API для створення рахунку на оплату криптовалютою: параметри запиту, строк оплати, ідентифікатор замовлення й посилання на платіжну сторінку у відповіді.

Список рахунків

Метод API Bitsby для списку рахунків із фільтрами за проєктом, статусом і періодом: параметри запиту й формат відповіді.

Скасування рахунку

Метод API для скасування рахунку в Bitsby. Скасування можливе, доки рахунок неоплачений і платіжну сторінку ще ніхто не відкривав.

Список платежів

Метод API Bitsby для списку вхідних платежів на ваші криптогаманці: фільтри, посторінкова видача й параметри відповіді.

Прив’язка платежу до рахунку

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

Статистика за рахунками

Метод API для зведеної статистики за рахунками Bitsby: кількість і суми рахунків із розбивкою за проєктами й періодами.

Статистика за платежами

Метод API Bitsby для сум надходжень у розрізі криптовалют. У статистику потрапляють лише платежі, прив’язані до рахунків.

Баланси користувача

Метод API для отримання внутрішніх балансів акаунта Bitsby — внутрішнього та партнерського: формат запиту й приклад відповіді сервера.

Історія зміни балансів

Метод API для історії списань і поповнень внутрішнього балансу Bitsby: параметри запиту, фільтри за періодом і формат відповіді.

Тарифи за проєктами

Метод API Bitsby для отримання поточної ставки комісії за кожним проєктом і обороту оплачених рахунків за останні 30 днів.