Enviar pago PIX mediante código QR (Cash-Out QR Code)
Envía un pago PIX a partir de un código QR escaneado o copiado (copiar y pegar). El código QR debe seguir el estándar EMV PIX del Banco Central.
Requiere un Bearer token en el header Authorization.
| Campo | Tipo | Requerido | Descripción |
|---|
value | number | Sí | Monto del pago en BRL (hasta 2 decimales). Debe coincidir con el monto incluido en el código QR, cuando esté presente |
qrCode | string | Sí | Contenido del código QR PIX (cadena EMV). Mín 50, máx 500 caracteres. Debe comenzar con 000201 |
externalId | string | Sí | Identificador externo único de la transacción |
description | string | No | Descripción opcional del pago |
name | string | No | Nombre del destinatario (puede estar incluido en el código QR) |
document | string | No | CPF o CNPJ del destinatario (puede estar incluido en el código QR) |
{
"value": 15.50,
"qrCode": "00020126580014br.gov.bcb.pix0136a1b2c3d4-e5f6-7890-abcd-ef1234567890520400005303986540515.505802BR5925DESTINATARIO LTDA6009SAO PAULO62070503***6304ABCD",
"externalId": "QRPAY-987654-20240119",
"description": "Pagamento fornecedor XYZ via QR Code",
"name": "Destinatário Ltda",
"document": "12345678000190"
}
| Campo | Tipo | Descripción |
|---|
transactionId | string | Identificador interno de la transacción generada |
externalId | string | Identificador externo proporcionado en la solicitud |
status | string | Estado actual de la transacción (PENDING, CONFIRMED, ERROR) |
generateTime | string | Fecha/hora de generación de la transacción (ISO 8601) |
{
"transactionId": "456",
"externalId": "QRPAY-987654-20240119",
"status": "PENDING",
"generateTime": "2024-01-19T14:30:00.000Z"
}
| Estado | Descripción |
|---|
| 400 | Datos inválidos, código QR inválido, monto no coincide o saldo insuficiente |
| 401 | Token faltante o inválido |
| 409 | externalId ya utilizado en otra transacción |
| 500 | Error al procesar el pago PIX mediante código QR |
