Gerar cobrança PIX (Cash-In)
Gera um QR Code dinâmico para recebimento via PIX.
Requer token Bearer no header Authorization.
| Campo | Tipo | Obrigatório | Descrição |
|---|
transaction | object | Sim | Dados da transação |
transaction.value | number | Sim | Valor em reais (até 2 casas decimais) |
transaction.description | string | Sim | Descrição da transação |
transaction.externalId | string | Sim | ID externo da transação (identificador único) |
transaction.expirationTime | number | Não | Tempo de expiração em segundos (min 5 min, max 7 dias). Default: 86400 |
transaction.generateQrCode | boolean | Não | Se true, retorna o QR Code em Base64. Default: false |
payer | object | Sim | Dados do pagador (informativos — não enviados ao PSP) |
payer.fullName | string | Sim | Nome do pagador. Informativo — pode usar valor fixo (ex: razão social da conta). Máx: 100 chars |
payer.document | string | Sim | CPF (11 dígitos) ou CNPJ (14 dígitos). Informativo — pode usar o CNPJ do próprio integrador |
additionalInfo | object | Não | Informações adicionais (chave-valor string:string, máximo 10 chaves) |
{
"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 | Descrição |
|---|
transactionId | string | Identificador único da transação gerada |
correlationId | string | ID de correlação da transação (UUID) |
externalId | string | ID externo da transação (mesmo valor do input) |
status | string | Status da transação (PENDING, CONFIRMED, ERROR) |
pixCode | string | Código Pix no formato padrão EMV |
generateTime | string | Data e hora de geração do Pix (ISO 8601) |
expirationDate | string | Data e hora de expiração do Pix (ISO 8601) |
qrCodeImage | string | QR Code em Base64 (apenas quando 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..."
}
| Status | Descrição |
|---|
| 400 | Dados inválidos |
| 401 | Token não fornecido ou inválido |
| 500 | Erro ao gerar cobrança PIX |
