Decode a Pix QR Code
Use this endpoint to decode a Pix BR Code payload and extract the payment data it contains. This service supports all Pix QR Code types: static, immediate collections, and due date collections. When the code carries a Pix Automático recurrence location, the response includes a recurrence block. When an immediate collection carries Pix Saque or Pix Troco data, the response includes a withdrawal block. The response type varies with the QR code type (STATIC, IMMEDIATE, DUE_DATE, or RECURRENCE).
Authorizations
JWT bearer token issued by the identity provider.
Headers
Unique identifier of the Midaz Ledger Account (UUID format)
Body
EMV QR Code payload string to decode (text content from scanned QR Code)
1"00020126580014br.gov.bcb.pix..."
City code based on IBGE Municipal Code Table (optional, used for COBV)
"3550308"
Payment date in ISO8601 format (defaults to current date if not provided)
"2024-12-31"
Response
OK
- Option 1
- Option 2
- Option 3
- Option 4
Pix key that will receive the payment
"+5511999999999"
QR Code type identifier (STATIC)
"STATIC"
Fixed payment amount (optional)
"100.00"
Custom message or description shown to the payer
"Payment for order #12345"
Merchant information from the QR code
Pix Automático recurrence data (present only for recurrence-bearing QR codes)
Transaction identification (txid) sent on the payment message
"TX123ABC"

