Referência da API
Autenticação e limites
Como obter uma chave de API da Bitsby, passá-la no cabeçalho Authorization e ler a resposta do servidor. Limites: 1 requisição por segundo, 10 chaves por conta.
Escopo da chave
Restrições da chave de API da Bitsby: limitação a um projeto específico e escopo da chave. Como as restrições se combinam e o que o servidor retorna na recusa.
Testes no Postman
Uma coleção pronta do Postman para a API da Bitsby: importação do projeto, configuração da chave de API e do domínio próprio e o intervalo entre requisições.
Criar uma cobrança
Método da API para criar uma cobrança de pagamento em cripto: parâmetros da requisição, prazo de pagamento, ID do pedido e link da página de pagamento.
Listar cobranças
Método da API para listar cobranças com filtros por projeto, status e período: parâmetros da requisição e o formato da resposta.
Cancelar uma cobrança
Método da API para cancelar uma cobrança na Bitsby. O cancelamento é possível enquanto a cobrança está em aberto e ninguém abriu a página de pagamento.
Listar pagamentos
Método da API para listar os pagamentos recebidos nas suas carteiras cripto: filtros, paginação, pagamentos vinculados e não vinculados na resposta.
Vincular um pagamento a uma cobrança
Método da API para vincular manualmente um pagamento a uma cobrança quando o cliente transferiu um valor errado: condições e o que acontece com a cobrança.
Estatísticas de cobranças
Método da API para estatísticas resumidas das cobranças na Bitsby: contagens e totais de cobranças detalhados por projeto, moeda, mês e dia.
Estatísticas de pagamentos
Método da API para os totais recebidos detalhados por criptomoeda. Somente pagamentos vinculados a cobranças entram nas estatísticas.
Saldos da conta
Método da API para obter os saldos da conta na Bitsby: formato da requisição e um exemplo de resposta do servidor com os saldos interno e de parceiro.
Histórico de saldo
Método da API para o histórico de débitos e recargas do saldo da conta na Bitsby: parâmetros da requisição, paginação e o formato da resposta.
Taxas do projeto
Método da API para obter a taxa atual de cada projeto e o seu faturamento nos últimos 30 dias, com o lado que paga a taxa do serviço.