Ir al contenido

Crear QR PIX

POST /v1/br/payin/pix/instant

Genera un QR code PIX para que un pagador realice el pago. El estado de la transacción se confirma vía webhook.

Request body

{
  "amount": 10000,
  "amountFormat": "cents",
  "amountType": "fixed",
  "expirationInSeconds": 3600,
  "description": "Pedido #1234",
  "payerName": "João Silva",
  "payerTaxId": "123.456.789-00",
  "txIdSource": "ORD-20260318-001"
}

Campo	Tipo	Requerido	Descripción
`amount`	`number`	✅	Monto a cobrar. En centavos si `amountFormat=cents`, en BRL si `amountFormat=brl`
`amountFormat`	`"cents"` \| `"brl"`	✅	Formato del monto enviado
`amountType`	`"fixed"` \| `"custom"`	✅	`fixed` = monto exacto obligatorio. `custom` = pagador puede modificar
`expirationInSeconds`	`number`	✅	Segundos hasta que expira el QR. Mínimo recomendado: `900` (15 min)
`description`	`string`	❌	Descripción visible al pagador
`payerName`	`string`	❌	Nombre del pagador (pre-rellena el QR)
`payerTaxId`	`string`	❌	CPF/CNPJ del pagador
`txIdSource`	`string`	❌	Tu ID de referencia interno para conciliación (26-35 caracteres)

Idempotencia

Agrega el header x-idempotency-key: <tu-uuid> para evitar crear duplicados si el request se reintenta. Mismo key → misma transacción.

Response `201 Created`

{
  "txId": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
  "txIdSource": "ORD-20260318-001",
  "status": "PENDING",
  "qrCode": "00020126580014br.gov.bcb.pix...",
  "copiaECola": "00020126580014br.gov.bcb.pix...",
  "expiresAt": "2026-03-18T15:00:00.000Z",
  "estimatedFees": {
    "feeClient": 300,
    "netAmount": 9700,
    "currency": "BRL"
  }
}

Campo	Descripción
`txId`	ID único de la transacción — guárdalo para consultas posteriores
`qrCode`	Payload del QR code (para renderizar con cualquier librería QR)
`copiaECola`	String “copia e cola” para pegar directamente en apps de banco
`expiresAt`	Timestamp de expiración del QR
`estimatedFees.feeClient`	Fee que se te cobrará en centavos
`estimatedFees.netAmount`	Monto que recibirás en tu balance (en centavos)