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

POST /v1/qrcodes/decode

Decode a Pix QR Code

cURL

curl --request POST \
  --url https://api.example.com/v1/qrcodes/decode \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Account-Id: <x-account-id>' \
  --data '
{
  "emv": "00020126580014br.gov.bcb.pix...",
  "cityCode": "3550308",
  "paymentDate": "2024-12-31"
}
'

200

{
  "receiverKey": "[phone]",
  "type": "STATIC",
  "amount": "100.00",
  "description": "Payment for order #12345",
  "merchant": {
    "categoryCode": "5411",
    "city": "São Paulo",
    "name": "Loja ABC",
    "postalCode": "01310-100"
  },
  "recurrence": {
    "idRec": "RR0000000000000000001",
    "recLocationUrl": "https://pix.example.com/rec/v2/abc123",
    "amount": {
      "amountRec": "29.90",
      "debitorMinimumAmount": "10.00"
    },
    "calendar": {
      "initialDate": "2026-06-01",
      "periodicity": "MONTHLY",
      "finalDate": "2027-06-01"
    },
    "link": {
      "contract": "contract-2026-001",
      "debtor": {
        "name": "John Doe",
        "cnpj": "96256999000103",
        "cpf": "61869782062"
      },
      "object": "Streaming subscription"
    },
    "payee": {
      "cnpj": "81626496000105",
      "name": "Streaming Co",
      "participantIspb": "12345678"
    },
    "recurrenceCreationDate": "2026-05-28T12:00:00Z",
    "retryPolicy": "RETRY_3X_7D"
  },
  "txId": "TX123ABC"
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Account-Id · string<uuid> · requerido

Unique identifier of the Midaz Ledger Account (UUID format)

Cuerpo

application/json

emv · string · requerido

EMV QR Code payload string to decode (text content from scanned QR Code)

Minimum string length: 1

Ejemplo:

"00020126580014br.gov.bcb.pix..."

cityCode · string

City code based on IBGE Municipal Code Table (optional, used for COBV)

Ejemplo:

"3550308"

paymentDate · string

Payment date in ISO8601 format (defaults to current date if not provided)

Ejemplo:

"2024-12-31"

Respuesta

200

application/json

OK

Option 1

Option 2

Option 3

Option 4

receiverKey · string · requerido

Pix key that will receive the payment

Ejemplo:

"[phone]"

type · string · requerido

QR Code type identifier (STATIC)

Ejemplo:

"STATIC"

amount · string

Fixed payment amount (optional)

Ejemplo:

"100.00"

description · string

Custom message or description shown to the payer

Ejemplo:

"Payment for order #12345"

merchant · object

Merchant information from the QR code

Show child attributes

recurrence · object

Pix Automático recurrence data (present only for recurrence-bearing QR codes)

Show child attributes

txId · string

Transaction identification (txid) sent on the payment message

Ejemplo:

"TX123ABC"