Skip to main content
POST
Decodificar um QR Code Pix

Autorizações

Authorization
string
header
obrigatório

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

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 a decodificar.

Exemplo:

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

paymentDate
string

Data de pagamento no formato ISO8601 (opcional, usada para COBV).

Exemplo:

"2024-12-31"

cityCode
string

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

Exemplo:

"3550308"

Resposta

Payload do BR Code Pix decodificado com sucesso. O tipo de resposta varia de acordo com o tipo de 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.