O webhook de extratos é uma solução que permite a notificação em tempo real de eventos relacionados a movimentações financeiras em uma conta bancária, como pagamentos e transferências. Essa integração é especialmente útil para aplicações que precisam monitorar alterações em contas de forma ágil e automatizada.
Body Params
| Parâmetro | Descrição | Formato |
|---|---|---|
| signature | Assinatura digital utilizada para validar a autenticidade da notificação. Deve ser verificada utilizando a chave pública compartilhada previamente entre as partes. | String (base64) |
| change | Indica o tipo de mudança ocorrida na conta: "in" (crédito) ou "out" (débito) . | string |
| data.uuid | Identificador único do evento. | UUID |
| data.kind | Tipo de transação. Exemplo: "barcode_payment" (pagamento por código de barras). | string |
| data.value | Valor da transação, podendo ser negativo (débito) ou positivo (crédito). Exemplo: 853.0 (débito de R$ 853,00). | número decimal |
| data.createdAt | Data e hora da criação do evento. | ISO 8601 |
| data.description | Descrição breve da transação. Exemplo: "Pagamento de boletos". | string |
| data.details | Detalhes adicionais da transação. Exemplo: "Pagamento". | string |
| data.bankCode | Código do banco associado à conta. Exemplo: "341". | string |
| data.agency | Agência bancária da conta. Exemplo: "0196". | string |
| data.account | Número da conta bancária. Exemplo: "98989-0". | string |
| data.name | Nome do favorecido ou remetente da transação. Exemplo: "VIVI ATUAL NF". | string |
| data.documentNumber | Documento (CPF ou CNPJ) do favorecido ou remetente. Exemplo: "26095465000167". | string |
| data.receipt | URL para o comprovante da transação. Exemplo: "https://pagamentos.grafeno.be/ip_bank_account/barcode_payment_receipts/125" | string (URL) |
Estrutura da Notificação
| Tipo de transação | Chave |
|---|---|
| Estorno de TED | chargeback |
| Estorno do Envio PIX | pix_sent_chargeback |
| Custos | costs |
| TED Recebida | entry |
| TEF Recebida | tef_entry |
| Estorno de TEF Recebida | tef_entry_chargeback |
| PIX Recebido | pix_entry |
| Estorno PIX Recebido | pix_entry_chargeback |
| Transferência | internal_transfer |
| TED Enviada | withdrawal |
| TEF Enviada | tef_withdrawal |
| Estorno de TEF Enviada | tef_withdrawal_chargeback |
| PIX Enviado | pix_withdrawal |
| Recebimento de Boletos | repayment |
| Recebimento de Protestos | protest_repayment |
| Tarifas de Conta | invoice |
| Estorno de Pagamento | payment_chargeback |
| Movimentação | generic_movement |
| Pagamento | barcode_payment |
| Pagamento de Boleto (Tributos e Convênios) | tribute_payment |
| Pagamento em lote de Boleto (Tributos e Convênios) | fiducia_batch_transfer_withdrawal |
| Estorno de Pagamento | barcode_payment_chargeback |
| Reconciliação | reconciliation |
| Custas Cartorárias | notary_costs |
| Entrada de Split de Cobrança | charge_apportionment_entry |
| Saída de Split de Cobrança | charge_apportionment_withdrawal |
| Débito de Transferência de Titularidade | charge_concession_withdrawal |
| Recebimento Cartão | card_received |
| Tarifa TED | ted_cost |
| Transferência Recebida | transfer_received |
| Transferência Enviada | transfer_sent |
| Pix Cobrança Recebido | pix_charge_received |
| Recebimento Boleto Via PIX | pix_boleto_received |
| Estorno de Envio de TED | ted_sent_chargeback |
| Estorno de Tarifa de TED | ted_cost_chargeback |
| Tarifa PIX | pix_cost |
| Estorno de Tarifa PIX | pix_cost_chargeback |
Exemplos de eventos de notificação
{
"signature": "a1iRX/a/alRZb3w5IfkQegirjyyKBnx7EtSX6pQfc8mVcmFglcpMUGXeRd9z\\n...",
"change": "out",
"data": {
"uuid": "d96d6c22-0056-4899-8c81-c03d164be35a",
"kind": "barcode_payment",
"value": "-853.0",
"createdAt": "2024-11-22T14:12:24.489-03:00",
"description": "Payment",
"details": "Pagamento",
"bankCode": "341",
"agency": "0196",
"account": "80786-0",
"name": "VIVI ATUAL NF",
"documentNumber": "26095465000167",
"receipt": "https://pagamentos.grafeno.be/ip_bank_account/barcode_payment_receipts/125"
}
}
{
"signature": "r2ZJfydJiJ6Z6SGoCNuW6kNc+XmFOE8P3vfFQUWXTAmGy3c7p826ohmMEC1o\n..",
"change": "entry",
"data": {
"uuid": "7ee5eec8-78c1-4287-b4f6-7b3f9f01f0a5",
"kind": "pix_entry",
"value": "50.0",
"createdAt": "2026-10-01T11:50:40.896-03:00",
"description": "TESTES DE BOLETO - E11581339202610011450692E25",
"details": "PIX Recebido",
"bankCode": "274",
"agency": "0001",
"account": "81800070",
"name": "TESTES DE BOLETO",
"documentNumber": "20.290.384/0001-31",
"receipt": "https://pagamentos.grafeno.be/ip_bank_account/transfers_receipts/125"
}
}
{
"signature": "r2ZJfydJiJ6Z6SGoCNuW6kNc+XmFOE8P3vfFQUWXTAmGy3c7p826ohmMEC1o\n...",
"change": "entry",
"data": {
"uuid": "7ee5eec8-78c1-4287-b4f6-7b3f9f01f0a5",
"kind": "pix_entry",
"value": "50.0",
"createdAt": "2026-10-01T11:50:40.896-03:00",
"description": "TESTES DE BOLETO - E11581339202610011450692E25",
"details": "PIX Recebido",
"bankCode": "274",
"agency": "0001",
"account": "81800070",
"name": "TESTES DE BOLETO",
"documentNumber": "20.290.384/0001-31",
"receipt": "https://pagamentos.grafeno.be/ip_bank_account/transfers_receipts/125"
}
}
{
"signature": "dhuoUCYMBOCUN1jT3lODkH24CQJIYrZInJMyN5yC3HnSw4yKsU3AaoZkcYrF\n...",
"change": "out",
"data":{
"uuid": "79847762-24c2-47ac-a929-3d5ef24c4213",
"kind": "invoice",
"value": "-250.33",
"createdAt": "2026-10-02T10:34:56.865-03:00",
"description": "-",
"details": "Tarifas de conta",
"bankCode": "310",
"agency": "0001",
"account": "101265-2",
"name": "01 Grafeno Fake",
"documentNumber": "63.935.829/0001-04",
"receipt": "-"
}
}