Webhook de Boletos

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âmetroDescriçãoFormato
signatureassinatura criptografada para garantir a origem da informação.string
changeReferência da alteração.string
data.abatementValueValor de abatimento do pagamento.string
data.applicableFineMulta de atraso aplicada ao pagamento.string
data.boleto.barCodeCódigo de barras do boleto bancário.string
data.boleto.lineCodeLinha digitável do boleto bancáriostring
data.boleto.ourNumberO nosso número de controle.string
data.boleto.pdfURL para acesso ao .pdf do boleto bancário.string
data.boleto.quickPdfUrlURL simplificada para acesso ao .pdf do boleto bancário.string
data.boleto.registrationMethodTipo de registro do boleto bancário.string
data.boleto.registrationStatusStatus do registro do boleto bancário.string
data.boleto.yourNumberO seu número de controle.string
data.clientControlNumberIdentificador próprio de uso da empresa.string
data.createdAtData de criação do pagamento no formato "YYY-MM-DD".Date
data.daysWriteOffAfterDueDateQuantidade de dias para baixa após o vencimento.int
data.discountTypeTipo de desconto.string
data.discountValueValor do desconto.string
data.dueDateData de vencimento do boleto bancário.string
data.interestTypeTipo de juros aplicado.string
data.monthlyInterestValor de juros ao mês.string
data.originOrigem do pagamento. (conta Grafeno ou API).string
payer.address.cityCidade do endereço do pagador.string
payer.address.complementComplemento do endereço do pagador.string
payer.address.neighborhoodBairro do endereço do pagador.string
payer.address.numberNúmero do endereço do pagador.string
payer.address.stateEstado em formato UF do endereço do pagador.string
payer.address.streetRua do endereço do pagador.string
payer.address.zipCodeCEP do endereço do pagador.string
payer.documentNumberNúmero do documento de identificação do pagador.string
payer.emailE-mail do pagador.string
payer.nameNome do pagador.string
payer.phoneTelefone do pagador.string
data.paymentMethodMétodo de pagamento utilizado.string
data.statusStatus do pagamento.string
data.uuidIdentificador único do pagamento.string
data.valueValor do pagamento.string
fees.kindTipo de tarifa aplicada.string
fees.valueValor da tarifa.string
payments.valueValor pago.string
payments.receivedAtData de recebimento do valor pago no formato "YYY-MM-DD".Date
payments.processedAtData do processamento do pagamento no formato "YYY-MM-DD".Date
payments.paymentBankCodeCódigo do banco utilizado para o pagamento.string
payments.paymentAgencyCódigo da agência do banco utilizado para o pagamento.string

Eventos de notificação para boletos bancários

EventoDescrição
boleto-criadoEste evento informa que o boleto bancário foi criado com êxito.
boleto-registradoEste 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"
      }
    ]
  }
}