Quando um boleto for criado você poderá acompanhar de forma dinâmica os eventos de criação e registro do título.
Os webhooks boletos bancários são notificações enviadas pela Grafeno para seu sistema sempre que algum pagamento tenha o seu status alterado.
Body Params
Parâmetro | Descrição | Formato |
---|---|---|
signature | assinatura criptografada para garantir a origem da informação. | string |
change | Referência da alteração. | string |
data.abatementValue | Valor de abatimento do pagamento. | string |
data.applicableFine | Multa de atraso aplicada ao pagamento. | string |
data.boleto.barCode | Código de barras do boleto bancário. | string |
data.boleto.lineCode | Linha digitável do boleto bancário | string |
data.boleto.ourNumber | O nosso número de controle. | string |
data.boleto.pdf | URL para acesso ao .pdf do boleto bancário. | string |
data.boleto.quickPdfUrl | URL simplificada para acesso ao .pdf do boleto bancário. | string |
data.boleto.registrationMethod | Tipo de registro do boleto bancário. | string |
data.boleto.registrationStatus | Status do registro do boleto bancário. | string |
data.boleto.yourNumber | O seu número de controle. | string |
data.clientControlNumber | Identificador próprio de uso da empresa. | string |
data.createdAt | Data de criação do pagamento no formato "YYY-MM-DD". | Date |
data.daysWriteOffAfterDueDate | Quantidade de dias para baixa após o vencimento. | int |
data.discountType | Tipo de desconto. | string |
data.discountValue | Valor do desconto. | string |
data.dueDate | Data de vencimento do boleto bancário. | string |
data.interestType | Tipo de juros aplicado. | string |
data.monthlyInterest | Valor de juros ao mês. | string |
data.origin | Origem do pagamento. (conta Grafeno ou API). | string |
payer.address.city | Cidade do endereço do pagador. | string |
payer.address.complement | Complemento do endereço do pagador. | string |
payer.address.neighborhood | Bairro do endereço do pagador. | string |
payer.address.number | Número do endereço do pagador. | string |
payer.address.state | Estado em formato UF do endereço do pagador. | string |
payer.address.street | Rua do endereço do pagador. | string |
payer.address.zipCode | CEP do endereço do pagador. | string |
payer.documentNumber | Número do documento de identificação do pagador. | string |
payer.email | E-mail do pagador. | string |
payer.name | Nome do pagador. | string |
payer.phone | Telefone do pagador. | string |
data.paymentMethod | Método de pagamento utilizado. | string |
data.status | Status do pagamento. | string |
data.uuid | Identificador único do pagamento. | string |
data.value | Valor do pagamento. | string |
fees.kind | Tipo de tarifa aplicada. | string |
fees.value | Valor da tarifa. | string |
payments.value | Valor pago. | string |
payments.receivedAt | Data de recebimento do valor pago no formato "YYY-MM-DD". | Date |
payments.processedAt | Data do processamento do pagamento no formato "YYY-MM-DD". | Date |
payments.paymentBankCode | Código do banco utilizado para o pagamento. | string |
payments.paymentAgency | Código da agência do banco utilizado para o pagamento. | string |
Eventos de notificação para boletos bancários
Evento | Descrição |
---|---|
boleto-criado | Este evento informa que o boleto bancário foi criado com êxito. |
boleto-registrado | Este evento informa que o boleto bancário foi registrado com êxito. |
Exemplo
{
"signature": "DT38Gedh6ZjwEj6anevo9hsILY2Z+32ypTX/N+L4E9gq7rvN+GwP7Rj9o5+P\nxuMcugmsFBzmS82saraA5x36tAfKo8Y55z9PWc8H0wl0Nc5lrvJvMX7fZW3C\nbNTR13stmPs8pDODUsXyeH4HwZyeDH+Q236wDSridXlmKTFEb1eyfwS8UnH3\nJKHplBxKEikOorW4OKKJXNxFZYLcePWNwF9k+5x3ZYhCbzPoPrvTklFjdYrs\n90OdAGHpuO7O4s/tmhF9la+igdEwIMuEqyNyUvUOHqlbENhM0kYczbXucbLa\nDNhjMmjyTed7fZOh311Z5aFKEIqfAZEvuI0jwXFKBnUOl8Jw3EbNA19hZ3CM\nGWkV1B24lgjB1+Bw97aMISlkumhSdFfWExB9BV67+7o2LxNSLgjnLdFDdnWo\nWZSOyXamzXc/28YPMqHDX/WB1NnFjmt4D260THXic2HYQRS6pqwkaOXn1j9t\nGpfLAm/4jE2dceQ17srJj+G9IYPCEqjiMsa4uasyaiQD7z1UST83JgQh34fu\nIi7QjtKz0C1toKyL0bNlKky1l0zxnfpWMe96Kx3sJkZlqOnIL/4aV4SI6oj3\nIsVVYoj42zu0f25hq5xjd3wSp9O4bE1wm4/wrwL2QrGTJsYAVdjNoUsP3EUf\n1CxjEg+GIAFiAxNdBQIGDjk=\n",
"change": "boleto-criado",
"data": {
"abatementValue": null,
"applicableFine": "0.02",
"boleto": {
"barCode": "27496914500000251110001010000000475681246950",
"lineCode": "27490001011000000047056812469502691450000025111",
"ourNumber": 4756,
"pdf": "https://pagamentos.grafeno.be/charges/a6d92438-93ff-46d3-a0f7-2b10e3a86f5e/download_boleto",
"quickPdfUrl": "https://grafeno-pagamentos-carrierwave-staging.s3.amazonaws.com/uploads/bmp/boleto/9855/file/21-10-2022_-_VIVI_ATUAL__NF__-_Teste_Cob_LTDA_-_28406.pdf?X-Amz-Expires=259200&X-Amz-Date=20220117T124058Z&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA6GUDBFRJDLS2JG7S%2F20220117%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-SignedHeaders=host&X-Amz-Signature=5a992c30791d32a3c007e40fbf4af2a5b806158029c63a829558f082436be70d",
"registrationMethod": "online",
"registrationStatus": "pending",
"yourNumber": "000001"
},
"clientControlNumber": null,
"createdAt": "2022-01-17T09:40:53.229-03:00",
"daysWriteOffAfterDueDate": 90,
"discountType": null,
"discountValue": null,
"dueDate": "2022-10-21",
"interestType": null,
"monthlyInterest": null,
"origin": "api",
"payer": {
"address": {
"city": "SÃO PAULO",
"complement": "casa 2",
"neighborhood": "Jardim Paulistano",
"number": "1355",
"state": "SP",
"street": "Av Brigadeiro Faria Lima",
"zipCode": "01452011"
},
"documentNumber": "12345679891",
"email": "[email protected]",
"name": "Teste Cob LTDA",
"phone": null
},
"paymentMethod": "boleto",
"status": "pending",
"uuid": "a6d92438-93ff-46d3-a0f7-2b10e3a86f5e",
"value": "251.11",
"payments": [],
"fees": [
{
"kind": "charge_boleto_online_register_cost",
"value": "0.0"
}
]
}
}