Saltar al contenido principal
POST
/
v1
/
brcode
/
static
Crear un Código QR Estático
curl --request POST \
  --url https://plugin-pix-indirect.api.lerian.net/v1/brcode/static \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Account-Id: <x-account-id>' \
  --data '
{
  "receiverKey": "+5511999999999",
  "amount": "100.00",
  "description": "Pago por pedido"
}
'
{
  "id": "550e8400-e29b-41d4-a716-4466554400bb",
  "emv": "00020126580014br.gov.bcb.pix...",
  "base64": "<string>",
  "receiverKey": "+5511999999999",
  "amount": "100.00",
  "description": "Pago por pedido #12345",
  "createdAt": "2024-01-15T10:30:00Z"
}

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).

Parámetros de consulta

​
include_base64
boolean
predeterminado:false

Retorna el código QR renderizado en base64 junto con el payload EMV.

Cuerpo

application/json
​
receiverKey
string
requerido

Clave Pix que recibirá el pago.

Ejemplo:

"+5511999999999"

​
amount
string

Monto fijo opcional.

Ejemplo:

"100.00"

​
description
string

Descripción personalizada.

Ejemplo:

"Pago por pedido #12345"

​
txId
string

Identificador de transacción opcional.

Ejemplo:

"TXabcdefghijklmno123456789"

Respuesta

Código QR Estático creado exitosamente.

​
id
string

Identificador único del Código QR.

Ejemplo:

"550e8400-e29b-41d4-a716-4466554400bb"

​
emv
string

Payload EMV del Código QR.

Ejemplo:

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

​
base64
string

Imagen del Código QR codificada en Base64 (si se solicita).

​
receiverKey
string

Clave Pix.

Ejemplo:

"+5511999999999"

​
amount
string

Monto fijo (si está establecido).

Ejemplo:

"100.00"

​
description
string

Descripción.

Ejemplo:

"Pago por pedido #12345"

​
createdAt
string<date-time>
Ejemplo:

"2024-01-15T10:30:00Z"