Saltar al contenido principal
POST
Decode a Pix QR Code

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

OK

receiverKey
string
requerido

Pix key that will receive the payment

Ejemplo:

"+5511999999999"

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

recurrence
object

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

txId
string

Transaction identification (txid) sent on the payment message

Ejemplo:

"TX123ABC"