Skip to main content

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.

Pix-Out represents the outbound payment flow via Pix. Use this service when you want to initiate a Pix transfer to a destination account. Use Pix-Out to:
  • Send payments to customers;
  • Process withdrawals;
  • Execute operational transfers;
  • Settle values;
  • Make instant payments to third parties.

​
Getting started with Pix-Out

The basic flow to start using Pix-Out:
  1. Build the transfer payload;
  2. Provide the amount, currency, recipient, and external identifier;
  3. Sign the request with your private key;
  4. Send the Pix-Out creation request;
  5. Store the id returned by Bloobank;
  6. Poll the transaction to track its status;
  7. Record the final result for reconciliation.

​
Create a Pix-Out transaction

Use this endpoint to create a Pix transfer. 
POST /v1/pix-out
Example request: 
curl -X POST "https://api.bloobank.com/v1/pix-out" \
  -H "Content-Type: application/json" \
  -H "X-Access-Key: <ACCESS_KEY>" \
  -H "X-Access-Timestamp: <TIMESTAMP>" \
  -H "X-Access-Request-Id: <REQUEST_ID>" \
  -H "X-Access-Signature: <SIGNATURE>" \
  -d '{
    "amount": 15000,
    "currency": "BRL",
    "description": "Payment via PIX",
    "recipient": {
      "name": "Recipient Name",
      "document": "00000000000",
      "bankCode": "000",
      "branch": "0001",
      "account": "123456",
      "accountType": "checking"
    },
    "pixKey": {
      "type": "cpf",
      "value": "00000000000"
    },
    "externalId": "order-123456"
  }'
Request body fields:
FieldTypeRequiredDescription
amountintegerYesTransaction amount in centavos.
currencystringYesTransaction currency. Use BRL for domestic operations.
descriptionstringNoTransfer description.
recipientobjectYesRecipient details.
pixKeyobjectNoDestination Pix key, when applicable.
externalIdstringYesUnique transaction identifier in your system.
Example response: 
{
  "id": "pixout_123456789",
  "amount": 15000,
  "currency": "BRL",
  "status": "processing",
  "externalId": "order-123456",
  "createdAt": "2026-05-06T11:00:00Z"
}
The externalId field must be unique in your system. It is used for tracking, reconciliation, and preventing duplicate operations.

​
Retrieve a Pix-Out transaction

Use this endpoint to retrieve the status and details of a Pix-Out transfer. 
GET /v1/pix-out/{id}
Example request: 
curl -X GET "https://api.bloobank.com/v1/pix-out/pixout_123456789" \
  -H "X-Access-Key: <ACCESS_KEY>" \
  -H "X-Access-Timestamp: <TIMESTAMP>" \
  -H "X-Access-Request-Id: <REQUEST_ID>" \
  -H "X-Access-Signature: <SIGNATURE>"
Example response: 
{
  "id": "pixout_123456789",
  "amount": 15000,
  "currency": "BRL",
  "status": "confirmed",
  "endToEndId": "E1234567820260506110000000012345",
  "externalId": "order-123456",
  "createdAt": "2026-05-06T11:00:00Z",
  "confirmedAt": "2026-05-06T11:00:03Z"
}

​
Transaction status

StatusDescription
createdTransaction created and awaiting processing.
processingTransaction is being processed.
confirmedTransaction confirmed successfully.
failedTransaction not completed.
canceledTransaction canceled.
For Pix-Out operations, poll the transaction status after creation until it reaches a final state: confirmed, failed, or canceled.