Kobana

A régua de cobrança como infraestrutura do seu produto

API REST v1 completa, webhooks assinados nos dois sentidos, OpenAPI e coleção Postman. Seu sistema cria as cobranças; o motor cuida do resto — com idempotência de ponta a ponta.

Área de desenvolvedores com autenticação, downloads OpenAPI/Postman e lista de endpoints
80+
endpoints na API v1
25+
recursos disponíveis
100%
paridade da API com a interface
4
camadas de idempotência

Tudo que você precisa para integrar

API REST v1
Pessoas, cobranças, réguas, acordos, disputas, tarefas, templates, notificações, auditoria e mais. As mesmas regras de negócio e máquinas de estado da interface.
Webhooks Assinados
Entrada com inbox idempotente (reentrega nunca duplica) e saída com assinatura HMAC e rotação de segredo pelo painel ou pela API.
Documentação Interativa
Especificação OpenAPI (Swagger) e coleção Postman geradas pelo próprio sistema — importe e comece a explorar com sua chave.
Api-keys Gerenciáveis
Crie, liste e revogue chaves na área de desenvolvedores do painel. Cada chave rastreada por origem e workspace.
Ações de Domínio
Endpoints que fazem o que a operação faz: notificar cobrança, aceitar acordo, resolver disputa, completar tarefa, emitir link de portal, reclassificar cliente.
Idempotência de Verdade
Inbox de webhooks com chave única, outbox transacional, jobId determinístico na fila e chave única por notificação. Retry seguro em qualquer camada.
Quick Start

Da api-key à primeira cobrança na régua

Crie a pessoa, crie a cobrança e vincule a uma régua. A partir daí, a régua acompanha a cobrança sozinha: notifica, oferta acordo, pausa exceções e encerra quando o pagamento chegar.

1
Gere sua api-key na área de desenvolvedores
2
Crie uma pessoa e uma cobrança via API
3
Vincule à régua e deixe o motor trabalhar
bash
# Criar uma pessoa
curl -X POST https://app.dunning.kobana.com.br/api/v1/people \
  -H "Authorization: Bearer SUA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Empresa Exemplo Ltda",
    "document": "12345678000190",
    "email": "financeiro@exemplo.com.br"
  }'

# Criar uma cobrança vinculada a uma régua
curl -X POST https://app.dunning.kobana.com.br/api/v1/charges \
  -H "Authorization: Bearer SUA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "person_id": "per_123",
    "amount": 450.00,
    "due_date": "2026-08-15",
    "collection_rule_id": "rule_456"
  }'
Webhooks

Receba eventos no seu sistema

Configure endpoints de saída e receba os eventos da régua — cobrança paga, acordo aceito, disputa aberta, notificação entregue — com assinatura verificável.

  • Assinatura HMAC em toda entrega
  • Rotação de segredo: POST /v1/webhook-endpoints/{id}/rotate-secret
  • Histórico de entregas consultável

Envie eventos de pagamento

No modo standalone, registre sinais de pagamento com evidência e nível de confiança — o motor interrompe a régua na hora.

Exemplo de configuração
Crie um endpoint e escolha os eventos que quer receber
# Criar um endpoint de webhook
curl -X POST https://app.dunning.kobana.com.br/api/v1/webhook-endpoints \
  -H "Authorization: Bearer SUA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://seusistema.com.br/webhooks/dunning",
    "events": ["charge.paid", "agreement.accepted", "dispute.opened"]
  }'
Webhooks de saída com histórico de entregas e assinatura HMAC
Webhooks de saída com histórico de entregas e assinatura HMAC.

Fluxo de integração

Da conta Kobana à telemetria em 6 passos.

1
Conecte a conta Kobana
Login OAuth2; o gateway bancário é opcional.
2
Gere sua api-key
Na área de desenvolvedores do painel.
3
Crie pessoas e cobranças
Pelo seu ERP ou backend, via API.
4
Vincule às réguas
Cada cobrança entra numa versão congelada da régua.
5
Assine os webhooks
Receba pagamento, acordo, disputa e entrega em tempo real.
6
Consulte a telemetria
Estado de cada etapa e motivo de cada não-envio, pela API.

Segurança em cada camada

Da autenticação à auditoria, tudo foi pensado para operações de cobrança que precisam provar cada passo.

  • OAuth2 Kobana: identidade unificada com a plataforma
  • Api-keys revogáveis: controle por chave e workspace
  • Webhooks assinados: HMAC com rotação de segredo
  • Rate limiting: proteção em endpoints sensíveis (portal e verificação de identidade)
  • Auditoria imutável: append-only garantido pelo Postgres, consultável pela API
  • Tokens de portal: armazenados apenas como hash SHA-256
Trilha de auditoria consultável pela API
Auditoria imutável: trilha consultável pela API.

Perguntas frequentes

Pronto para colocar a régua no seu produto?

Agende uma demonstração e veja a API, os webhooks e a telemetria funcionando com um cenário de carteira completo.