# Kodano Docs

- Documentação
  - Começar
    - [Visão geral da API](/docs/comecar/visao-geral): Uma API REST para cobrar por PIX, boleto e cartão, acompanhar saldo e liquidações, sacar e receber cada evento por webhook assinado.
    - [Sua primeira cobrança PIX em 5 minutos](/docs/comecar/primeira-cobranca-pix): Gere um token, crie uma cobrança PIX no sandbox e acompanhe até o pagamento.
    - [Ambientes: sandbox e produção](/docs/comecar/ambientes): Dois ambientes isolados, cada um com sua credencial, seus dados e seus webhooks.
    - [Credenciais e autenticação](/docs/comecar/autenticacao): Credencial de máquina no servidor de autorização da Kodano, com private_key_jwt ou client_secret, e token Bearer em cada chamada.
  - Conceitos
    - [Produtos de integração e escopos](/docs/conceitos/produtos-e-escopos): Cada produto reúne escopos e define o que a credencial pode chamar.
    - [Merchant e X-Merchant-Id](/docs/conceitos/merchant): Como indicar em qual loja a operação acontece.
    - [Idempotência](/docs/conceitos/idempotencia): Idempotency-Key em todo POST que cria recurso ou move dinheiro, replay seguro e conflitos 409.
    - [Paginação por cursor](/docs/conceitos/paginacao): Listas com data, hasMore e nextCursor.
    - [Erros](/docs/conceitos/erros): Formato problem+json e o catálogo de code.
    - [Dinheiro, datas e IDs](/docs/conceitos/dinheiro-datas-ids): Centavos com currency, datas ISO-8601 em UTC e IDs com prefixo.
    - [Rate limit](/docs/conceitos/rate-limit): Limite de requisições por credencial e como reagir ao 429.
    - [Versionamento e changelog](/docs/conceitos/versionamento): Versão na URL, mudanças compatíveis na v1 e quebra de contrato só em /v2.
  - Guias
    - [Cobrar com PIX](/docs/guias/pix): QR Code dinâmico com validade, confirmação por webhook e expiração.
    - [Cobrar com boleto](/docs/guias/boleto): Boleto com vencimento, linha digitável e confirmação por webhook.
    - [Cobrar com cartão](/docs/guias/cartao): Cofre de cartões, token do SDK, parcelamento, 3DS e captura.
    - [Estornar e cancelar](/docs/guias/estornos-e-cancelamentos): Estorno total ou parcial e cancelamento de cobranças pendentes.
    - [Clientes](/docs/guias/clientes): Cadastro de pagadores para reutilizar em cobranças e cartões.
    - [Links de pagamento](/docs/guias/links-de-pagamento): Um link pronto para o cliente pagar, sem montar checkout.
    - [Saldo, extrato e liquidações](/docs/guias/saldo-extrato-liquidacoes): O que está disponível, o que entrou e o que foi liquidado.
    - [Saques e destinos](/docs/guias/saques-e-destinos): Saques para contas bancárias e chaves PIX verificadas, com limite diário.
    - [Contrato e caução](/docs/guias/contratos-e-caucao): Contrato com assinatura eletrônica e caução no cartão, do aluguel ao check-out.
    - [Câmbio](/docs/guias/cambio): Converta reais em dólares e envie para contas no exterior pela API, da cotação ao comprovante.
  - Webhooks
    - [Visão geral dos webhooks](/docs/webhooks/visao-geral): Eventos assinados entregues por HTTPS, com retentativa e reenvio.
    - [Configurar endpoints](/docs/webhooks/configurar-endpoints): Cadastro de URLs, escolha de eventos, segredo de assinatura e teste.
    - [Verificar a assinatura](/docs/webhooks/verificar-assinatura): Validação do X-Kodano-Signature com HMAC-SHA256, tolerância de 5 minutos e rotação de segredo.
    - [Retentativa, DLQ e reenvio](/docs/webhooks/retentativa-e-reenvio): O que acontece quando a sua URL falha e como pedir o reenvio de um evento.
    - [Catálogo de eventos](/docs/webhooks/eventos): Todos os tipos de evento da v1 e o escopo de leitura que cada um exige.
  - Testes
    - [Sandbox e simuladores](/docs/testes/sandbox): Como testar a integração de ponta a ponta sem dinheiro de verdade.
    - [Coleção Postman](/docs/testes/postman): Coleção e ambiente prontos para obter o token e chamar as rotas do sandbox.
  - Usar com IA
    - [MCP da documentação](/docs/ia/mcp): Conecte o Claude, o Cursor ou o VS Code à documentação da Kodano.
    - [llms.txt](/docs/ia/llms-txt): A documentação em Markdown para modelos de linguagem.
- API Reference
  - [Referência da API](/api-reference): Os 48 endpoints da API Kodano v1, com request, response, erros e exemplos em cURL, Node.js, Python, C# e PHP.
  - Pagamentos
    - [Criar cobrança PIX](/api-reference/pagamentos/create-pix-payment)
    - [Emitir boleto](/api-reference/pagamentos/create-boleto-payment)
    - [Cobrar cartão](/api-reference/pagamentos/create-card-payment)
    - [Capturar pré-autorização](/api-reference/pagamentos/capture-payment)
    - [Listar estornos do pagamento](/api-reference/pagamentos/list-payment-refunds)
    - [Estornar pagamento](/api-reference/pagamentos/create-refund)
    - [Cancelar autorização de cartão](/api-reference/pagamentos/cancel-payment)
    - [Listar pagamentos](/api-reference/pagamentos/list-payments)
    - [Consultar pagamento](/api-reference/pagamentos/get-payment)
    - [Linha do tempo do pagamento](/api-reference/pagamentos/get-payment-timeline)
    - [Tarifas do pagamento](/api-reference/pagamentos/get-payment-fees)
    - [Comprovante do pagamento](/api-reference/pagamentos/get-payment-receipt)
  - Clientes
    - [Listar clientes](/api-reference/clientes/list-customers)
    - [Cadastrar cliente](/api-reference/clientes/create-customer)
    - [Consultar cliente](/api-reference/clientes/get-customer)
    - [Atualizar cliente](/api-reference/clientes/update-customer)
  - Cartões
    - [Listar cartões do cliente](/api-reference/cartoes/list-cards)
    - [Salvar cartão no cofre](/api-reference/cartoes/create-card)
    - [Consultar cartão](/api-reference/cartoes/get-card)
    - [Inativar cartão](/api-reference/cartoes/delete-card)
  - Links de pagamento
    - [Listar links de pagamento](/api-reference/links-de-pagamento/list-payment-links)
    - [Criar link de pagamento](/api-reference/links-de-pagamento/create-payment-link)
    - [Consultar link de pagamento](/api-reference/links-de-pagamento/get-payment-link)
    - [Cancelar link de pagamento](/api-reference/links-de-pagamento/cancel-payment-link)
  - Saldo e extrato
    - [Consultar saldo](/api-reference/saldo-e-extrato/get-balance)
    - [Consultar extrato](/api-reference/saldo-e-extrato/get-statement)
  - Liquidações
    - [Listar liquidações](/api-reference/liquidacoes/list-settlements)
    - [Consultar liquidação](/api-reference/liquidacoes/get-settlement)
  - Saques
    - [Listar saques](/api-reference/saques/list-withdrawals)
    - [Solicitar saque](/api-reference/saques/create-withdrawal)
    - [Consultar saque](/api-reference/saques/get-withdrawal)
  - Destinos de saque
    - [Listar contas bancárias de saque](/api-reference/destinos-de-saque/list-bank-accounts)
    - [Cadastrar conta bancária de saque](/api-reference/destinos-de-saque/create-bank-account)
    - [Remover conta bancária de saque](/api-reference/destinos-de-saque/delete-bank-account)
    - [Listar chaves PIX de saque](/api-reference/destinos-de-saque/list-pix-keys)
    - [Cadastrar chave PIX de saque](/api-reference/destinos-de-saque/create-pix-key)
    - [Remover chave PIX de saque](/api-reference/destinos-de-saque/delete-pix-key)
  - Webhook endpoints
    - [Listar webhook endpoints](/api-reference/webhook-endpoints/list-webhook-endpoints)
    - [Criar webhook endpoint](/api-reference/webhook-endpoints/create-webhook-endpoint)
    - [Consultar webhook endpoint](/api-reference/webhook-endpoints/get-webhook-endpoint)
    - [Atualizar webhook endpoint](/api-reference/webhook-endpoints/update-webhook-endpoint)
    - [Excluir webhook endpoint](/api-reference/webhook-endpoints/delete-webhook-endpoint)
    - [Rotacionar segredo do webhook endpoint](/api-reference/webhook-endpoints/rotate-webhook-endpoint-secret)
    - [Testar webhook endpoint](/api-reference/webhook-endpoints/test-webhook-endpoint)
    - [Listar entregas do webhook endpoint](/api-reference/webhook-endpoints/list-webhook-deliveries)
  - Eventos
    - [Listar eventos](/api-reference/eventos/list-events)
    - [Consultar evento](/api-reference/eventos/get-event)
    - [Reentregar evento](/api-reference/eventos/redeliver-event)
  - Webhooks
    - [Pagamento concluído](/api-reference/webhooks/on-payment-succeeded)
    - [Pagamento falhou](/api-reference/webhooks/on-payment-failed)
    - [Estorno concluído](/api-reference/webhooks/on-payment-refunded)
    - [Chargeback recebido](/api-reference/webhooks/on-chargeback-received)
    - [Saque concluído](/api-reference/webhooks/on-withdrawal-completed)
    - [Saque falhou](/api-reference/webhooks/on-withdrawal-failed)
    - [Liquidação fechada](/api-reference/webhooks/on-settlement-closed)
    - [Webhook endpoint auto-desativado](/api-reference/webhooks/on-webhook-endpoint-disabled)
    - [Ping de teste](/api-reference/webhooks/on-ping)
    - [Câmbio liquidado](/api-reference/webhooks/on-fx-operation-settled)
    - [Câmbio expirou](/api-reference/webhooks/on-fx-operation-expired)
    - [Câmbio falhou](/api-reference/webhooks/on-fx-operation-failed)
    - [Câmbio requer ação](/api-reference/webhooks/on-fx-operation-action-required)
    - [Câmbio devolvido](/api-reference/webhooks/on-fx-operation-refunded)
  - Contratos
    - [Listar contratos](/api-reference/contratos/list-contracts)
    - [Emitir contrato](/api-reference/contratos/create-contract)
    - [Consultar contrato](/api-reference/contratos/get-contract)
    - [Cancelar contrato](/api-reference/contratos/cancel-contract)
    - [Baixar contrato assinado](/api-reference/contratos/get-contract-signed-file)
    - [Adicionar signatário](/api-reference/contratos/add-contract-signer)
    - [Alterar signatário](/api-reference/contratos/update-contract-signer)
    - [Remover signatário](/api-reference/contratos/remove-contract-signer)
    - [Reenviar pedido de assinatura](/api-reference/contratos/resend-contract-signer)
  - Modelos de contrato
    - [Listar modelos de contrato](/api-reference/modelos-de-contrato/list-contract-templates)
    - [Enviar modelo de contrato](/api-reference/modelos-de-contrato/create-contract-template)
    - [Analisar modelo de contrato](/api-reference/modelos-de-contrato/analyze-contract-template)
    - [Consultar modelo de contrato](/api-reference/modelos-de-contrato/get-contract-template)
  - Arquivos de contrato
    - [Listar arquivos de contrato](/api-reference/arquivos-de-contrato/list-contract-files)
    - [Enviar PDF de contrato](/api-reference/arquivos-de-contrato/create-contract-file)
  - Caução
    - [Listar cauções](/api-reference/caucao/list-deposits)
    - [Abrir caução](/api-reference/caucao/create-deposit)
    - [Consultar caução](/api-reference/caucao/get-deposit)
    - [Preparar envio de evidências](/api-reference/caucao/create-deposit-evidence-uploads)
    - [Capturar caução](/api-reference/caucao/capture-deposit)
    - [Liberar caução](/api-reference/caucao/release-deposit)
  - Câmbio
    - [Simular cotação](/api-reference/cambio/preview-fx-quote)
    - [Criar cotação](/api-reference/cambio/create-fx-quote)
    - [Listar operações de câmbio](/api-reference/cambio/list-fx-operations)
    - [Criar operação de câmbio](/api-reference/cambio/create-fx-operation)
    - [Consultar operação de câmbio](/api-reference/cambio/get-fx-operation)
    - [Obter comprovante da operação](/api-reference/cambio/get-fx-operation-receipt)
  - Contas de câmbio
    - [Listar contas de destino](/api-reference/contas-de-cambio/list-fx-payout-accounts)
    - [Cadastrar conta de destino](/api-reference/contas-de-cambio/create-fx-payout-account)
    - [Consultar conta de destino](/api-reference/contas-de-cambio/get-fx-payout-account)
    - [Desativar conta de destino](/api-reference/contas-de-cambio/delete-fx-payout-account)
    - [Enviar documento da conta de destino](/api-reference/contas-de-cambio/upload-fx-payout-account-document)
- SDKs
  - [SDKs](/sdks): Bibliotecas oficiais da Kodano.
- Changelog
  - [Changelog](/changelog): Mudanças na API Kodano e nesta documentação.