Uma vez que um pagamento é confirmado o cliente devera receber uma notificação via webhook em seu ambiente, para que desta forma possa ter uma certeza quanto a seu pagamento.
{
"billNumber": 0,
"billIdentifier": "3a6321bc-9b86-47bc-b06d-ae4304a3d833",
"status": "PAGO",
"amount": 0.00,
"fineSettledAmount": 0.00,
"interestSettledAmount": 0.00,
"discountSettledAmount": 0.00,
"paidValue": 0.00,
"paymentDate": "2024-11-22 10:28:07",
"notificationUrl": "notificationUrl_e93b9513e591",
"payer": {
"name": "name_7bb44fa7e542",
"documentNumber": "documentNumber_8507f52cec42"
}
}
Campos do JSON
| Campo | Tipo | Descrição |
|---|---|---|
billNumber | Long | Número do boleto a ser pago |
billIdentifier | String | Identificador do boleto |
status | Enum | Status do pagamento do boleto |
amount | Double | Valor a ser pago |
fineSettledAmount | Double | Valor liquidado de multa |
interestSettledAmount | Double | Valor liquidado de juros |
discountSettledAmount | Double | Valor liquidado de descontos |
paidValue | Double | Valor pago |
paymentDate | DateTime | Data do pagamento |
notificationUrl | String | Url de notificação (Só sera exibida caso exista uma url associada a conta que realizará o pagamento do boleto) |
payer | Object | Pagador |
└── name | String | Nome do pagador |
└── documentNumber | String | Número do documento do pagador |
Status possíveis
| Valor | Descrição |
|---|---|
PAGO | Pago através da rede bancária |
BAIXADO | Não disponível para pagamento |
LIQUIDADO | Valor liquidado na conta |
CANCELADO | Boleto Cancelado |
VENCIDO | Boleto Vencido |
ABERTO | Boleto em aberto |
REGISTRADO | Boleto registrado com sucesso |