1. Webhooks (Eventos Recebidos)
Dotfy - Documentação
  • Dotfy Module
    • Raiz
      • Conta (Dados do Seller)
        • Identificar a conta (dados do seller)
      • Cobranças (PIX & Boleto)
        • Criar cobrança PIX
        • Criar boleto
        • Listar cobranças
        • Consultar cobrança por correlationID
        • Histórico de webhooks de uma cobrança
      • Cartão (Checkout Transparente)
        • Criar pagamento com cartão (PAN via API)
      • Saldo
        • Consultar saldo
      • Saques e Chaves PIX
        • Listar chaves PIX cadastradas
        • Cadastrar chave PIX
        • Listar saques
        • Solicitar saque
        • Cancelar saque pendente
      • Clientes
        • Listar clientes
        • Detalhe de um cliente
      • Produtos e Links de Pagamento
        • Links de compra por comprador (Purchase Links)
          • Criar link de compra (por comprador)
          • Listar links de compra do produto
          • Detalhe/status do link de compra
          • Revogar link de compra
        • Listar produtos
        • Criar produto
        • Detalhe do produto
        • Carrinhos abandonados do produto
      • Splits
        • Analytics de splits enviados
        • Splits recebidos
      • Disputas e MEDs
        • Listar disputas
        • Listar MEDs com estatísticas
        • Evidências de uma disputa
        • Histórico de uma disputa
      • Subcontas White-Label (BaaS)
        • Criar subconta
        • Listar subcontas
        • Detalhe da subconta
        • Atualizar subconta
        • Excluir subconta (soft delete)
        • Enviar KYC da subconta (multipart)
        • Consultar status do KYC da subconta
        • Cadastrar chave PIX da subconta
        • Listar chaves PIX da subconta
        • Remover chave PIX da subconta
        • Criar cobrança da subconta
        • Listar cobranças da subconta
        • Detalhe de cobrança da subconta
        • Saldo da subconta
        • Extrato (transações) da subconta
        • Solicitar saque da subconta
        • Listar saques da subconta
        • Atualizar taxas da subconta
      • Nominais
        • Listar nominais disponíveis
        • Trocar de nominal
        • Definir nominal de fallback
        • Estado da troca em andamento
        • [Admin] Catálogo completo de nominais
        • [Admin] Criar nominal
        • [Admin] Editar nominal
        • [Admin] Desabilitar nominal (soft)
        • [Admin] Acesso e taxas por usuário
        • Nominais permitidas à subconta
        • Trocar nominal da subconta (master)
      • Webhooks (Gerenciar Endpoints)
        • Listar endpoints
        • Criar endpoint
        • Atualizar endpoint
        • Remover endpoint
      • Webhooks (Eventos Recebidos)
        • EVENT:CHARGE_CREATED — cobrança criada
          POST
        • EVENT:CHARGE_PAID — cobrança paga (atualização principal)
          POST
        • EVENT:CHARGE_PAID — boleto pago
          POST
        • EVENT:CHARGE_EXPIRED — cobrança expirada
          POST
        • EVENT:SPLIT_RECEIVED — você recebeu um split
          POST
        • EVENT:DISPUTE_OPENED — MED/disputa aberta
          POST
        • EVENT:DISPUTE_WON — disputa ganha
          POST
        • EVENT:DISPUTE_LOST — disputa perdida
          POST
        • EVENT:DISPUTE_CANCELED — disputa cancelada
          POST
        • EVENT:WITHDRAWAL_COMPLETED — saque concluído
          POST
        • EVENT:WITHDRAWAL_FAILED — saque falhou
          POST
        • EVENT:SUBACCOUNT_KYC_APPROVED — KYC da subconta aprovado
          POST
        • EVENT:SUBACCOUNT_KYC_REJECTED — KYC da subconta recusado
          POST
        • EVENT:SUBACCOUNT_PIX_KEY_APPROVED — chave PIX da subconta aprovada
          POST
        • EVENT:SUBACCOUNT_PIX_KEY_REJECTED — chave PIX da subconta recusada
          POST
      • Notificações
        • Listar notificações
      • Dashboard / Analytics
        • Stats gerais
        • Atividade recente
        • Atividade (timeline)
        • Receita por período
        • Volume por período
        • Taxa de conversão
        • Métodos de pagamento
        • Transações (gráfico)
        • Analytics avançado
  1. Webhooks (Eventos Recebidos)

EVENT:CHARGE_PAID — boleto pago

POST
https://seu-dominio.com/webhooks/dotfy

EVENT:CHARGE_PAID — boleto pago#

Mesmo envelope de qualquer cobrança paga, com data.paymentMethod: "BOLETO" e um objeto data.boleto (linha digitável + vencimento). É o payload que a Dotfy envia ao seu endpoint quando um boleto é compensado. Concilie por data.correlationId.
data.amount em centavos.
data.boleto.line = linha digitável; data.boleto.dueAt = vencimento. Não enviamos URLs externas do emissor.
Boleto não tem chargeback → o valor fica disponível para saque na hora.
Valide X-Webhook-Signature antes de confiar no payload (mesmo esquema HMAC dos demais eventos).

Requisição

Authorization
Forneça seu token bearer no cabeçalho
Authorization
ao fazer requisições para recursos protegidos.
Exemplo:
Authorization: Bearer ********************
Parâmetros de Consulta

Parâmetros Header

Parâmetros Bodyapplication/json

Examples

Respostas

🟢200
application/json
Bodyapplication/json

Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://seu-dominio.com/webhooks/dotfy?event=charge-paid-boleto' \
--header 'X-Webhook-Signature: t=1721053800000,v1=<hex_de_HMAC_SHA256(secret, timestamp + '\''.'\'' + body)>' \
--header 'X-Webhook-Event: EVENT:CHARGE_PAID' \
--header 'X-Webhook-ID: clev_boleto_0001' \
--header 'X-Webhook-Timestamp: 2026-07-15T14:30:00.000Z' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "event": "EVENT:CHARGE_PAID",
  "timestamp": "2026-07-15T14:30:00.000Z",
  "data": {
    "id": "clch_boleto_0001",
    "externalId": "boleto_api_1714000000000_a1b2c3d4e5",
    "correlationId": "boleto_api_1714000000000_a1b2c3d4e5",
    "amount": 12990,
    "status": "PAID",
    "paymentMethod": "BOLETO",
    "boleto": {
      "line": "23793.38128 60007.827136 95000.063305 8 84410000012990",
      "dueAt": "2026-07-17T12:00:00.000Z"
    },
    "customer": {
      "name": "Maria Souza",
      "document": "390.***.**7-05",
      "email": "maria@exemplo.com",
      "phone": "+55 11 99999-8888"
    },
    "paidAt": "2026-07-15T14:30:00.000Z"
  }
}'
Response Response Example
{}
Modificado em 2026-07-14 04:02:21
Página anterior
EVENT:CHARGE_PAID — cobrança paga (atualização principal)
Próxima página
EVENT:CHARGE_EXPIRED — cobrança expirada
Built with