DocumentaçãoReferência APIFórumGrafeno API Collection - Postman
Cadastro Conta StagingLogin Conta Staging

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.uuidIdentificador único do pagamento.string
data.createdAtData de criação do pagamento no formato "YYY-MM-DD".Date
data.abatementValueValor de abatimento do pagamento.string
data.applicableFineMulta de atraso aplicada ao pagamento.string
data.daysWriteOffAfterDueDateQuantidade de dias para baixa após o vencimento.int
data.clientControlNumberIdentificador próprio de uso da empresa.string
data.interestTypeTipo de juros aplicado.string
data.monthlyInterestValor de juros ao mês.string
data.discountTypeTipo de desconto.string
data.discountValueValor do desconto.string
data.dueDateData de vencimento do boleto bancário.string
data.paymentMethodMétodo de pagamento utilizado.string
data.statusStatus do pagamento.string
data.valueValor do pagamento.string
data.originOrigem do pagamento. (conta Grafeno ou API).string
data.boleto.registrationMethodMétodo de registro do boleto bancário.string
data.boleto.registrationStatusStatus do registro do boleto bancário.string
data.boleto.ourNumberNosso número de controle do boleto bancário.string
data.boleto.ourNumberDvDígito do nosso número do boleto bancário.string
data.boleto.barCodeCódigo de barras do boleto bancário.string
data.boleto.lineCodeLinha digitável do boleto bancáriostring
data.boleto.yourNumberO seu 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.emvPIX Copia e Cola. (somente em boletos na modalidade "híbrido").string
data.boleto.imageQR Code do PIX. (somente em boletos na modalidade "híbrido").string
data.payer.nameNome do pagador.string
data.payer.emailE-mail do pagador.string
data.payer.documentNumberNúmero do documento de identificação do pagador.string
data.payer.address.streetRua do endereço do pagador.string
data.payer.address.numberNúmero do endereço do pagador.string
data.payer.address.complementComplemento do endereço do pagador.string
data.payer.address.neighborhoodBairro do endereço do pagador.string
data.payer.address.cityCidade do endereço do pagador.string
data.payer.address.stateEstado em formato UF do endereço do pagador.string
data.payer.address.zipCodeCEP do endereço do pagador.string
data.payer.phone.countryCodeCódigo do país do telefone do pagador.string
data.payer.phone.areaCodeCódigo de área do telefone do pagador.string
data.payer.phone.numberTelefone do pagador.string
data.fees.kindTipo de tarifa aplicada.string
data.fees.valueValor da tarifa.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.

Eventos

	{
  "signature": "U7kVnnlJC+a0DvDUCKry3xC3mlJ1z4yxZhqoKaZgIp/vS5gkmwSxkX9fUBWz\nuyM4RT1QMKYXlBJrrCq0E0mzb782v/omnqM13/Q1+JDHbLPg56fHIJCw8tBC\npFdiDF+nHaxc62l5D+gQ8Jen4O9vFOKLAm0so7wuTsC3x3vK44jHI8fF54QK\naaOBrsRGlH03LDJA5U12JaPGlBVTfIMu7wzed7mcGOZNdLba02zqvs7TGvAW\n1BNC2sdpDunxoR144EmU2sdHXvL7gS0nTMZ+ZGjdqaO5P4sP7tFmf1RTTbFq\n5lcoeOYoGOWUumicVx05vzm3iOMAWdXEzwxaCou9snQkj3JkGqAR2vmuE4Wd\nszpOgJBD1SiiS4wy6+9hj/7LzUylSe7QTBZB98+f9gnxYrhWMDTl9a+kURhn\nf+hUtOt0kDCA6LTBfmwtFlX9Iq1994W2GVlNGpDGpa2LjRcUTXmEDj0cKZw1\nX7jkrcbQoon6Ny7za/F70VApkZ86I3eS7j8Ubx0jYLoksmloKTz52j7vYNUX\nKPlqgL3RPxxZ12YIEDO1W7H7a2/i6vtXTMKVEhUW9/FRJC4X2NPm4iQYI5FM\nPOzelxJSK8JWZ2SkxCQ3o+D2KpvTWebuPw1X+pRGoo8yTIIYBsLGIHSR2f+1\niswcdeDmxe3YbsfLNDAtZK0=\n",
  "change": "boleto-criado",
  "data": {
    "abatementValue": "5.2",
    "applicableFine": "0.02",
    "boleto": {
      "barCode": "27491994700000699090001010000001380281246950",
      "lineCode": "27490001011000000138702812469506199470000069909",
      "ourNumber": 13802,
      "ourNumberDv": "2",
      "pdf": "https://pagamentos.grafeno.be/charges/704981bc-e9e2-4344-97be-e1040076e6da/download_boleto",
      "quickPdfUrl": "https://grafeno-pagamentos-carrierwave-staging.s3.amazonaws.com/uploads/bmp/boleto/32410/file/31-12-2024_-_VIVI_ATUAL__NF__-_Jose_do_Protesto_-_57350.pdf?X-Amz-Expires=259200&X-Amz-Date=20240205T171716Z&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA6GUDBFRJDLS2JG7S%2F20240205%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-SignedHeaders=host&X-Amz-Signature=5eadc506e36568f1f70cb1d21a65ea349d5345c98eeb6344b2c2d653e2744ce5",
      "registrationMethod": "online",
      "registrationStatus": "pending",
      "yourNumber": "11119999",
      "emv": null,
      "image": null
    },
    "clientControlNumber": "7543649847645556555553425",
    "createdAt": "2024-02-05T14:17:13.003-03:00",
    "daysWriteOffAfterDueDate": 90,
    "discountType": "percentage",
    "discountValue": "2.0",
    "dueDate": "2024-12-31",
    "interestType": "percentage",
    "monthlyInterest": "2.0",
    "origin": "api",
    "payer": {
      "address": {
        "city": "São Paulo",
        "complement": "Apt 222",
        "neighborhood": "Santa Cecília",
        "number": "2222",
        "state": "SP",
        "street": "Rua Dr. Albuquerque Lins",
        "zipCode": "01230-000"
      },
      "documentNumber": "38227157351",
      "email": "[email protected]",
      "name": "Dwight Schrute",
      "phone": {
        "countryCode": "55",
        "areaCode": "51",
        "number": "995566778"
      }
    },
    "paymentMethod": "boleto",
    "status": "pending",
    "uuid": "704981bc-e9e2-4344-97be-e1040076e6da",
    "value": "699.09",
    "payments": [],
    "fees": [
      {
        "kind": "charge_boleto_online_register_cost",
        "value": "0.0"
      }
    ]
  }
}

{
  "signature": "j2bT1V2qpuz5q/EtC61M1xHBNClAWWKgojgQMYppkZcz78xVJjzXuYNUW+jO\ne6ruM/9Gvty4LToZx0ylTHd5sg6AAC/mIfFPzUW305qeVbUdazt54QP3DGz5\n+ySQp2u+Lj121chts6JRh8xXYvScZ6+qRemuol2egL9chkPhwReh9w7x4qaZ\n0ToHx3vT0ulf2DmCImeMDGCiZIiEQfB0Pd3Us+kh3IfAboWBr+mrOilop3dM\nzY/TPCUABXTDz8EiF4lRzgY1g3x0aI/D6P8DKc1xhB2bYlBOf44CUxT83X6w\nlK5Xlloh2ycb11xoj9+QxHpKscVIYZt6refLXRZq+rypdiHMuCFIKfAvmIlf\nP763LWAul2VM6jthb9Z+yWGYPVFC8oXJybwP9raaciLgfNM5G2Hirwtwcnzv\nsSw1eUHRA8qk3YGiipa1SFkOu8MM0R0MiX0SI5iY/DILtXx3ysdrmlloe89a\nQ27C8hWqMQVbEzraXZ0NkudaBKYw5ffmQICG0tNKZFnvz5ZeL9PeGnlY2BEL\n+iOakJYN2k1A7oaTH1t28i3bcJCAq+1zDKNp9TNmmK5B5oSzp5oIwOoV4idA\nrcJbonjTFLL3UJsYjHiHpGyGbNUS9CcBnnO7k/zscph9EqWWkEcsObI0/BAZ\newhbLwWhkmLI0O5Ev/42yoM=\n",
  "change": "boleto-registrado",
  "data": {
    "abatementValue": "5.2",
    "applicableFine": "0.02",
    "boleto": {
      "barCode": "27491994700000699090001010000001380281246950",
      "lineCode": "27490001011000000138702812469506199470000069909",
      "ourNumber": 13802,
      "ourNumberDv": "2",
      "pdf": "https://pagamentos.grafeno.be/charges/704981bc-e9e2-4344-97be-e1040076e6da/download_boleto",
      "quickPdfUrl": "https://grafeno-pagamentos-carrierwave-staging.s3.amazonaws.com/uploads/bmp/boleto/32410/file/31-12-2024_-_VIVI_ATUAL__NF__-_Jose_do_Protesto_-_57350.pdf?X-Amz-Expires=259200&X-Amz-Date=20240205T171743Z&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA6GUDBFRJDLS2JG7S%2F20240205%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-SignedHeaders=host&X-Amz-Signature=bc6f0fcde834e29edb657224aa2526804b0d3e75b46af56a10ada774041e7f67",
      "registrationMethod": "online",
      "registrationStatus": "registered",
      "yourNumber": "11119999",
      "emv": "00020101021226970014br.gov.bcb.pix2575qr-h.cornerpix.com.br/11581339/v2/cobv/421d9819-39b4-4946-bb65-68da8b2035665204000053039865802BR5914BMP MONEY PLUS6009SAO PAULO62070503***6304213A",
      "image": "iVBORw0KGgoAAAANSUhEUgAAAhIAAAISAQAAAACxRhsSAAAE00lEQVR4nO2dQW7jOBBFf40EeCkBOUCOQt8syJHmBtJRcgNqaUDCnwVZJJXuTmPQNscTfC4SW6IeKKBQZH1W0Ub8aVv/+mMEIIYYYoghhhhiiCGGGJVhuY3nm4dhnQ+zKw5LV9YZsOvm/a93HocYYnzJCCTJCNgVh2VLnAEAA7HaCLM53+WCgSTJM+Me4xBDjC8ZW/aOfJ8H8v11B/lxIbCZJSteilMFgNb5Ptu7iPH9GJ9meliIx8gQQWC6GQMBYJvBEA/v8vf9xyGGGP+GwWW7EOt8GFa7MK9D54FYZ4D8+GzYDxqHGGK0zc1uIoANsLDcDJgACzwMYQEMacofm37t9sCzvIsY356xWgmctgsR0tL0QmAbgRAHIsSBdt1G2BVHcrP3H4cYYvy0JX9avSOzs7wZkheddmB93QFMN8P6ejOevenzvIsY35eBRmAKEUmhQuCeP6Ub3MEFA/Onyf+QJJdneRcxvi/DbW2iS6L+yQ2Tacon40DAr1URVXYqxuMZbqf1wrTnBSlQrRNAMtF4ekx2KkYfxsngph1kHEhyR7JYAGnKT+4VU3GvslMx+jEaO/X1afanyVhDslhmz5q+AuBSnpWdivFwhsdRKSoqQRKAdG0BQMbar9q14igxejPCxyWLo29px2kooT5pVwDANiazNZsPa7o827uI8Q0Z2U8Gd6o1jsrxfgRQbJKLr0/zH/lTMbow3E4jkn6aw6V0o1VNq7DKZcprVtmpGJ0YeT9qfd1HYNpHAw4jcIzA9kJr+x4j1jnSQgQtLHcdhxhifNncnxYv6qF+swGQN6BO/jRIlxKjH6PoUh7v0xefyTBxmveTEJDXp4DmfTE6MVr9FABaET96n6qpLq79A9o3FaMfo533gyukVTqtySh5U8qn/Pqs7FSMxzNKXt/NgO1lB3CMBEDDFGHYXnaE5RgtxJess+Z+g7vWZ3kXMb49Y7ULmxSUdT4MIZb809mvtRLroTxpMXoxSv5puwGVwvq6Pk39irqfm9anYnRjNHnSTf5z3uRv06KyiSZXmnemZKdidGI0ulRVozwZKjvVJq+vZEy7zio7FaMHo5HzXSbNSirKzJ4+1fxTlJIT2akYfRmbWaotBQC7bhcixMPM5sPIeFie7WvSlM5DEaMfo9FP85LT5fxTCoqHVTVPOn+VPxWjB6PNf16AJqWvKdyDJ0jVhavy+sToySh1fKfd0ibDz8P61HkpjyneF6Mjo63fz+GS31hqJ8+XyrkpExuxVXYqxuMZHriXWbwt1yvFfEmIKl40Qnl9YnRlnOtNP/nTUiENwEuiTyGU7FSMPoz2nInAmjlVKksa262F/dmpyk7F6MqwN+7IIiq8mDREP5//LeKUeNKcin7fcYghxi8azw0oaaYouabtMT44parIn4rRkdH+3sm0w95qWtQ2Ip2Azgg/YXLLJf52vfM4xBDjFy2HUB7qMx+KclqzNiFUPXBS50qK0Y9xrt8fmsI9r+Orrdb2AarfF+M/ZYR4GN9nwN4+zH44As1/pse3rB42DjHEaNsP/rSKTmdJajkfjKp9UzE6Mj6vT9uT+3Da0M+CqedOSz8VoyPj8/5++t+USfuN1rMCbVWK7FSMhzOMv+/zm7Y+y7uIIYYYYoghhhhiiPH/Z/wDN28u9T9agCkAAAAASUVORK5CYII="
    },
    "clientControlNumber": "7543649847645556555553425",
    "createdAt": "2024-02-05T14:17:13.003-03:00",
    "daysWriteOffAfterDueDate": 90,
    "discountType": "percentage",
    "discountValue": "2.0",
    "dueDate": "2024-12-31",
    "interestType": "percentage",
    "monthlyInterest": "2.0",
    "origin": "api",
    "payer": {
      "address": {
        "city": "São Paulo",
        "complement": "Apt 222",
        "neighborhood": "Santa Cecília",
        "number": "2222",
        "state": "SP",
        "street": "Rua Dr. Albuquerque Lins",
        "zipCode": "01230-000"
      },
      "documentNumber": "38227157351",
      "email": "[email protected]",
      "name": "Dwight Schrute",
      "phone": {
        "countryCode": "55",
        "areaCode": "51",
        "number": "995566778"
      }
    },
    "paymentMethod": "boleto",
    "status": "pending",
    "uuid": "704981bc-e9e2-4344-97be-e1040076e6da",
    "value": "699.09",
    "payments": [],
    "fees": [
      {
        "kind": "charge_boleto_pix_registered_cost",
        "value": "0.0"
      },
      {
        "kind": "charge_boleto_online_register_cost",
        "value": "0.0"
      }
    ]
  }
}