💸 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.

🪙 Deposits

POST Init Deposit Order

Cria uma nova ordem de depósito com valor, moeda, tempo de expiração, dados do pagador e URL de webhook.

Endpoint:

POST /orders/deposit/account/:accountId

📎 Link para exemplo completo de requisição

GET List Deposit Orders

Permite listar ordens de depósito existentes com filtros por status, nome, método de pagamento, entre outros.

Endpoint:

GET /orders/deposit

📎 Link para exemplo completo de requisição

POST Refund Deposit Order

Efetua o estorno de uma ordem de depósito específica. Atualmente disponível apenas para ordens em BRL.

Endpoint:

POST /orders/deposit/account/:accountId/refund/:depositId

📎 Link para exemplo completo de requisição

⚠️ O estorno só poderá ser realizado se a ordem estiver em um estado compatível e a moeda for BRL.

💵 Withdrawals

POST Init Withdrawal Order

Cria uma ordem de saque com informações completas do destinatário, valor, moeda e webhook.

Endpoint:

POST /orders/withdrawal/account/:accountId

📎 Link para exemplo completo de requisição

GET List Withdrawal Orders

Permite listar todas as ordens de saque com filtros por status, nome, método, banco, entre outros.

Endpoint:

GET /orders/withdrawal

📎 Link para exemplo completo de requisição

❓ FAQ – Dúvidas Frequentes

1. É necessário autenticação para usar os endpoints de Orders?

Sim. Todos os endpoints requerem um Bearer Token gerado via autenticação com clientId e clientSecret.

2. O que fazer se o depósito falhar?

Você pode tentar o estorno utilizando o endpoint Refund Deposit Order.

3. Posso acompanhar o status das ordens em tempo real?

Sim. Informe a webhookUrl no momento da criação da ordem e receba atualizações automáticas.

4. Todas as operações estão disponíveis em moedas além de BRL?

Atualmente, os estornos estão disponíveis apenas para ordens em BRL.

5. Qual a diferença entre requestedAmount e totalAmount?

requestedAmount é o valor informado na criação da ordem, enquanto totalAmount pode incluir tarifas adicionais.

6. Como recebo notificações de status?

Ao criar uma ordem, informe uma webhookUrl. A API enviará atualizações para essa URL.

7. O que fazer se o saque falhar?

Você pode consultar o histórico da ordem via orderHistory na resposta.

8. Qual o formato do token usado?

JWT (Bearer Token), enviado no cabeçalho Authorization.

Pronto! Agora você está apto a utilizar os endpoints de Orders da API Bloquo para gerenciar transações com segurança. Em caso de dúvidas, consulte nossa documentação oficial ou entre em contato com o suporte.