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

🪙 Deposits

POST Init Deposit Order

Creates a new deposit order with value, currency, expiration time, payer details, and a webhook URL.

Endpoint:

POST /orders/deposit/account/:accountId

📎 Link to full request example

GET List Deposit Orders

Lists existing deposit orders with filters by status, name, payment method, and more.

Endpoint:

GET /orders/deposit

📎 Link to full request example

POST Refund Deposit Order

Performs a refund on a specific deposit order. Currently available for BRL orders only.

Endpoint:

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

📎 Link to full request example

⚠️ Refunds can only be processed if the order is in a compatible status and the currency is BRL.

💵 Withdrawals

POST Init Withdrawal Order

Creates a withdrawal order with full recipient details, amount, currency, and webhook.

Endpoint:

POST /orders/withdrawal/account/:accountId

📎 Link to full request example

GET List Withdrawal Orders

Lists all withdrawal orders with filters by status, name, method, bank, and more.

Endpoint:

GET /orders/withdrawal

📎 Link to full request example

❓ FAQ – Common Questions

1. Do I need to authenticate before using the Orders endpoints?

Yes. All endpoints require a Bearer Token generated via authentication with clientId and clientSecret.

2. What happens if the deposit or withdrawal fails?

You can check the order history using the orderHistory field in the response. For deposits, you may initiate a refund using the Refund Deposit Order endpoint.

3. Can I track deposit/withdrawal status in real-time?

Yes. When creating an order, provide a webhookUrl. The API will send status updates to this URL.

4. Are all operations available in currencies other than BRL?

Refunds are currently supported only for BRL.

5. What’s the difference between requestedAmount and totalAmount?

totalAmount may include additional fees, while requestedAmount is the amount specified in the order.

6. What is the format of the token used?

JWT (Bearer Token), sent in the Authorization header.

You are now ready to use the Orders endpoints of the Bloquo API to manage transactions securely. If you have any questions, check the official documentation or contact our support team.