Saltar al contenido principal
POST
/
v1
/
qrcodes
/
decode
Decodificar un Código QR 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>"
}

Autorizaciones

​
Authorization
string
header
requerido

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

Encabezados

​
X-Account-Id
string
requerido

Identificador único de la Cuenta del Ledger Midaz (formato UUID).

Cuerpo

application/json
​
emv
string
requerido

Cadena de payload EMV del Código QR a decodificar.

Ejemplo:

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

​
paymentDate
string

Fecha de pago en formato ISO8601 (opcional, usado para COBV).

Ejemplo:

"2024-12-31"

​
cityCode
string

Código de ciudad para el contexto de pago (opcional, usado para COBV).

Ejemplo:

"3550308"

Respuesta

Payload de BR Code Pix decodificado exitosamente. El tipo de respuesta varía según el tipo de código QR (STATIC, IMMEDIATE o DUE_DATE).

​
type
enum<string>

Tipo de Código QR.

Opciones disponibles:
STATIC,
IMMEDIATE,
DUE_DATE
Ejemplo:

"STATIC"

​
receiverKey
string

Clave Pix que recibirá el pago.

Ejemplo:

"+5511999999999"

​
amount
string

Monto del pago.

Ejemplo:

"100.00"

​
description
string

Descripción del pago.

​
txId
string

Identificador de transacción.