Pular para o conteúdo principal
POST
/
v1
/
qrcodes
/
decode
Decodificar um QR Code PIX
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>"
}

Autorizações

​
Authorization
string
header
obrigatório

Header de autenticação Bearer no formato Bearer <token>, onde <token> é o seu token de acesso JWT.

Cabeçalhos

​
X-Account-Id
string
obrigatório

Identificador único da Conta do Ledger Midaz (formato UUID).

Corpo

application/json
​
emv
string
obrigatório

String do payload EMV do QR Code para decodificar.

Exemplo:

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

​
paymentDate
string

Data de pagamento em formato ISO8601 (opcional, usado para COBV).

Exemplo:

"2024-12-31"

​
cityCode
string

Código da cidade para o contexto de pagamento (opcional, usado para COBV).

Exemplo:

"3550308"

Resposta

Payload do BR Code PIX decodificado com sucesso. O tipo da resposta varia de acordo com o tipo do QR code (STATIC, IMMEDIATE ou DUE_DATE).

​
type
enum<string>

Tipo de QR Code.

Opções disponíveis:
STATIC,
IMMEDIATE,
DUE_DATE
Exemplo:

"STATIC"

​
receiverKey
string

Chave PIX que receberá o pagamento.

Exemplo:

"+5511999999999"

​
amount
string

Valor do pagamento.

Exemplo:

"100.00"

​
description
string

Descrição do pagamento.

​
txId
string

Identificador da transação.