Skip to main content
POST
/
v1
/
qrcodes
/
decode
Decode a Pix QR Code
curl --request POST \
  --url https://plugin-pix-indirect.api.lerian.net/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..."
}
'
{
  "type": "STATIC",
  "receiverKey": "+5511999999999",
  "amount": "100.00",
  "description": "<string>",
  "txId": "<string>"
}

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.