How to use the Accounting endpoints in the Bloquo API?

How to use the Accounting endpoints in the Bloquo API?

πŸ“Š Bloquo API: Accounting Endpoints


βœ… Overview

The Accounting section endpoints of the Bloquo API allow you to retrieve financial data of the authenticated customer, such as:

  • Customer registration details

  • Accounts (FIAT and CRYPTO)

  • Current balances

  • Financial transactions

  • Deposit orders


✏️ Available Endpoints

1. Retrieve Customer Information

GET /api/v1/customers/me

  • Returns the registration details of the organization.

2. List Accounts

GET /api/v1/customer/account

  • Lists all customer accounts, including type, currency, status, and bank information.

3. List Accounts Balances

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

  • Returns current balance information across all accounts, including currency, account type, and overdraft limits.

πŸ”— Click here for a full request and response example

4. List Transactions

GET /api/v1/customer/transaction

  • Retrieves the transaction history with filters like amount, currency, type (Credit/Debit), and account.

Available parameters:
  • amount: [optional] transaction amount (double)

  • currency: [optional] currency (string, e.g., BRL, USDT)

  • type: [optional] transaction type (Credit or Debit)

  • orderType: [optional] order type (e.g., TRADE)

  • accountId: [optional] origin/destination account

πŸ”— Click here for a full request and response example


πŸ€” Frequently Asked Questions (FAQ)

  1. What types of accounts can be listed?

    • FIAT and CRYPTO accounts, with bank details or wallet addresses.

  2. How do I get the balance of a specific account?

    • Use the balances endpoint with the includes=account parameter and filter by the desired accountId.

  3. Can I filter transactions by type?

    • Yes, using the type parameter with values Credit or Debit.

  4. How does authentication work?

    • All endpoints require a JWT (Bearer Token) and the customerId header.

  5. Can I retrieve my company details via API?

    • Yes, the /customers/me endpoint returns name, taxId (CNPJ), activation status, and configuration settings.

  6. Can I check the overdraft limit for an account?

    • Yes, the maxAllowedDebt field provides this information for each account.


🚨 Important Notes

  • Always send the customerId header with the organization's ID

  • Use up-to-date tokens to avoid authentication errors (401)

  • Check overdraft limits (maxAllowedDebt) before making financial operations


If you have further questions, contact our support team or check the full API documentation.

    • Related Articles

    • How to use the Trades endpoints in the Bloquo API?

      ? Bloquo API: Trades Endpoints Overview The Trades endpoints allow efficient currency exchange operations on the platform, including quote requests, trade confirmations, and trade history listing. ? Request Quote POST Request Quote Request a quote ...
    • How to use the Orders endpoints in the Bloquo API?

      ? Bloquo API: Orders Endpoints Overview The Orders section of the Bloquo API allows you to create, list, and refund deposit and withdrawal orders. This functionality is essential for managing incoming and outgoing transactions on the platform. ? ...
    • How to use the Notifications endpoints in the Bloquo API?

      ? Bloquo API: Notification Endpoints Overview The Notifications endpoints allow clients to retrieve a history of notifications generated by the platform (such as transaction status changes) and to manually trigger resending of notifications if ...
    • πŸ“š Bloquo Webhooks Integration: Receiving Real-Time Order Status Notifications

      ? Bloquo Webhooks Integration: Receiving Real-Time Order Status Notifications ? Feature Overview Bloquo Webhooks are a critical real-time notification mechanism that ensures clients are immediately informed about any status change in their Deposit ...
    • How to retrieve available currencies using the Reference endpoints?

      ? Bloquo API: Reference Endpoints (Currencies) Overview The Reference endpoints in Bloquo API provide foundational information such as the list of supported currencies. This is essential for validating transactions, configuring accounts, and ...