---
agentTools:
  projectIndex: https://docs.grafeno.digital/llms.txt
---

# Webhook de Pagamentos

Quando a sua conta Grafeno receber um pagamento, esta informação será enviada para a sua URL de notificação.

Os webhooks de pagamentos são notificações enviadas pela Grafeno para seu sistema sempre que ocorrer a entrada de um valor proveniente de um pagamento de cobrança em sua conta.

## Body Params

[block:parameters]
{
  "data": {
    "h-0": "Parâmetro",
    "h-1": "Descrição",
    "h-2": "Formato",
    "0-0": "signature",
    "0-1": "Assinatura criptografada para garantir a origem da informação. <b> Não disponível em PRD. Sugerimos utilizar os custom-headers para garantir a origem da notificação. </b>",
    "0-2": "<b>string",
    "1-0": "change",
    "1-1": "Referência da alteração.",
    "1-2": "<b>string",
    "2-0": "data.uuid",
    "2-1": "Identificador único do pagamento.",
    "2-2": "<b>string",
    "3-0": "data.accountInformation.bank_code",
    "3-1": "Código do banco da conta bancária de origem da notificação.",
    "3-2": "<b>string",
    "4-0": "data.accountInformation.agency",
    "4-1": "Agência da conta bancária de origem da notificação.",
    "4-2": "<b>string",
    "5-0": "data.accountInformation.account",
    "5-1": "Conta bancária de origem da notificação.",
    "5-2": "<b>string",
    "6-0": "data.applicableFine",
    "6-1": "Multa de atraso aplicada ao pagamento.",
    "6-2": "<b>string",
    "7-0": "data.daysWriteOffAfterDueDate",
    "7-1": "Quantidade de dias para baixa após o vencimento.",
    "7-2": "<b>int",
    "8-0": "data.clientControlNumber",
    "8-1": "Identificador próprio de uso da empresa.",
    "8-2": "<b>string",
    "9-0": "data.interestType",
    "9-1": "Tipo de juros aplicado.",
    "9-2": "<b>string",
    "10-0": "data.monthlyInterest",
    "10-1": "Valor de juros ao mês.",
    "10-2": "<b>string",
    "11-0": "data.discountType",
    "11-1": "Tipo de desconto.",
    "11-2": "<b>string",
    "12-0": "data.discountValue",
    "12-1": "Valor do desconto.",
    "12-2": "<b>string",
    "13-0": "data.dueDate",
    "13-1": "Data de vencimento do boleto bancário.",
    "13-2": "<b>string",
    "14-0": "data.paymentMethod",
    "14-1": "Método de pagamento utilizado.",
    "14-2": "<b>string",
    "15-0": "data.status",
    "15-1": "Status do pagamento.",
    "15-2": "<b>string",
    "16-0": "data.value",
    "16-1": "Valor do pagamento.",
    "16-2": "<b>string",
    "17-0": "data.origin",
    "17-1": "Origem do pagamento. (conta Grafeno ou API).",
    "17-2": "<b>string",
    "18-0": "data.boleto.registrationMethod",
    "18-1": "Método de registro do boleto bancário.",
    "18-2": "<b>string",
    "19-0": "data.boleto.registrationStatus",
    "19-1": "Status do registro do boleto bancário.",
    "19-2": "<b>string",
    "20-0": "data.boleto.ourNumber",
    "20-1": "Nosso número de controle do boleto bancário.",
    "20-2": "<b>string",
    "21-0": "data.boleto.ourNumberDv",
    "21-1": "Dígito do nosso número do boleto bancário.",
    "21-2": "<b>string",
    "22-0": "data.boleto.barCode",
    "22-1": "Código de barras do boleto bancário.",
    "22-2": "<b>string",
    "23-0": "data.boleto.lineCode",
    "23-1": "Linha digitável do boleto bancário",
    "23-2": "<b>string",
    "24-0": "data.boleto.yourNumber",
    "24-1": "O seu número de controle.",
    "24-2": "<b>string",
    "25-0": "data.boleto.pdf",
    "25-1": "URL para acesso ao .pdf do boleto bancário.",
    "25-2": "<b>string",
    "26-0": "data.boleto.quickPdfUrl",
    "26-1": "URL simplificada para acesso ao .pdf do boleto bancário.",
    "26-2": "<b>string",
    "27-0": "data.boleto.emv",
    "27-1": "PIX Copia e Cola. (somente em boletos na modalidade \"híbrido\").",
    "27-2": "<b>string",
    "28-0": "data.boleto.image",
    "28-1": "QR Code do PIX. (somente em boletos na modalidade \"híbrido\").",
    "28-2": "<b>string",
    "29-0": "data.payer.name",
    "29-1": "Nome do pagador.",
    "29-2": "<b>string",
    "30-0": "data.payer.email",
    "30-1": "E-mail do pagador.",
    "30-2": "<b>string",
    "31-0": "data.payer.documentNumber",
    "31-1": "Número do documento de identificação do pagador.",
    "31-2": "<b>string",
    "32-0": "data.payer.address.street",
    "32-1": "Rua do endereço do pagador.",
    "32-2": "<b>string",
    "33-0": "data.payer.address.number",
    "33-1": "Número do endereço do pagador.",
    "33-2": "<b>string",
    "34-0": "data.payer.address.complement",
    "34-1": "Complemento do endereço do pagador.",
    "34-2": "<b>string",
    "35-0": "data.payer.address.neighborhood",
    "35-1": "Bairro do endereço do pagador.",
    "35-2": "<b>string",
    "36-0": "data.payer.address.city",
    "36-1": "Cidade do endereço do pagador.",
    "36-2": "<b>string",
    "37-0": "data.payer.address.state",
    "37-1": "Estado em formato UF do endereço do pagador.",
    "37-2": "<b>string",
    "38-0": "data.payer.address.zipCode",
    "38-1": "CEP do endereço do pagador.",
    "38-2": "<b>string",
    "39-0": "data.payer.phone.countryCode",
    "39-1": "Código do país do telefone do pagador.",
    "39-2": "<b>string",
    "40-0": "data.payer.phone.areaCode",
    "40-1": "Código de área do telefone do pagador.",
    "40-2": "<b>string",
    "41-0": "data.payer.phone.number",
    "41-1": "Telefone do pagador.",
    "41-2": "<b>string",
    "42-0": "data.fees.kind",
    "42-1": "Tipo de tarifa aplicada.",
    "42-2": "<b>string",
    "43-0": "data.fees.value",
    "43-1": "Valor da tarifa.",
    "43-2": "<b>string",
    "44-0": "data.payments.value",
    "44-1": "Valor pago.",
    "44-2": "<b>string",
    "45-0": "data.payments.receivedAt",
    "45-1": "Data de recebimento do valor pago no formato \"YYY-MM-DD\".",
    "45-2": "<b>Date",
    "46-0": "data.payments.processedAt",
    "46-1": "Data do processamento do pagamento no formato \"YYY-MM-DD\".",
    "46-2": "<b>Date",
    "47-0": "data.payments.paymentBankCode",
    "47-1": "Código do banco utilizado para o pagamento.",
    "47-2": "<b>string",
    "48-0": "data.payments.paymentAgency",
    "48-1": "Código da agência do banco utilizado para o pagamento.",
    "48-2": "<b>string"
  },
  "cols": 3,
  "rows": 49,
  "align": [
    "left",
    "left",
    "left"
  ]
}
[/block]

## Evento de notificação para Pagamento

| Evento             | Descrição                                         |
| :----------------- | :------------------------------------------------ |
| pagamento-recebido | Evento que informa o recebimento de um pagamento. |

## Evento de notificação

```json pagamento-recebido
{
  "signature": "Ftz2Ay+LmD7MOZRahuHOgEHvE6cIa73hl5VsvT7dlcRiOwuvtYeAnfgZATqJ\no66ymDsm5t5BMPrR1u+djKyt1g3VZOYQQFm3Ec6AqYtuEjKgGIsQglWGySe0\n8ODYZBntIoVa/TLgtJkJPOKOXPQKgYFSokHJl4UX1VgFgPvpOxyvktdbeC2j\nxa1mkEcU/g2ZLx256H9AJuXObcCRgE87nFcEL3dOe2yi4hVM1VsPnw/XZa6k\nYgAR/UPkH8dbJXpNNZj9HIhHaNFflzRQSyi5u85rbKsGOgEwgZ4kt+RLg6Kb\n7zjRfQgW3hzEX+1V/iXQegi8wlD/NOjNDiZHrECOx0Ha10b0jvL/+rtO1hJu\nTau7taC5hpu33t55DHzHclxKBfB2qAlODBS3c+QdOpWJZ+Ol3RRKFxaqgNsm\nagTsKaePwNP/mFavUtkPIoUh6v1u9Lxnuxq94H1i5KHM5Qx2Zj11LNQl3+qQ\njH0WYGmdgIf/ujq+UAc6hGdZWq2u6Ljr++coxbK3wPS0Fp0cUUBYYYDHFgE8\n4SKtfesbnKsiSF5Mp9tDRzILL+p9BfdPYTL6LhENjDxZFuTZQyFAZR1FKIvD\nouikSVAgadQI/a94ytazmId3BoMbICrnXnhD7CR2/2qvo3yvkAS375HKkWKB\n1vPnnsz8ThQRSJTpcQHHePg=\n",
  "change": "pagamento-recebido",
  "data": {
    "accountInformation": {
      "agency": "0001",
      "bank_code": "310",
      "account": "xxxxxxxx-x"
    },
    "abatementValue": "5.2",
    "applicableFine": "0.02",
    "boleto": {
      "barCode": "27499994700000699090001010000001379881246950",
      "lineCode": "27490001011000000137998812469504999470000069909",
      "ourNumber": 13798,
      "ourNumberDv": "0",
      "pdf": "https://pagamentos.grafeno.be/charges/ce936f49-7767-443f-ab58-32d13e33891a/download_boleto",
      "quickPdfUrl": "https://grafeno-pagamentos-carrierwave-staging.s3.amazonaws.com/uploads/bmp/boleto/32387/file/31-12-2024_-_VIVI_ATUAL__NF__-_Jose_do_Protesto_-_57327.pdf?X-Amz-Expires=259200&X-Amz-Date=20240205T180421Z&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA6GUDBFRJDLS2JG7S%2F20240205%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-SignedHeaders=host&X-Amz-Signature=dcb467cfc4dde29fc34734c4db25ce5123b573b5b175dfda167c948df9e4fcd1",
      "registrationMethod": "online",
      "registrationStatus": "registered",
      "yourNumber": "11119999",
      "emv": "00020101021226970014br.gov.bcb.pix2575qr-h.cornerpix.com.br/11581339/v2/cobv/ef9b28f3-c9bb-4948-991b-5bfd8004b1e05204000053039865802BR5914BMP MONEY PLUS6009SAO PAULO62070503***63048242",
      "image": "iVBORw0KGgoAAAANSUhEUgAAAhIAAAISAQAAAACxRhsSAAAE0UlEQVR4nO2dzY3jOBCFXy0F+CgBG0CHImWwMXVIm4EUSmcgHQ1IeHsgi6Q8np4FxuZ6jceD4RblDxRQqP9SG/G7a/njtxGAGGKIIYYYYoghhhhiFIal1cGmrYOZdcAyHAZsaQPAYTYBsGnz+6cHn0MMMb5ljCTJFcAyAJzz/jIEYuQOs7hxGGcEkiTPjEecQwwxvmVsrh3HFbAp6s5Am5DEljMCsQzpftexjz6HGGL8S8ZhUb3Omxm5HmY2HG7jAZRvzz2HGGLk1d38zagxtz93AwADAIx/Xwhs3W7j1+0PHnQOMcT4dkVHM/mngRjXQKAnAYS4ASCkXfTpvupn86s8ixhvz1jMzGzwq+NXFz1VYOuyz5o2bMIRw/3Hn0MMMe6uaMZL8ZTYAAJXA3AY0O/A8rGDywDDMgQA/bnY+irPIsb7MpLdz4ae5A5yRfzwFZiC/n5HvGUGILsvRlvGuCLKn5ldaBNCVJmce5Jzf7XoBoxfF9YpqUefQwwx7q8YEc03gomU3Y8f+b6kQOOVFExJn4rxfEYlf0UISe4eR/U76t1+R4r8JaditGMkfco1VZzStz6p0iiYM9xdTeo1VFkryakYz2d4HIWkRf3DY6ssrO7C0pOoyp+K0Y7h+jT3oYxMlr0E/e69BiZfIIb/svtiNGakLr1+B+ftEtWrTQg0G0LWtlfj55ATVv1VeX4xWjGyPk1+Z7Tx6Pc6wIKH/yWOchdW+lSMFoxTXipX9YHa7qPETDyLrey+GG0YOTTySGnua3EsVajYoJK7VOSfitGS4Tox10Mro74WsS1pqizFsvtitGPECqiNXx284TQA2LrYkWKxBbVfadgG2LgeXjPd1M8vRjNG1qe5KLUi2ngvnmaf1XP/dU+q9KkYTRmbWaUil48dKfMU+08PQxTWrUO65oX/13sWMd6WEaUupqRIzjhcbGP/KUmuh6UWlH73qelHn0MMMe4vL0WldL53n7gvEK95taoamC4bsvtiPJ2R86c3LX15OL/PPdFraaQKivfFaMo490vV6rX8iTLRV/WkeoZKcirG8xmVnCb/FGW8xBOruUaa1Kvy/GI0ZngZf0Vlz93Q5/JoMfRrnpAGZPfFaMU4q83cXFrlT7MbClT50zLELzkVox1juzAlUXHEDr/Y5vc5BGIxszrjj8OwfOyw6eHnEEOMu8ur9WUCimRV0Efd+ueuKdwDkD4Vowmj7pdKq2RS3Rcdzw2n1TCV5FSMJoxzv1T2VHNBH33dHe1BP0+O66s8ixjvy6jmo1yBnjbm3ITKNYdVq/SpGG0ZVT2q+KcujiEnrOpqlecF1M8vRjNGHoMqetJXCvDhM6h5Qjotze+L0YxxmovmaTg/5wC8HTXX93l+g8qrPIsY784o/++E89YBS/6Wmvuulqb8Yp413fLwc4ghxk+W233yFCll1zTr2JugP78eRfpUjOcz7tb3i7WP99Seat3wJ7svxn/EiBpzsQ7p3Sck+Tkclrr5NrMq1HreOcQQo14//PuS5a8VTK88X/3idonzpkC/dwaE3Urd6mWeRYz3Zfzgn8LrUSwFfVbTU/WLUeWfitGIUb1XEmX8GcD5zX2hDpxuKwOv8ixivC/D+Ot7frGWV3kWMcQQQwwxxBBDDDH+/4x/AFXeM3zOxX7QAAAAAElFTkSuQmCC"
    },
    "clientControlNumber": "7543649847645556555553425",
    "createdAt": "2024-02-03T10:53:57.976-03:00",
    "daysWriteOffAfterDueDate": 90,
    "discountType": "percentage",
    "discountValue": "2.0",
    "dueDate": "2024-02-04",
    "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": "dwight.schrute@dunder-mifflin.paper",
      "name": "Dwight Schrute",
      "phone": {
        "countryCode": "55",
        "areaCode": "51",
        "number": "995566778"
      }
    },
    "paymentMethod": "boleto",
    "status": "paid",
    "uuid": "ce936f49-7767-443f-ab58-32d13e33891a",
    "value": "699.09",
    "payments": [
      {
        "value": "699.09",
        "receivedAt": "2024-02-05",
        "processedAt": "2024-02-05T15:04:21.758-03:00",
        "paymentBankCode": null,
        "paymentAgency": null
      }
    ],
    "fees": [
      {
        "kind": "sending_email_cost",
        "value": "0.06"
      },
      {
        "kind": "charge_boleto_online_canceled_cost",
        "value": "1.99"
      },
      {
        "kind": "charge_boleto_pix_registered_cost",
        "value": "0.0"
      },
      {
        "kind": "charge_boleto_online_register_cost",
        "value": "0.0"
      }
    ]
  }
}
```