API reference
Authentication and limits
How to get a Bitsby API key, pass it in the Authorization header, and parse the server response. Limits: 1 request per second and 10 keys per account.
Key scope
Bitsby API key restrictions: limiting a key to a specific project and its scope. How the restrictions combine and what the server returns on refusal.
Testing in Postman
A ready-made Postman collection for the Bitsby API: importing the project, setting the API key and custom domain, and the delay between requests.
Create an invoice
API method for creating a crypto payment invoice: request parameters, payment deadline, order identifier, and the payment page link in the response.
List invoices
API method for listing invoices with filters by project, status, and period: request parameters and the response format.
Cancel an invoice
API method for canceling a Bitsby invoice. Cancellation is possible while the invoice is unpaid and no one has opened its payment page yet.
List payments
API method for listing incoming payments to your crypto wallets: filters, pagination, matched and unmatched payments in the response.
Match a payment to an invoice
API method for manually matching a payment to an invoice when the customer transferred the wrong amount: conditions and what happens to the invoice.
Invoice statistics
API method for summary statistics on Bitsby invoices: invoice counts and totals broken down by project, currency, month, and day.
Payment statistics
API method for received totals broken down by cryptocurrency. Only payments matched to invoices are included in the statistics.
Account balances
API method for getting the Bitsby account balances: request format and a server response example with internal and partner balances.
Balance history
API method for the history of deductions and top-ups on the Bitsby account balance: request parameters, pagination, and the response format.
Project fees
API method for getting the current fee rate for each project and its turnover over the last 30 days, with the fee payer side.