Bloobank organizes all financial movement around the concept of a Payment Order. Every operation — receiving or sending funds — produces an order with a unique identifier, an amount, a direction, and an observable lifecycle.Documentation Index
Fetch the complete documentation index at: https://docs.bloobank.com/llms.txt
Use this file to discover all available pages before exploring further.
Direction
Every payment order carries a direction that indicates the flow of money relative to the integrator’s wallet:| Direction | Meaning | Endpoint |
|---|---|---|
IN | Funds entering the wallet (e.g. receiving via Pix). | Pix-In |
OUT | Funds leaving the wallet (e.g. sending via Pix). | Pix-Out |
This documentation covers Pix as the payment method. Other methods
(boleto, card, TED) may be added in the future as new directions and
endpoints, without changing the core model.
Lifecycle
Every payment order goes through a sequence of states until it reaches a final state.| Status | Description |
|---|---|
created | Order created and awaiting processing. |
processing | Order being processed on the PIX infrastructure. |
confirmed | Order successfully confirmed. Final state. |
failed | Order did not complete. Final state. |
canceled | Order canceled before processing. Final state. |
Once an order reaches a final state (
confirmed, failed, or canceled),
its status no longer changes. Reprocessing requires a new order with a
new externalId.Identifiers
Every Payment Order carries three main identifiers:id
Identifier assigned by Bloobank at creation time. E.g.:
pixin_123456789.externalId
Identifier defined by the integrator. Must be unique within the integrator’s
system.
endToEndId
End-to-end identifier generated by the PIX network, present after settlement.
Idempotency
Every payment creation must be idempotent. The integrator is responsible for ensuring this by sending a uniqueexternalId for each operation.
Before calling the API
Generate a unique
externalId and persist it locally, linked to the
payment intent.On timeout or network error
Resend the request with the same
externalId. Bloobank recognizes the
duplicate attempt and returns the original order — without creating a new
payment.Amounts
All amounts are represented as integers, in the smallest unit of the currency. ForBRL, this means cents.
| Human-readable | amount field |
|---|---|
| BRL 1.00 | 100 |
| BRL 150.00 | 15000 |
| BRL 1,234.56 | 123456 |
The
currency field in the creation payload accepts ISO 4217 codes. For Pix
operations, the value is always BRL.Next steps
Pix - Cash-in
Receive Pix payments using dynamic or static QR codes.
Pix - Cash-out
Send Pix payments using a Pix key or bank account details.
Webhooks
Get real-time notifications when an order changes status.
Errors
Understand how the API signals failures and how to handle them.