# Dotfy - Documentação

## Docs
- Root > Raiz [Conta (Dados do Seller)](https://dotfy.apidog.io/conta-dados-do-seller-8382480f0.md): Endpoints para identificar a conta dona da API Key e validar a chave. Use sempre `GET /api/auth/me` como teste de saúde da chave: ela responde com `authMethod: "api-key"` e os dados do seller dono dela.
- Root > Raiz [Cobranças PIX](https://dotfy.apidog.io/cobran%C3%A7as-pix-8382481f0.md): Criar, listar e consultar cobranças PIX. **Endpoint mais usado da API.** Veja o exemplo de `POST /api/charges` antes de tudo.
- Root > Raiz [Saldo](https://dotfy.apidog.io/saldo-8382482f0.md): Saldo disponível, pendente e retido (MEDs ativas).
- Root > Raiz [Saques e Chaves PIX](https://dotfy.apidog.io/saques-e-chaves-pix-8382483f0.md): Cadastrar chaves PIX de saída e solicitar saques. **Saques só funcionam em contas reais (`vk_live_*`)** — chaves de teste recebem `403` ao tentar sacar.
- Root > Raiz [Clientes](https://dotfy.apidog.io/clientes-8382484f0.md): Clientes são derivados das cobranças pagas (agregação por `payerName` + `payerTaxId`). Não há endpoint de criação manual.
- Root > Raiz [Produtos e Links de Pagamento](https://dotfy.apidog.io/produtos-e-links-de-pagamento-8382485f0.md): Gerencie produtos digitais com checkout próprio Dotfy. Cada produto vira um link `https://app.dotfy.com.br/checkout/{slug}`.
- Root > Raiz [Splits](https://dotfy.apidog.io/splits-8382486f0.md): Métricas de divisão de pagamentos. Splits são configurados no `POST /api/charges` via campo `split`.
- Root > Raiz [Disputas e MEDs](https://dotfy.apidog.io/disputas-e-meds-8382487f0.md): Mecanismo Especial de Devolução (MED) — gestão de disputas abertas pelo banco do pagador.
- Root > Raiz [Webhooks (Gerenciar Endpoints)](https://dotfy.apidog.io/webhooks-gerenciar-endpoints-8382488f0.md): CRUD dos endpoints que recebem webhooks. Para a estrutura dos eventos enviados, veja a próxima pasta ("Webhooks (Eventos Recebidos)").
- Root > Raiz [Webhooks (Eventos Recebidos)](https://dotfy.apidog.io/webhooks-eventos-recebidos-8382489f0.md): **Para devs integrando o webhook**: nesta pasta cada item NÃO é uma chamada à API Dotfy — é um **exemplo do payload que SUA aplicação receberá** em `POST` no endpoint configurado em `/api/webhook-endpoints`.
- Root > Raiz [Notificações](https://dotfy.apidog.io/notifica%C3%A7%C3%B5es-8382490f0.md): Notificações in-app (mesmas que aparecem no sino do dashboard).
- Root > Raiz [Dashboard / Analytics](https://dotfy.apidog.io/dashboard-analytics-8382491f0.md): Métricas agregadas do dashboard. Mesma fonte que alimenta a UI em `app.dotfy.com.br/dashboard`.

## API Docs
- Root > Raiz > Conta (Dados do Seller) [Identificar a conta (dados do seller)](https://dotfy.apidog.io/identificar-a-conta-dados-do-seller-35113031e0.md): ## Autenticação
- Root > Raiz > Cobranças PIX [Criar cobrança PIX](https://dotfy.apidog.io/criar-cobran%C3%A7a-pix-35113032e0.md): ## Autenticação
- Root > Raiz > Cobranças PIX [Listar cobranças](https://dotfy.apidog.io/listar-cobran%C3%A7as-35113033e0.md): ## Autenticação
- Root > Raiz > Cobranças PIX [Consultar cobrança por correlationID](https://dotfy.apidog.io/consultar-cobran%C3%A7a-por-correlationid-35113034e0.md): ## Autenticação
- Root > Raiz > Cobranças PIX [Histórico de webhooks de uma cobrança](https://dotfy.apidog.io/hist%C3%B3rico-de-webhooks-de-uma-cobran%C3%A7a-35113035e0.md): ## Autenticação
- Root > Raiz > Saldo [Consultar saldo](https://dotfy.apidog.io/consultar-saldo-35113036e0.md): ## Autenticação
- Root > Raiz > Saques e Chaves PIX [Listar chaves PIX cadastradas](https://dotfy.apidog.io/listar-chaves-pix-cadastradas-35113037e0.md): ## Autenticação
- Root > Raiz > Saques e Chaves PIX [Cadastrar chave PIX](https://dotfy.apidog.io/cadastrar-chave-pix-35113038e0.md): ## Autenticação
- Root > Raiz > Saques e Chaves PIX [Listar saques](https://dotfy.apidog.io/listar-saques-35113039e0.md): ## Autenticação
- Root > Raiz > Saques e Chaves PIX [Solicitar saque](https://dotfy.apidog.io/solicitar-saque-35113040e0.md): ## Autenticação
- Root > Raiz > Saques e Chaves PIX [Cancelar saque pendente](https://dotfy.apidog.io/cancelar-saque-pendente-35113041e0.md): ## Autenticação
- Root > Raiz > Clientes [Listar clientes](https://dotfy.apidog.io/listar-clientes-35113042e0.md): ## Autenticação
- Root > Raiz > Clientes [Detalhe de um cliente](https://dotfy.apidog.io/detalhe-de-um-cliente-35113043e0.md): ## Autenticação
- Root > Raiz > Produtos e Links de Pagamento [Listar produtos](https://dotfy.apidog.io/listar-produtos-35113044e0.md): ## Autenticação
- Root > Raiz > Produtos e Links de Pagamento [Criar produto](https://dotfy.apidog.io/criar-produto-35113045e0.md): ## Autenticação
- Root > Raiz > Produtos e Links de Pagamento [Detalhe do produto](https://dotfy.apidog.io/detalhe-do-produto-35113046e0.md): ## Autenticação
- Root > Raiz > Produtos e Links de Pagamento [Carrinhos abandonados do produto](https://dotfy.apidog.io/carrinhos-abandonados-do-produto-35113047e0.md): ## Autenticação
- Root > Raiz > Splits [Analytics de splits enviados](https://dotfy.apidog.io/analytics-de-splits-enviados-35113048e0.md): ## Autenticação
- Root > Raiz > Splits [Splits recebidos](https://dotfy.apidog.io/splits-recebidos-35113049e0.md): ## Autenticação
- Root > Raiz > Disputas e MEDs [Listar disputas](https://dotfy.apidog.io/listar-disputas-35113050e0.md): ## Autenticação
- Root > Raiz > Disputas e MEDs [Listar MEDs com estatísticas](https://dotfy.apidog.io/listar-meds-com-estat%C3%ADsticas-35113051e0.md): ## Autenticação
- Root > Raiz > Disputas e MEDs [Evidências de uma disputa](https://dotfy.apidog.io/evid%C3%AAncias-de-uma-disputa-35113052e0.md): ## Autenticação
- Root > Raiz > Disputas e MEDs [Histórico de uma disputa](https://dotfy.apidog.io/hist%C3%B3rico-de-uma-disputa-35113053e0.md): ## Autenticação
- Root > Raiz > Webhooks (Gerenciar Endpoints) [Listar endpoints](https://dotfy.apidog.io/listar-endpoints-35113054e0.md): ## Autenticação
- Root > Raiz > Webhooks (Gerenciar Endpoints) [Criar endpoint](https://dotfy.apidog.io/criar-endpoint-35113055e0.md): ## Autenticação
- Root > Raiz > Webhooks (Gerenciar Endpoints) [Atualizar endpoint](https://dotfy.apidog.io/atualizar-endpoint-35113056e0.md): ## Autenticação
- Root > Raiz > Webhooks (Gerenciar Endpoints) [Remover endpoint](https://dotfy.apidog.io/remover-endpoint-35113057e0.md): ## Autenticação
- Root > Raiz > Webhooks (Eventos Recebidos) [EVENT:CHARGE_CREATED — cobrança criada](https://dotfy.apidog.io/eventcharge-created-cobran%C3%A7a-criada-35113058e0.md): Disparado **uma vez** logo após a criação da cobrança via `POST /api/charges`. Útil para iniciar workflows internos antes do pagamento.
- Root > Raiz > Webhooks (Eventos Recebidos) [EVENT:CHARGE_PAID — cobrança paga (atualização principal)](https://dotfy.apidog.io/eventcharge-paid-cobran%C3%A7a-paga-atualiza%C3%A7%C3%A3o-principal-35113059e0.md): **Este é o evento que você espera para liberar o produto/serviço para o cliente.**
- Root > Raiz > Webhooks (Eventos Recebidos) [EVENT:CHARGE_EXPIRED — cobrança expirada](https://dotfy.apidog.io/eventcharge-expired-cobran%C3%A7a-expirada-35113060e0.md): Disparado quando o `expiresAt` passa sem pagamento, OU quando ocorre um estorno total (alguns adquirentes). Use para cancelar pedidos pendentes no seu sistema.
- Root > Raiz > Webhooks (Eventos Recebidos) [EVENT:SPLIT_RECEIVED — você recebeu um split](https://dotfy.apidog.io/eventsplit-received-voc%C3%AA-recebeu-um-split-35113061e0.md): Disparado para o destinatário quando um split lhe é creditado. `amount` em centavos.
- Root > Raiz > Webhooks (Eventos Recebidos) [EVENT:DISPUTE_OPENED — MED/disputa aberta](https://dotfy.apidog.io/eventdispute-opened-meddisputa-aberta-35113062e0.md): O banco do pagador abriu uma MED. O valor é **automaticamente reservado** no seu saldo (`balance.reserved`) até a resolução. Cobrada uma taxa de R$ 3,00 por MED aberta. Envie evidências em `POST /api/disputes/{id}/upload` + `submit`.
- Root > Raiz > Webhooks (Eventos Recebidos) [EVENT:DISPUTE_WON — disputa ganha](https://dotfy.apidog.io/eventdispute-won-disputa-ganha-35113063e0.md): Banco rejeitou a contestação. Valor reservado é liberado de volta para `balance.available`.
- Root > Raiz > Webhooks (Eventos Recebidos) [EVENT:DISPUTE_LOST — disputa perdida](https://dotfy.apidog.io/eventdispute-lost-disputa-perdida-35113064e0.md): Banco aceitou a contestação. Valor reservado é debitado definitivamente do seu saldo (chargeback efetivado).
- Root > Raiz > Webhooks (Eventos Recebidos) [EVENT:DISPUTE_CANCELED — disputa cancelada](https://dotfy.apidog.io/eventdispute-canceled-disputa-cancelada-35113065e0.md): Pagador desistiu da MED. Valor reservado é liberado.
- Root > Raiz > Webhooks (Eventos Recebidos) [EVENT:WITHDRAWAL_COMPLETED — saque concluído](https://dotfy.apidog.io/eventwithdrawal-completed-saque-conclu%C3%ADdo-35113066e0.md): Saque liquidado com sucesso na conta destino. `transactionId` = endToEndId do PIX.
- Root > Raiz > Webhooks (Eventos Recebidos) [EVENT:WITHDRAWAL_FAILED — saque falhou](https://dotfy.apidog.io/eventwithdrawal-failed-saque-falhou-35113067e0.md): Saque não foi liquidado. O valor é devolvido ao saldo disponível automaticamente.
- Root > Raiz > Notificações [Listar notificações](https://dotfy.apidog.io/listar-notifica%C3%A7%C3%B5es-35113068e0.md): ## Autenticação
- Root > Raiz > Dashboard / Analytics [Stats gerais](https://dotfy.apidog.io/stats-gerais-35113069e0.md): ## Autenticação
- Root > Raiz > Dashboard / Analytics [Atividade recente](https://dotfy.apidog.io/atividade-recente-35113070e0.md): ## Autenticação
- Root > Raiz > Dashboard / Analytics [Atividade (timeline)](https://dotfy.apidog.io/atividade-timeline-35113071e0.md): ## Autenticação
- Root > Raiz > Dashboard / Analytics [Receita por período](https://dotfy.apidog.io/receita-por-per%C3%ADodo-35113072e0.md): ## Autenticação
- Root > Raiz > Dashboard / Analytics [Volume por período](https://dotfy.apidog.io/volume-por-per%C3%ADodo-35113073e0.md): ## Autenticação
- Root > Raiz > Dashboard / Analytics [Taxa de conversão](https://dotfy.apidog.io/taxa-de-convers%C3%A3o-35113074e0.md): ## Autenticação
- Root > Raiz > Dashboard / Analytics [Métodos de pagamento](https://dotfy.apidog.io/m%C3%A9todos-de-pagamento-35113075e0.md): ## Autenticação
- Root > Raiz > Dashboard / Analytics [Transações (gráfico)](https://dotfy.apidog.io/transa%C3%A7%C3%B5es-gr%C3%A1fico-35113076e0.md): ## Autenticação
- Root > Raiz > Dashboard / Analytics [Analytics avançado](https://dotfy.apidog.io/analytics-avan%C3%A7ado-35113077e0.md): ## Autenticação