boleto.paid, boleto.canceled e boleto.refunded para receber estas notificações.
| Campo | Tipo | Descrição |
|---|---|---|
event | string | Sempre BOLETO_UPDATE |
method | string | Sempre BOLETO |
status | string | PAID, CANCELED ou REFUNDED |
transactionId | string | ID da transação no Alpha Gateway |
idempotency | string | Chave de idempotência enviada na criação |
value | number | Valor solicitado |
valueFee | number | Taxa cobrada |
valueLiquid | number | Valor líquido |
boleto.barcode | string | Código de barras (quando disponível) |
boleto.linhaDigitavel | string | Linha digitável (quando disponível) |
boleto.qrcode | string | QR Code PIX do boleto (quando disponível) |
boleto.dueDate | string | Data de vencimento (quando disponível) |
boleto.payment | object | Dados do pagamento (apenas quando status = PAID) |
boleto.payment.paidValue | number | Valor efetivamente pago |
boleto.payment.paidAt | string | Data e hora do pagamento (ISO 8601) |
boleto.payment.receiptUrl | string | URL do comprovante (quando disponível) |
payer.fullName | string | Nome do pagador (quando disponível) |
payer.document | string | CPF ou CNPJ do pagador (quando disponível) |
{
"event": "BOLETO_UPDATE",
"method": "BOLETO",
"status": "PAID",
"transactionId": "01961234-abcd-7000-8000-000000000010",
"idempotency": "boleto-12345",
"value": 150.00,
"valueFee": 3.50,
"valueLiquid": 146.50,
"boleto": {
"barcode": "34191790010104351004791020150008998770000015000",
"linhaDigitavel": "34191.79001 01043.510047 91020.150008 9 98770000015000",
"qrcode": "00020126580014br.gov.bcb.pix...",
"dueDate": "2025-04-10",
"payment": {
"paidValue": 150.00,
"paidAt": "2025-04-08T13:20:00.000Z",
"receiptUrl": "https://.../comprovante.pdf"
}
},
"payer": {
"fullName": "João da Silva",
"document": "12345678900"
}
}
{
"event": "BOLETO_UPDATE",
"method": "BOLETO",
"status": "REFUNDED",
"transactionId": "01961234-abcd-7000-8000-000000000010",
"idempotency": "boleto-12345",
"value": 150.00,
"valueFee": 3.50,
"valueLiquid": 146.50,
"boleto": {
"barcode": "34191790010104351004791020150008998770000015000",
"linhaDigitavel": "34191.79001 01043.510047 91020.150008 9 98770000015000",
"qrcode": null,
"dueDate": "2025-04-10",
"payment": null
},
"payer": {
"fullName": "João da Silva",
"document": "12345678900"
}
}