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.

Returns the details of a single Pix-In transaction.

Request

GET /v1/pix-in/{id} HTTP/1.1
Host: api.bloobank.com
X-Access-Key: <ACCESS_KEY>
X-Access-Timestamp: <TIMESTAMP>
X-Access-Request-Id: <REQUEST_ID>
X-Access-Signature: <SIGNATURE>

Path parameters

id
string
required
The unique identifier of the Pix-In transaction.

Response

{
  "id": "pixin_123456789",
  "amount": 15000,
  "currency": "BRL",
  "status": "confirmed",
  "endToEndId": "E1234567820240101123456789012345",
  "payer": {
    "name": "Cliente Pagador",
    "document": "00000000000"
  },
  "createdAt": "2026-05-06T10:30:00Z",
  "confirmedAt": "2026-05-06T10:30:05Z"
}
id
string
Unique identifier of the Pix-In transaction.
amount
integer
Transaction amount in centavos. Example: 15000 = BRL 150.00.
currency
string
Currency code. Always BRL for domestic operations.
status
string
Current transaction status. Possible values: created, processing, confirmed, failed, canceled.
endToEndId
string
End-to-end identifier assigned by the PIX network.
payer
object
Information about the sender.
payer.name
string
Name of the payer.
payer.document
string
CPF or CNPJ of the payer.
createdAt
string
ISO 8601 timestamp (UTC) when the transaction was created.
confirmedAt
string
ISO 8601 timestamp (UTC) when the transaction was confirmed. Present only when status is confirmed.

List Pix-In transactions

Returns a list of inbound Pix transactions with optional filters.
GET /v1/pix-in HTTP/1.1
Host: api.bloobank.com
X-Access-Key: <ACCESS_KEY>
X-Access-Timestamp: <TIMESTAMP>
X-Access-Request-Id: <REQUEST_ID>
X-Access-Signature: <SIGNATURE>

Query parameters

ParameterTypeRequiredDescription
startDatestringNoStart date for the query.
endDatestringNoEnd date for the query.
statusstringNoFilter by transaction status.
limitintegerNoMaximum number of records returned.
Example request:
curl -X GET "https://api.bloobank.com/v1/pix-in?startDate=2026-05-01&endDate=2026-05-06" \
  -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:
{
  "items": [
    {
      "id": "pixin_123456789",
      "amount": 15000,
      "currency": "BRL",
      "status": "confirmed",
      "endToEndId": "E1234567820240101123456789012345",
      "createdAt": "2026-05-06T10:30:00Z"
    }
  ],
  "cursor": null
}
When signing a request with a query string, the pathname field in the canonical string must contain only the URL path.Correct: /v1/pix-inIncorrect: /v1/pix-in?startDate=2026-05-01&endDate=2026-05-06

Transaction status

StatusDescription
createdTransaction created and awaiting processing.
processingTransaction is being processed.
confirmedTransaction confirmed successfully.
failedTransaction not completed.
canceledTransaction canceled.