Generar cobro PIX (Cash-In)
Genera un código QR dinámico para recibir pagos mediante PIX.
Requiere un Bearer token en el header Authorization.
| Campo | Tipo | Requerido | Descripción |
|---|
transaction | object | Sí | Datos de la transacción |
transaction.value | number | Sí | Monto en BRL (hasta 2 decimales) |
transaction.description | string | Sí | Descripción de la transacción |
transaction.externalId | string | Sí | ID externo de la transacción (identificador único) |
transaction.expirationTime | number | No | Tiempo de expiración en segundos (mín 5 min, máx 7 días). Por defecto: 86400 |
transaction.generateQrCode | boolean | No | Si es true, retorna el código QR en Base64. Por defecto: false |
payer | object | Sí | Datos del pagador |
payer.fullName | string | Sí | Nombre completo del pagador |
payer.document | string | Sí | CPF o CNPJ del pagador (solo números) |
additionalInfo | object | No | Información adicional (pares clave-valor string:string, máximo 10 claves) |
{
"transaction": {
"value": 0.05,
"description": "Cobrança de teste",
"externalId": "external-teste-01",
"expirationTime": 86400,
"generateQrCode": true
},
"payer": {
"fullName": "John Marvin",
"document": "12312312387"
},
"additionalInfo": {
"orderId": "ORD-12345"
}
}
| Campo | Tipo | Descripción |
|---|
transactionId | string | Identificador único de la transacción generada |
correlationId | string | ID de correlación de la transacción (UUID) |
externalId | string | ID externo de la transacción (mismo valor que la entrada) |
status | string | Estado de la transacción (PENDING, CONFIRMED, ERROR) |
pixCode | string | Código PIX en formato EMV estándar |
generateTime | string | Fecha y hora de generación del PIX (ISO 8601) |
expirationDate | string | Fecha y hora de expiración del PIX (ISO 8601) |
qrCodeImage | string | Código QR en Base64 (solo cuando generateQrCode=true) |
{
"transactionId": "123",
"correlationId": "550e8400-e29b-41d4-a716-446655440000",
"externalId": "external-teste-01",
"status": "PENDING",
"pixCode": "00020126580014br.gov.bcb.pix...",
"generateTime": "2024-01-15T10:30:00.000Z",
"expirationDate": "2024-01-16T10:30:00.000Z",
"qrCodeImage": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA..."
}
| Estado | Descripción |
|---|
| 400 | Datos inválidos |
| 401 | Token faltante o inválido |
| 500 | Error al generar el cobro PIX |
