Skip to main content
POST
Decode a Pix QR Code

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Account-Id
string
required

Unique identifier of the Midaz Ledger Account (UUID format).

Body

application/json
emv
string
required

EMV QR Code payload string to decode.

Example:

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

paymentDate
string

Payment date in ISO8601 format (optional, used for COBV).

Example:

"2024-12-31"

cityCode
string

City code for the payment context (optional, used for COBV).

Example:

"3550308"

Response

Successfully decoded the Pix BR Code payload. Response type varies based on QR code type (STATIC, IMMEDIATE, or DUE_DATE).

type
enum<string>

QR Code type.

Available options:
STATIC,
IMMEDIATE,
DUE_DATE
Example:

"STATIC"

receiverKey
string

Pix key that will receive the payment.

Example:

"+5511999999999"

amount
string

Payment amount.

Example:

"100.00"

description
string

Payment description.

txId
string

Transaction identifier.