# Dotfy - Documentação

## Docs
- Root > Raiz [Conta (Dados do Seller)](https://docs.dotfy.com.br/conta-dados-do-seller-9397549f0.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://docs.dotfy.com.br/cobran%C3%A7as-pix-9397550f0.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 [Cartão (Checkout Transparente)](https://docs.dotfy.com.br/cart%C3%A3o-checkout-transparente-9397551f0.md): Processamento de cartão via API (Fase 2): a integração envia o cartão cru (PAN/CVV) e o Dotfy tokeniza server-side no nosso processador de cartão e processa. **Recurso liberado por usuário** (switch do admin) — PAN cru exige conta habilitada.
- Root > Raiz [Saldo](https://docs.dotfy.com.br/saldo-9397552f0.md): Saldo disponível, pendente e retido (MEDs ativas).
- Root > Raiz [Saques e Chaves PIX](https://docs.dotfy.com.br/saques-e-chaves-pix-9397553f0.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://docs.dotfy.com.br/clientes-9397554f0.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://docs.dotfy.com.br/produtos-e-links-de-pagamento-9397555f0.md): Gerencie produtos digitais com checkout próprio Dotfy. Cada produto vira um link `https://app.dotfy.com.br/checkout/{slug}`.
- Root > Raiz > Produtos e Links de Pagamento [Links de compra por comprador (Purchase Links)](https://docs.dotfy.com.br/links-de-compra-por-comprador-purchase-links-9397563f0.md): Gere um **link individual e isolado por comprador** que reutiliza TODAS as configurações de um produto (preço server-side, tema, order bump, cartão se habilitado). O link abre o checkout com os dados do comprador pré-preenchidos (editáveis) e é rastreável fim-a-fim: cobranças pagas a partir dele chegam no seu webhook `EVENT:CHARGE_PAID` com o objeto `purchaseLink` identificando qual link foi pago.
- Root > Raiz [Splits](https://docs.dotfy.com.br/splits-9397556f0.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://docs.dotfy.com.br/disputas-e-meds-9397557f0.md): Mecanismo Especial de Devolução (MED) — gestão de disputas abertas pelo banco do pagador.
- Root > Raiz [Subcontas White-Label (BaaS)](https://docs.dotfy.com.br/subcontas-white-label-baas-9397558f0.md): ## Subcontas White-Label (BaaS)
- Root > Raiz [Webhooks (Gerenciar Endpoints)](https://docs.dotfy.com.br/webhooks-gerenciar-endpoints-9397559f0.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://docs.dotfy.com.br/webhooks-eventos-recebidos-9397560f0.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://docs.dotfy.com.br/notifica%C3%A7%C3%B5es-9397561f0.md): Notificações in-app (mesmas que aparecem no sino do dashboard).
- Root > Raiz [Dashboard / Analytics](https://docs.dotfy.com.br/dashboard-analytics-9397562f0.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://docs.dotfy.com.br/identificar-a-conta-dados-do-seller-39166924e0.md): ## Autenticação
- Root > Raiz > Cobranças PIX [Criar cobrança PIX](https://docs.dotfy.com.br/criar-cobran%C3%A7a-pix-39166925e0.md): ## Autenticação
- Root > Raiz > Cobranças PIX [Listar cobranças](https://docs.dotfy.com.br/listar-cobran%C3%A7as-39166926e0.md): ## Autenticação
- Root > Raiz > Cobranças PIX [Consultar cobrança por correlationID](https://docs.dotfy.com.br/consultar-cobran%C3%A7a-por-correlationid-39166927e0.md): ## Autenticação
- Root > Raiz > Cobranças PIX [Histórico de webhooks de uma cobrança](https://docs.dotfy.com.br/hist%C3%B3rico-de-webhooks-de-uma-cobran%C3%A7a-39166928e0.md): ## Autenticação
- Root > Raiz > Cartão (Checkout Transparente) [Criar pagamento com cartão (PAN via API)](https://docs.dotfy.com.br/criar-pagamento-com-cart%C3%A3o-pan-via-api-39166929e0.md): ## Autenticação
- Root > Raiz > Saldo [Consultar saldo](https://docs.dotfy.com.br/consultar-saldo-39166930e0.md): ## Autenticação
- Root > Raiz > Saques e Chaves PIX [Listar chaves PIX cadastradas](https://docs.dotfy.com.br/listar-chaves-pix-cadastradas-39166931e0.md): ## Autenticação
- Root > Raiz > Saques e Chaves PIX [Cadastrar chave PIX](https://docs.dotfy.com.br/cadastrar-chave-pix-39166932e0.md): ## Autenticação
- Root > Raiz > Saques e Chaves PIX [Listar saques](https://docs.dotfy.com.br/listar-saques-39166933e0.md): ## Autenticação
- Root > Raiz > Saques e Chaves PIX [Solicitar saque](https://docs.dotfy.com.br/solicitar-saque-39166934e0.md): ## Autenticação
- Root > Raiz > Saques e Chaves PIX [Cancelar saque pendente](https://docs.dotfy.com.br/cancelar-saque-pendente-39166935e0.md): ## Autenticação
- Root > Raiz > Clientes [Listar clientes](https://docs.dotfy.com.br/listar-clientes-39166936e0.md): ## Autenticação
- Root > Raiz > Clientes [Detalhe de um cliente](https://docs.dotfy.com.br/detalhe-de-um-cliente-39166937e0.md): ## Autenticação
- Root > Raiz > Produtos e Links de Pagamento > Links de compra por comprador (Purchase Links) [Criar link de compra (por comprador)](https://docs.dotfy.com.br/criar-link-de-compra-por-comprador-39166942e0.md): ## Autenticação
- Root > Raiz > Produtos e Links de Pagamento > Links de compra por comprador (Purchase Links) [Listar links de compra do produto](https://docs.dotfy.com.br/listar-links-de-compra-do-produto-39166943e0.md): ## Autenticação
- Root > Raiz > Produtos e Links de Pagamento > Links de compra por comprador (Purchase Links) [Detalhe/status do link de compra](https://docs.dotfy.com.br/detalhestatus-do-link-de-compra-39166944e0.md): ## Autenticação
- Root > Raiz > Produtos e Links de Pagamento > Links de compra por comprador (Purchase Links) [Revogar link de compra](https://docs.dotfy.com.br/revogar-link-de-compra-39166945e0.md): ## Autenticação
- Root > Raiz > Produtos e Links de Pagamento [Listar produtos](https://docs.dotfy.com.br/listar-produtos-39166938e0.md): ## Autenticação
- Root > Raiz > Produtos e Links de Pagamento [Criar produto](https://docs.dotfy.com.br/criar-produto-39166939e0.md): ## Autenticação
- Root > Raiz > Produtos e Links de Pagamento [Detalhe do produto](https://docs.dotfy.com.br/detalhe-do-produto-39166940e0.md): ## Autenticação
- Root > Raiz > Produtos e Links de Pagamento [Carrinhos abandonados do produto](https://docs.dotfy.com.br/carrinhos-abandonados-do-produto-39166941e0.md): ## Autenticação
- Root > Raiz > Splits [Analytics de splits enviados](https://docs.dotfy.com.br/analytics-de-splits-enviados-39166946e0.md): ## Autenticação
- Root > Raiz > Splits [Splits recebidos](https://docs.dotfy.com.br/splits-recebidos-39166947e0.md): ## Autenticação
- Root > Raiz > Disputas e MEDs [Listar disputas](https://docs.dotfy.com.br/listar-disputas-39166948e0.md): ## Autenticação
- Root > Raiz > Disputas e MEDs [Listar MEDs com estatísticas](https://docs.dotfy.com.br/listar-meds-com-estat%C3%ADsticas-39166949e0.md): ## Autenticação
- Root > Raiz > Disputas e MEDs [Evidências de uma disputa](https://docs.dotfy.com.br/evid%C3%AAncias-de-uma-disputa-39166950e0.md): ## Autenticação
- Root > Raiz > Disputas e MEDs [Histórico de uma disputa](https://docs.dotfy.com.br/hist%C3%B3rico-de-uma-disputa-39166951e0.md): ## Autenticação
- Root > Raiz > Subcontas White-Label (BaaS) [Criar subconta](https://docs.dotfy.com.br/criar-subconta-39166952e0.md): ## Autenticação
- Root > Raiz > Subcontas White-Label (BaaS) [Listar subcontas](https://docs.dotfy.com.br/listar-subcontas-39166953e0.md): ## Autenticação
- Root > Raiz > Subcontas White-Label (BaaS) [Detalhe da subconta](https://docs.dotfy.com.br/detalhe-da-subconta-39166954e0.md): ## Autenticação
- Root > Raiz > Subcontas White-Label (BaaS) [Atualizar subconta](https://docs.dotfy.com.br/atualizar-subconta-39166955e0.md): ## Autenticação
- Root > Raiz > Subcontas White-Label (BaaS) [Excluir subconta (soft delete)](https://docs.dotfy.com.br/excluir-subconta-soft-delete-39166956e0.md): ## Autenticação
- Root > Raiz > Subcontas White-Label (BaaS) [Enviar KYC da subconta (multipart)](https://docs.dotfy.com.br/enviar-kyc-da-subconta-multipart-39166957e0.md): ## Autenticação
- Root > Raiz > Subcontas White-Label (BaaS) [Consultar status do KYC da subconta](https://docs.dotfy.com.br/consultar-status-do-kyc-da-subconta-39166958e0.md): ## Autenticação
- Root > Raiz > Subcontas White-Label (BaaS) [Cadastrar chave PIX da subconta](https://docs.dotfy.com.br/cadastrar-chave-pix-da-subconta-39166959e0.md): ## Autenticação
- Root > Raiz > Subcontas White-Label (BaaS) [Listar chaves PIX da subconta](https://docs.dotfy.com.br/listar-chaves-pix-da-subconta-39166960e0.md): ## Autenticação
- Root > Raiz > Subcontas White-Label (BaaS) [Remover chave PIX da subconta](https://docs.dotfy.com.br/remover-chave-pix-da-subconta-39166961e0.md): ## Autenticação
- Root > Raiz > Subcontas White-Label (BaaS) [Criar cobrança da subconta](https://docs.dotfy.com.br/criar-cobran%C3%A7a-da-subconta-39166962e0.md): ## Operação delegada (white-label)
- Root > Raiz > Subcontas White-Label (BaaS) [Listar cobranças da subconta](https://docs.dotfy.com.br/listar-cobran%C3%A7as-da-subconta-39166963e0.md): ## Operação delegada (white-label)
- Root > Raiz > Subcontas White-Label (BaaS) [Detalhe de cobrança da subconta](https://docs.dotfy.com.br/detalhe-de-cobran%C3%A7a-da-subconta-39166964e0.md): ## Operação delegada (white-label)
- Root > Raiz > Subcontas White-Label (BaaS) [Saldo da subconta](https://docs.dotfy.com.br/saldo-da-subconta-39166965e0.md): ## Operação delegada (white-label)
- Root > Raiz > Subcontas White-Label (BaaS) [Extrato (transações) da subconta](https://docs.dotfy.com.br/extrato-transa%C3%A7%C3%B5es-da-subconta-39166966e0.md): ## Operação delegada (white-label)
- Root > Raiz > Subcontas White-Label (BaaS) [Solicitar saque da subconta](https://docs.dotfy.com.br/solicitar-saque-da-subconta-39166967e0.md): ## Operação delegada (white-label)
- Root > Raiz > Subcontas White-Label (BaaS) [Listar saques da subconta](https://docs.dotfy.com.br/listar-saques-da-subconta-39166968e0.md): ## Operação delegada (white-label)
- Root > Raiz > Subcontas White-Label (BaaS) [Atualizar taxas da subconta](https://docs.dotfy.com.br/atualizar-taxas-da-subconta-39166969e0.md): ## Operação delegada (white-label)
- Root > Raiz > Webhooks (Gerenciar Endpoints) [Listar endpoints](https://docs.dotfy.com.br/listar-endpoints-39166970e0.md): ## Autenticação
- Root > Raiz > Webhooks (Gerenciar Endpoints) [Criar endpoint](https://docs.dotfy.com.br/criar-endpoint-39166971e0.md): ## Autenticação
- Root > Raiz > Webhooks (Gerenciar Endpoints) [Atualizar endpoint](https://docs.dotfy.com.br/atualizar-endpoint-39166972e0.md): ## Autenticação
- Root > Raiz > Webhooks (Gerenciar Endpoints) [Remover endpoint](https://docs.dotfy.com.br/remover-endpoint-39166973e0.md): ## Autenticação
- Root > Raiz > Webhooks (Eventos Recebidos) [EVENT:CHARGE_CREATED — cobrança criada](https://docs.dotfy.com.br/eventcharge-created-cobran%C3%A7a-criada-39166974e0.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://docs.dotfy.com.br/eventcharge-paid-cobran%C3%A7a-paga-atualiza%C3%A7%C3%A3o-principal-39166975e0.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://docs.dotfy.com.br/eventcharge-expired-cobran%C3%A7a-expirada-39166976e0.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://docs.dotfy.com.br/eventsplit-received-voc%C3%AA-recebeu-um-split-39166977e0.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://docs.dotfy.com.br/eventdispute-opened-meddisputa-aberta-39166978e0.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://docs.dotfy.com.br/eventdispute-won-disputa-ganha-39166979e0.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://docs.dotfy.com.br/eventdispute-lost-disputa-perdida-39166980e0.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://docs.dotfy.com.br/eventdispute-canceled-disputa-cancelada-39166981e0.md): Pagador desistiu da MED. Valor reservado é liberado.
- Root > Raiz > Webhooks (Eventos Recebidos) [EVENT:WITHDRAWAL_COMPLETED — saque concluído](https://docs.dotfy.com.br/eventwithdrawal-completed-saque-conclu%C3%ADdo-39166982e0.md): Saque liquidado com sucesso na conta destino. `transactionId` = endToEndId do PIX.
- Root > Raiz > Webhooks (Eventos Recebidos) [EVENT:WITHDRAWAL_FAILED — saque falhou](https://docs.dotfy.com.br/eventwithdrawal-failed-saque-falhou-39166983e0.md): Saque não foi liquidado. O valor é devolvido ao saldo disponível automaticamente.
- Root > Raiz > Webhooks (Eventos Recebidos) [EVENT:SUBACCOUNT_KYC_APPROVED — KYC da subconta aprovado](https://docs.dotfy.com.br/eventsubaccount-kyc-approved-kyc-da-subconta-aprovado-39166984e0.md): **Evento entregue nos endpoints do MASTER** (a subconta é _headless_ — não tem endpoints próprios). Para recebê-lo, o endpoint do master precisa estar inscrito em `EVENT:SUBACCOUNT_KYC_APPROVED`.
- Root > Raiz > Webhooks (Eventos Recebidos) [EVENT:SUBACCOUNT_KYC_REJECTED — KYC da subconta recusado](https://docs.dotfy.com.br/eventsubaccount-kyc-rejected-kyc-da-subconta-recusado-39166985e0.md): **Evento entregue nos endpoints do MASTER** (a subconta é _headless_). Para recebê-lo, o endpoint do master precisa estar inscrito em `EVENT:SUBACCOUNT_KYC_REJECTED`.
- Root > Raiz > Webhooks (Eventos Recebidos) [EVENT:SUBACCOUNT_PIX_KEY_APPROVED — chave PIX da subconta aprovada](https://docs.dotfy.com.br/eventsubaccount-pix-key-approved-chave-pix-da-subconta-aprovada-39166986e0.md): **Evento entregue nos endpoints do MASTER** (a subconta é _headless_). Para recebê-lo, o endpoint do master precisa estar inscrito em `EVENT:SUBACCOUNT_PIX_KEY_APPROVED`.
- Root > Raiz > Webhooks (Eventos Recebidos) [EVENT:SUBACCOUNT_PIX_KEY_REJECTED — chave PIX da subconta recusada](https://docs.dotfy.com.br/eventsubaccount-pix-key-rejected-chave-pix-da-subconta-recusada-39166987e0.md): **Evento entregue nos endpoints do MASTER** (a subconta é _headless_). Para recebê-lo, o endpoint do master precisa estar inscrito em `EVENT:SUBACCOUNT_PIX_KEY_REJECTED`.
- Root > Raiz > Notificações [Listar notificações](https://docs.dotfy.com.br/listar-notifica%C3%A7%C3%B5es-39166988e0.md): ## Autenticação
- Root > Raiz > Dashboard / Analytics [Stats gerais](https://docs.dotfy.com.br/stats-gerais-39166989e0.md): ## Autenticação
- Root > Raiz > Dashboard / Analytics [Atividade recente](https://docs.dotfy.com.br/atividade-recente-39166990e0.md): ## Autenticação
- Root > Raiz > Dashboard / Analytics [Atividade (timeline)](https://docs.dotfy.com.br/atividade-timeline-39166991e0.md): ## Autenticação
- Root > Raiz > Dashboard / Analytics [Receita por período](https://docs.dotfy.com.br/receita-por-per%C3%ADodo-39166992e0.md): ## Autenticação
- Root > Raiz > Dashboard / Analytics [Volume por período](https://docs.dotfy.com.br/volume-por-per%C3%ADodo-39166993e0.md): ## Autenticação
- Root > Raiz > Dashboard / Analytics [Taxa de conversão](https://docs.dotfy.com.br/taxa-de-convers%C3%A3o-39166994e0.md): ## Autenticação
- Root > Raiz > Dashboard / Analytics [Métodos de pagamento](https://docs.dotfy.com.br/m%C3%A9todos-de-pagamento-39166995e0.md): ## Autenticação
- Root > Raiz > Dashboard / Analytics [Transações (gráfico)](https://docs.dotfy.com.br/transa%C3%A7%C3%B5es-gr%C3%A1fico-39166996e0.md): ## Autenticação
- Root > Raiz > Dashboard / Analytics [Analytics avançado](https://docs.dotfy.com.br/analytics-avan%C3%A7ado-39166997e0.md): ## Autenticação