Como utilizar os endpoints de Accounting na API Bloquo?

Como utilizar os endpoints de Accounting na API Bloquo?

📊API Bloquo: Endpoints de Accounting


✅ Visão Geral

Os endpoints da seção Accounting da API Bloquo permitem a consulta de dados financeiros do cliente autenticado, como:

  • Dados cadastrais do cliente

  • Contas (FIAT e CRIPTO)

  • Saldos atualizados

  • Transações financeiras

  • Ordens de depósito


✏️ Endpoints Disponíveis

1. Retrieve Customer Information

GET /api/v1/customers/me

  • Retorna os dados cadastrais da organização.

2. List Accounts

GET /api/v1/customer/account

  • Lista todas as contas do cliente, incluindo tipo, moeda, status e dados bancários.

3. List Accounts Balances

GET /api/v1/customer/account/balances?includes=account

  • Retorna o saldo atual de todas as contas, incluindo moeda, tipo de conta e limite de débito.

🔗 Veja um exemplo completo de requisição e resposta aqui

4. List Transactions

GET /api/v1/customer/transaction

  • Permite consultar o histórico de transações com filtros como: valor, moeda, tipo (Crédito/Débito), conta.

Parâmetros disponíveis:
  • amount: [opcional] valor da transação (double)

  • currency: [opcional] moeda (string, ex: BRL, USDT)

  • type: [opcional] tipo da transação (Credit ou Debit)

  • orderType: [opcional] tipo de ordem (ex: TRADE)

  • accountId: [opcional] conta de origem/destino

🔗 Veja um exemplo completo de requisição e resposta aqui


🤔 Perguntas Frequentes (FAQ)

  1. Quais tipos de contas podem ser listados?

    • Contas FIAT e CRIPTO, com dados bancários ou endereços de carteira.

  2. Como vejo o saldo de uma conta específica?

    • Use o endpoint de saldos com o parâmetro includes=account e filtre pelo accountId desejado.

  3. É possível filtrar transações por tipo?

    • Sim, usando o parâmetro type com os valores Credit ou Debit.

  4. Como funciona a autenticação?

    • Todos os endpoints requerem um JWT (Bearer Token) e o header customerId.

  5. Consigo ver dados da minha empresa pela API?

    • Sim, o endpoint /customers/me retorna nome, CNPJ (taxId), status de ativação e configurações.

  6. Consigo ver o saldo negativo permitido em uma conta?

    • Sim, o campo maxAllowedDebt traz esse limite para cada conta.


🚨 Importante

  • Sempre envie o header customerId com o ID da organização

  • Use tokens atualizados para evitar erros de autenticação (401)

  • Verifique os limites de débito (maxAllowedDebt) antes de realizar operações financeiras


Se tiver dúvidas adicionais, fale com nosso suporte ou consulte a documentação completa da API.

    • Related Articles

    • Como utilizar os endpoints de Orders na API Bloquo?

      ? API Bloquo: Endpoints de Orders Visão Geral Os endpoints da seção Orders da API Bloquo permitem criar, listar e estornar ordens de depósitos e saques. Essa funcionalidade é essencial para gerenciar transações de entrada e saída na plataforma. ? ...
    • Como utilizar os endpoints de Notifications na API Bloquo?

      ? API Bloquo: Endpoints de Notifications Visão Geral Os endpoints de Notifications permitem que o cliente consulte o histórico de notificações enviadas pela plataforma (como alertas de transação, mudanças de status) e reenvie manualmente mensagens, ...
    • Como utilizar os endpoints de Trades na API Bloquo?

      ? API Bloquo: Endpoints de Trades Visão Geral Os endpoints de Trades permitem realizar operações de câmbio dentro da plataforma, incluindo solicitação de cotações, aceitação de ordens e consulta ao histórico de negociações. ? Solicitar Cotação POST ...
    • Integração de Webhooks Bloquo: Recebendo Notificações de Status de Pedidos

      ? Integração de Webhooks Bloquo: Recebendo Notificações de Status de Pedidos ? Visão Geral do Recurso Os Webhooks da Bloquo são um mecanismo essencial de notificação em tempo real que garante que os clientes sejam informados imediatamente sobre ...
    • Como consultar as moedas disponíveis?

      ? API Bloquo: Endpoints de Reference (Moedas) Visão Geral Os endpoints de Reference da API Bloquo fornecem dados fundamentais, como a lista de moedas suportadas pela plataforma. Isso permite validar operações, configurar contas e consultar ...