# Chargefy

> Pagamentos & Billing para o Brasil. PIX, Cartão, Boleto e Recorrência.

## Docs

- [GET /api/v1/accounts/kyc/documents](https://scaleup-c34c4386.mintlify.app/api-reference/accounts/kyc/get-documents.md): Retorna o status dos documentos KYC do seller de uma organização, incluindo quais documentos já foram enviados e quais ainda estão pendentes.
- [POST /api/v1/accounts/kyc/documents](https://scaleup-c34c4386.mintlify.app/api-reference/accounts/kyc/upload-document.md): Faz upload de um documento KYC para o seller de uma organização. Aceita imagens e PDF (apenas CNH_FULL). Limite de 3 MB por arquivo.
- [POST /api/v1/accounts/onboarding/bank-account](https://scaleup-c34c4386.mintlify.app/api-reference/accounts/onboarding/bank-account.md): Associa uma conta bancária ao seller de uma organização para liquidação Zoop
- [POST /api/v1/accounts/onboarding/business](https://scaleup-c34c4386.mintlify.app/api-reference/accounts/onboarding/business.md): Cadastra um seller Pessoa Jurídica (CNPJ) no gateway de pagamentos para habilitar recebimentos
- [GET /api/v1/accounts/onboarding/check](https://scaleup-c34c4386.mintlify.app/api-reference/accounts/onboarding/check.md): Verifica se já existe um seller cadastrado para um determinado CPF ou CNPJ
- [GET /api/v1/accounts/onboarding/:sellerId](https://scaleup-c34c4386.mintlify.app/api-reference/accounts/onboarding/get.md): Retorna o status atualizado de um seller, consultando diretamente o gateway de pagamentos
- [POST /api/v1/accounts/onboarding/individual](https://scaleup-c34c4386.mintlify.app/api-reference/accounts/onboarding/individual.md): Cadastra um seller Pessoa Física (CPF) no gateway de pagamentos para habilitar recebimentos
- [POST /api/v1/accounts/onboarding/sync-status](https://scaleup-c34c4386.mintlify.app/api-reference/accounts/onboarding/sync-status.md): Sincroniza o status de todos os sellers pendentes das organizações do usuário com o gateway de pagamentos
- [POST /api/v1/buyers/cards/associate](https://scaleup-c34c4386.mintlify.app/api-reference/buyers/cards-associate.md): Associa um cartão tokenizado a um comprador no gateway de pagamentos
- [POST /api/v1/buyers/](https://scaleup-c34c4386.mintlify.app/api-reference/buyers/create.md): Cria um novo comprador no gateway de pagamentos e salva no banco de dados local
- [GET /api/v1/buyers/:email/transactions](https://scaleup-c34c4386.mintlify.app/api-reference/buyers/get-transactions.md): Lista todas as transações realizadas por um comprador identificado pelo e-mail
- [GET /api/v1/buyers/](https://scaleup-c34c4386.mintlify.app/api-reference/buyers/list.md): Retorna uma lista paginada de compradores da organização
- [GET /api/v1/buyers/lookup/:email](https://scaleup-c34c4386.mintlify.app/api-reference/buyers/lookup.md): Busca um comprador pelo e-mail com prioridade: cliente da organização → registro global
- [POST /api/v1/checkout-links/](https://scaleup-c34c4386.mintlify.app/api-reference/checkout-links/create.md): Cria um novo link de checkout compartilhável
- [DELETE /api/v1/checkout-links/:id](https://scaleup-c34c4386.mintlify.app/api-reference/checkout-links/delete.md): Remove (soft delete) um link de checkout
- [GET /api/v1/checkout-links/:id](https://scaleup-c34c4386.mintlify.app/api-reference/checkout-links/get.md): Retorna os detalhes de um link de checkout específico
- [GET /api/v1/checkout-links/:client_secret/redirect](https://scaleup-c34c4386.mintlify.app/api-reference/checkout-links/get-redirect.md): Endpoint público que cria uma sessão de checkout e redireciona o visitante para a página de pagamento
- [GET /api/v1/checkout-links/](https://scaleup-c34c4386.mintlify.app/api-reference/checkout-links/list.md): Retorna uma lista paginada de links de checkout
- [PATCH /api/v1/checkout-links/:id](https://scaleup-c34c4386.mintlify.app/api-reference/checkout-links/update.md): Atualiza um link de checkout existente
- [GET /api/v1/checkouts/client/:client_secret/stream](https://scaleup-c34c4386.mintlify.app/api-reference/checkouts/client-stream.md): Conexão Server-Sent Events para receber atualizações em tempo real do status do checkout
- [PATCH /api/v1/checkouts/client/:client_secret](https://scaleup-c34c4386.mintlify.app/api-reference/checkouts/client-update.md): Atualiza os dados do cliente em um checkout antes da confirmação do pagamento
- [POST /api/v1/checkouts/client/:client_secret/confirm](https://scaleup-c34c4386.mintlify.app/api-reference/checkouts/confirm.md): Confirma o checkout e processa o pagamento pelo método escolhido (PIX ou Cartão de Crédito)
- [POST /api/v1/checkouts/client/:client_secret/confirm-sdk](https://scaleup-c34c4386.mintlify.app/api-reference/checkouts/confirm-sdk.md): Confirma o checkout com tokenização do cartão server-side — ideal para integrações via SDK sem SDK de tokenização no cliente
- [POST /api/v1/checkouts/](https://scaleup-c34c4386.mintlify.app/api-reference/checkouts/create.md): Cria uma nova sessão de checkout para processamento de pagamento
- [GET /api/v1/checkouts/:id](https://scaleup-c34c4386.mintlify.app/api-reference/checkouts/get.md): Retorna os detalhes de um checkout específico pelo ID
- [GET /api/v1/checkouts/client/:client_secret](https://scaleup-c34c4386.mintlify.app/api-reference/checkouts/get-by-secret.md): Recupera um checkout pelo client secret para uso no frontend
- [GET /api/v1/checkouts/installment-options](https://scaleup-c34c4386.mintlify.app/api-reference/checkouts/installment-options.md): Retorna as opções de parcelamento disponíveis para um valor específico
- [GET /api/v1/checkouts/](https://scaleup-c34c4386.mintlify.app/api-reference/checkouts/list.md): Retorna uma lista paginada de sessões de checkout
- [PATCH /api/v1/checkouts/:id](https://scaleup-c34c4386.mintlify.app/api-reference/checkouts/update.md): Atualiza uma sessão de checkout existente
- [Obter Cliente](https://scaleup-c34c4386.mintlify.app/api-reference/customer-portal/get-customer.md): Retorna o perfil do cliente autenticado no portal do cliente.
- [Obter Organização](https://scaleup-c34c4386.mintlify.app/api-reference/customer-portal/get-organization.md): Retorna os detalhes da organização associada ao cliente autenticado.
- [Criar Sessão](https://scaleup-c34c4386.mintlify.app/api-reference/customer-portal/sessions/create.md): Cria uma sessão de cliente via e-mail com magic link ou ID da organização.
- [Cancelar Assinatura](https://scaleup-c34c4386.mintlify.app/api-reference/customer-portal/subscriptions/cancel.md): Cancela uma assinatura do cliente autenticado.
- [Obter Assinatura](https://scaleup-c34c4386.mintlify.app/api-reference/customer-portal/subscriptions/get.md): Retorna os detalhes de uma assinatura específica do cliente autenticado.
- [Listar Assinaturas](https://scaleup-c34c4386.mintlify.app/api-reference/customer-portal/subscriptions/list.md): Lista todas as assinaturas do cliente autenticado.
- [Atualizar Assinatura](https://scaleup-c34c4386.mintlify.app/api-reference/customer-portal/subscriptions/update.md): Atualiza uma assinatura do cliente, como troca de plano.
- [POST /api/v1/customers/:id/checkout-link](https://scaleup-c34c4386.mintlify.app/api-reference/customers/checkout-link.md): Gera um link de checkout pré-preenchido e bloqueado para um cliente específico
- [POST /api/v1/customers](https://scaleup-c34c4386.mintlify.app/api-reference/customers/create.md): Cria um novo cliente na organização
- [DELETE /api/v1/customers/:id](https://scaleup-c34c4386.mintlify.app/api-reference/customers/delete.md): Remove um cliente da organização (soft delete)
- [DELETE /api/v1/customers/external/:external_id](https://scaleup-c34c4386.mintlify.app/api-reference/customers/delete-external.md): Remove um cliente pelo seu identificador externo (soft delete)
- [GET /api/v1/customers/export](https://scaleup-c34c4386.mintlify.app/api-reference/customers/export.md): Exporta todos os clientes da organização em formato CSV
- [GET /api/v1/customers/:id](https://scaleup-c34c4386.mintlify.app/api-reference/customers/get.md): Retorna os detalhes de um cliente específico pelo ID
- [GET /api/v1/customers/external/:external_id](https://scaleup-c34c4386.mintlify.app/api-reference/customers/get-external.md): Retorna um cliente pelo seu identificador externo
- [GET /api/v1/customers](https://scaleup-c34c4386.mintlify.app/api-reference/customers/list.md): Retorna uma lista paginada de clientes da organização
- [PATCH /api/v1/customers/:id](https://scaleup-c34c4386.mintlify.app/api-reference/customers/update.md): Atualiza os dados de um cliente existente pelo seu ID
- [PATCH /api/v1/customers/external/:external_id](https://scaleup-c34c4386.mintlify.app/api-reference/customers/update-external.md): Atualiza os dados de um cliente pelo seu identificador externo
- [POST /api/v1/discounts/](https://scaleup-c34c4386.mintlify.app/api-reference/discounts/create.md): Cria um novo desconto ou cupom
- [DELETE /api/v1/discounts/:id](https://scaleup-c34c4386.mintlify.app/api-reference/discounts/delete.md): Remove um desconto permanentemente
- [GET /api/v1/discounts/:id](https://scaleup-c34c4386.mintlify.app/api-reference/discounts/get.md): Retorna os detalhes de um desconto específico
- [GET /api/v1/discounts/](https://scaleup-c34c4386.mintlify.app/api-reference/discounts/list.md): Retorna uma lista paginada de descontos da organização
- [PATCH /api/v1/discounts/:id](https://scaleup-c34c4386.mintlify.app/api-reference/discounts/update.md): Atualiza as propriedades de um desconto existente
- [POST /api/v1/files/](https://scaleup-c34c4386.mintlify.app/api-reference/files/create.md): Faz upload de um novo arquivo via multipart form-data
- [DELETE /api/v1/files/:id](https://scaleup-c34c4386.mintlify.app/api-reference/files/delete.md): Remove um arquivo permanentemente
- [GET /api/v1/files/](https://scaleup-c34c4386.mintlify.app/api-reference/files/list.md): Retorna uma lista paginada de arquivos da organização
- [PATCH /api/v1/files/:id](https://scaleup-c34c4386.mintlify.app/api-reference/files/update.md): Atualiza os metadados de um arquivo existente
- [API Reference](https://scaleup-c34c4386.mintlify.app/api-reference/introduction.md): Referência completa da API REST da Chargefy
- [POST /api/v1/invites/:token/accept](https://scaleup-c34c4386.mintlify.app/api-reference/invites/accept.md): Aceita um convite de organização, adicionando o usuário autenticado como membro.
- [GET /api/v1/invites/:token](https://scaleup-c34c4386.mintlify.app/api-reference/invites/get.md): Retorna os detalhes de um convite de organização a partir do token. Endpoint público.
- [GET /api/v1/invites/pending-for-me](https://scaleup-c34c4386.mintlify.app/api-reference/invites/pending-for-me.md): Retorna todos os convites de organização pendentes para o e-mail do usuário autenticado.
- [GET /api/v1/metrics](https://scaleup-c34c4386.mintlify.app/api-reference/metrics/get.md): Retorna métricas e analytics da organização
- [POST /api/v1/organizations/](https://scaleup-c34c4386.mintlify.app/api-reference/organizations/create.md): Cria uma nova organização e associa ao usuário autenticado
- [DELETE /api/v1/organizations/:id/invites/:inviteId](https://scaleup-c34c4386.mintlify.app/api-reference/organizations/delete-invite.md): Revoga um convite pendente de uma organização
- [GET /api/v1/organizations/:id](https://scaleup-c34c4386.mintlify.app/api-reference/organizations/get.md): Retorna os detalhes de uma organização específica
- [GET /api/v1/organizations/:id/account](https://scaleup-c34c4386.mintlify.app/api-reference/organizations/get-account.md): Retorna a conta de pagamento associada à organização
- [GET /api/v1/organizations/:id/bank-account](https://scaleup-c34c4386.mintlify.app/api-reference/organizations/get-bank-account.md): Retorna a conta bancária ativa da organização, sincronizando com o gateway de pagamentos se necessário
- [GET /api/v1/organizations/:id/invites](https://scaleup-c34c4386.mintlify.app/api-reference/organizations/get-invites.md): Lista os convites pendentes e não expirados de uma organização
- [GET /api/v1/organizations/me](https://scaleup-c34c4386.mintlify.app/api-reference/organizations/get-me.md): Retorna a organização associada ao Supabase JWT utilizado
- [GET /api/v1/organizations/:id/members](https://scaleup-c34c4386.mintlify.app/api-reference/organizations/get-members.md): Lista os membros ativos de uma organização
- [GET /api/v1/organizations/:id/payment-status](https://scaleup-c34c4386.mintlify.app/api-reference/organizations/get-payment-status.md): Retorna o status de onboarding de pagamentos da organização
- [GET /api/v1/organizations/:id/sub-organizations](https://scaleup-c34c4386.mintlify.app/api-reference/organizations/get-sub-organizations.md): Retorna as organizações filhas diretamente vinculadas à organização
- [GET /api/v1/organizations/](https://scaleup-c34c4386.mintlify.app/api-reference/organizations/list.md): Retorna as organizações associadas ao usuário autenticado
- [POST /api/v1/organizations/:id/members/invite](https://scaleup-c34c4386.mintlify.app/api-reference/organizations/members-invite.md): Envia um convite por e-mail para um novo membro entrar na organização
- [PATCH /api/v1/organizations/:id](https://scaleup-c34c4386.mintlify.app/api-reference/organizations/update.md): Atualiza as configurações de uma organização
- [POST /api/v1/payment-updates/:token/confirm](https://scaleup-c34c4386.mintlify.app/api-reference/payment-updates/confirm.md): Atualiza o cartão de pagamento da assinatura usando um token de atualização
- [GET /api/v1/payment-updates/:token](https://scaleup-c34c4386.mintlify.app/api-reference/payment-updates/get.md): Retorna as informações da assinatura vinculada a um token de atualização de pagamento
- [GET /api/v1/payment-updates/:token/transactions](https://scaleup-c34c4386.mintlify.app/api-reference/payment-updates/get-transactions.md): Retorna o histórico de transações da assinatura vinculada ao token de atualização
- [POST /functions/v1/create-price](https://scaleup-c34c4386.mintlify.app/api-reference/prices/create.md): Cria um product_price vinculado a um produto existente, no formato Stripe-like.
- [PATCH /functions/v1/update-price](https://scaleup-c34c4386.mintlify.app/api-reference/prices/update.md): Atualiza campos mutáveis de um product_price. Stripe-like — campos de valor são imutáveis.
- [POST /api/v1/products/](https://scaleup-c34c4386.mintlify.app/api-reference/products/create.md): Cria um produto com um ou mais preços inline (shape Stripe-like)
- [GET /api/v1/products/:id](https://scaleup-c34c4386.mintlify.app/api-reference/products/get.md): Retorna um produto com todos os preços
- [GET /api/v1/products/](https://scaleup-c34c4386.mintlify.app/api-reference/products/list.md): Retorna uma lista paginada de produtos da organização
- [PATCH /api/v1/products/:id](https://scaleup-c34c4386.mintlify.app/api-reference/products/update.md): Atualiza campos de um produto existente
- [POST /api/v1/refunds/](https://scaleup-c34c4386.mintlify.app/api-reference/refunds/create.md): Cria um novo reembolso para uma venda
- [GET /api/v1/refunds/](https://scaleup-c34c4386.mintlify.app/api-reference/refunds/list.md): Retorna uma lista paginada de reembolsos da organização
- [GET /api/v1/sales/:id](https://scaleup-c34c4386.mintlify.app/api-reference/sales/get.md): Retorna os detalhes completos de uma venda específica pelo seu identificador único.
- [GET /api/v1/sales/](https://scaleup-c34c4386.mintlify.app/api-reference/sales/list.md): Retorna uma lista paginada de vendas da organização, com suporte a filtros por cliente, produto, status e tipo de pagamento.
- [POST /api/v1/sales/:id/refund](https://scaleup-c34c4386.mintlify.app/api-reference/sales/refund.md): Solicita o estorno total ou parcial de uma venda aprovada.
- [PATCH /api/v1/sales/:id](https://scaleup-c34c4386.mintlify.app/api-reference/sales/update.md): Atualiza os metadados de uma venda existente.
- [GET /api/v1/sdk/organizations/check-existing](https://scaleup-c34c4386.mintlify.app/api-reference/sdk/organizations/check-existing.md): Verifica se já existe uma organização cadastrada para um determinado CPF/CNPJ e tipo de vendedor.
- [POST /api/v1/sdk/organizations/:orgId/checkouts](https://scaleup-c34c4386.mintlify.app/api-reference/sdk/organizations/checkouts-create.md): Cria uma sessão de checkout garantindo que os produtos pertencem à sub-organização do path; autenticação com JWT da organização pai.
- [GET /api/v1/sdk/organizations/:orgId/checkouts/:checkoutId](https://scaleup-c34c4386.mintlify.app/api-reference/sdk/organizations/checkouts-get.md): Retorna um checkout por ID somente se o produto principal da sessão pertence à sub-organização do path.
- [GET /api/v1/sdk/organizations/:orgId/checkouts](https://scaleup-c34c4386.mintlify.app/api-reference/sdk/organizations/checkouts-list.md): Lista sessões de checkout cujo produto principal pertence à sub-organização indicada no path, usando o JWT da organização pai.
- [PATCH /api/v1/sdk/organizations/:orgId/checkouts/:checkoutId](https://scaleup-c34c4386.mintlify.app/api-reference/sdk/organizations/checkouts-update.md): Atualiza uma sessão de checkout aberta, desde que pertença à sub-organização do path; valida troca de produto/preço contra :orgId.
- [POST /api/v1/sdk/organizations](https://scaleup-c34c4386.mintlify.app/api-reference/sdk/organizations/create.md): Cria uma nova sub-organização vinculada à organização pai autenticada.
- [POST /api/v1/sdk/organizations/:orgId/products](https://scaleup-c34c4386.mintlify.app/api-reference/sdk/organizations/create-product.md): Cria um produto em nome de uma sub-organização filha, gerenciado pela organização pai autenticada.
- [POST /api/v1/sdk/organizations/:orgId/discounts](https://scaleup-c34c4386.mintlify.app/api-reference/sdk/organizations/discounts-create.md): Cria um desconto em nome de uma sub-organização filha, gerenciado pela organização pai autenticada.
- [DELETE /api/v1/sdk/organizations/:orgId/discounts/:id](https://scaleup-c34c4386.mintlify.app/api-reference/sdk/organizations/discounts-delete.md): Remove (soft delete) um desconto de uma sub-organização filha.
- [GET /api/v1/sdk/organizations/:orgId/discounts/:id](https://scaleup-c34c4386.mintlify.app/api-reference/sdk/organizations/discounts-get.md): Retorna os detalhes de um desconto específico de uma sub-organização filha.
- [GET /api/v1/sdk/organizations/:orgId/discounts](https://scaleup-c34c4386.mintlify.app/api-reference/sdk/organizations/discounts-list.md): Lista todos os descontos de uma sub-organização filha, gerenciados pela organização pai autenticada.
- [PATCH /api/v1/sdk/organizations/:orgId/discounts/:id](https://scaleup-c34c4386.mintlify.app/api-reference/sdk/organizations/discounts-update.md): Atualiza parcialmente um desconto de uma sub-organização filha.
- [POST /api/v1/sdk/organizations/:orgId/link-as-parent](https://scaleup-c34c4386.mintlify.app/api-reference/sdk/organizations/link-as-parent.md): Vincula a organização autenticada como pai de outra organização, definindo a taxa de comissão aplicada.
- [GET /api/v1/sdk/organizations](https://scaleup-c34c4386.mintlify.app/api-reference/sdk/organizations/list.md): Retorna a lista de sub-organizações filhas vinculadas à organização pai autenticada.
- [GET /api/v1/sdk/organizations/:orgId/products](https://scaleup-c34c4386.mintlify.app/api-reference/sdk/organizations/products-list.md): Lista o catálogo de produtos de uma sub-organização filha, com filtros e paginação, usando o token da organização pai.
- [PATCH /api/v1/sdk/organizations/:orgId/products/:productId](https://scaleup-c34c4386.mintlify.app/api-reference/sdk/organizations/products-update.md): Atualiza um produto pertencente à sub-organização filha, autenticando com o Organization Access Token da organização pai.
- [DELETE /api/v1/subscriptions/:id](https://scaleup-c34c4386.mintlify.app/api-reference/subscriptions/cancel.md): Cancela uma assinatura imediatamente ou agenda o cancelamento ao fim do período
- [POST /api/v1/subscriptions/:id/invoices](https://scaleup-c34c4386.mintlify.app/api-reference/subscriptions/create-invoices.md): Cria uma cobrança avulsa (invoice) para uma assinatura ativa
- [GET /api/v1/subscriptions/export](https://scaleup-c34c4386.mintlify.app/api-reference/subscriptions/export.md): Exporta todas as assinaturas da organização como arquivo CSV
- [GET /api/v1/subscriptions/:id](https://scaleup-c34c4386.mintlify.app/api-reference/subscriptions/get.md): Retorna os detalhes de uma assinatura específica
- [GET /api/v1/subscriptions/:id/transactions](https://scaleup-c34c4386.mintlify.app/api-reference/subscriptions/get-transactions.md): Lista todas as transações de cobrança de uma assinatura
- [GET /api/v1/subscriptions/](https://scaleup-c34c4386.mintlify.app/api-reference/subscriptions/list.md): Retorna uma lista paginada de assinaturas da organização
- [POST /api/v1/subscriptions/:id/manual-renewal-checkout](https://scaleup-c34c4386.mintlify.app/api-reference/subscriptions/manual-renewal-checkout.md): Cria um checkout aberto para renovação de um período de cobrança em assinaturas com cobrança manual
- [POST /api/v1/subscriptions/:id/payment-update-token](https://scaleup-c34c4386.mintlify.app/api-reference/subscriptions/payment-update-token.md): Gera um link temporário (48h) para o cliente atualizar o cartão de pagamento da assinatura
- [PATCH /api/v1/subscriptions/:id](https://scaleup-c34c4386.mintlify.app/api-reference/subscriptions/update.md): Atualiza uma assinatura existente, como trocar de plano, aplicar desconto ou agendar cancelamento
- [PATCH /api/v1/subscriptions/:id/billing](https://scaleup-c34c4386.mintlify.app/api-reference/subscriptions/update-billing.md): Atualiza a data de vencimento e/ou o valor de uma assinatura ativa
- [POST /api/v1/transactions/direct](https://scaleup-c34c4386.mintlify.app/api-reference/transactions/direct.md): Processa um pagamento direto via cartão de crédito ou PIX a partir do navegador do comprador, sem intermediação de servidor.
- [GET /api/v1/transactions/:transaction_id](https://scaleup-c34c4386.mintlify.app/api-reference/transactions/get.md): Retorna os detalhes de uma transação pelo identificador no gateway de pagamentos, utilizado principalmente na página de confirmação do checkout.
- [GET /api/v1/transactions/direct/seller-config](https://scaleup-c34c4386.mintlify.app/api-reference/transactions/seller-config.md): Retorna as configurações do vendedor necessárias para iniciar uma transação direta, como seller_id e marketplace_id.
- [checkout.created](https://scaleup-c34c4386.mintlify.app/api-reference/webhooks/checkout.created.md): Disparado quando um novo checkout é iniciado.
- [checkout.updated](https://scaleup-c34c4386.mintlify.app/api-reference/webhooks/checkout.updated.md): Disparado quando o status de um checkout é atualizado.
- [customer.created](https://scaleup-c34c4386.mintlify.app/api-reference/webhooks/customer.created.md): Disparado quando um novo cliente é criado na plataforma.
- [customer.deleted](https://scaleup-c34c4386.mintlify.app/api-reference/webhooks/customer.deleted.md): Disparado quando um cliente é removido da plataforma.
- [customer.state_changed](https://scaleup-c34c4386.mintlify.app/api-reference/webhooks/customer.state_changed.md): Disparado quando o estado de um cliente muda (ex: ativo para inativo).
- [customer.updated](https://scaleup-c34c4386.mintlify.app/api-reference/webhooks/customer.updated.md): Disparado quando os dados de um cliente são atualizados.
- [POST /api/v1/webhook-endpoints/](https://scaleup-c34c4386.mintlify.app/api-reference/webhooks/endpoints/create.md): Cria um novo endpoint de webhook
- [DELETE /api/v1/webhook-endpoints/:id](https://scaleup-c34c4386.mintlify.app/api-reference/webhooks/endpoints/delete.md): Remove um endpoint de webhook permanentemente
- [GET /api/v1/webhook-endpoints/:id](https://scaleup-c34c4386.mintlify.app/api-reference/webhooks/endpoints/get.md): Retorna os detalhes de um endpoint de webhook
- [GET /api/v1/webhook-endpoints/](https://scaleup-c34c4386.mintlify.app/api-reference/webhooks/endpoints/list.md): Retorna uma lista paginada de endpoints de webhook
- [PATCH /api/v1/webhook-endpoints/:id](https://scaleup-c34c4386.mintlify.app/api-reference/webhooks/endpoints/update.md): Atualiza as configurações de um endpoint de webhook
- [hosted_flow.completed](https://scaleup-c34c4386.mintlify.app/api-reference/webhooks/hosted_flow.completed.md): Disparado quando um seller submete o cadastro do hosted flow.
- [organization.updated](https://scaleup-c34c4386.mintlify.app/api-reference/webhooks/organization.updated.md): Disparado quando os dados de uma organização são atualizados.
- [product.created](https://scaleup-c34c4386.mintlify.app/api-reference/webhooks/product.created.md): Disparado quando um novo produto é criado.
- [product.updated](https://scaleup-c34c4386.mintlify.app/api-reference/webhooks/product.updated.md): Disparado quando um produto é atualizado.
- [refund.created](https://scaleup-c34c4386.mintlify.app/api-reference/webhooks/refund.created.md): Disparado quando uma solicitação de reembolso é criada.
- [refund.updated](https://scaleup-c34c4386.mintlify.app/api-reference/webhooks/refund.updated.md): Disparado quando o status de um reembolso é atualizado.
- [suborganization.created](https://scaleup-c34c4386.mintlify.app/api-reference/webhooks/suborganization.created.md): Disparado quando uma sub-organização é criada e vinculada à plataforma.
- [suborganization.product_updated](https://scaleup-c34c4386.mintlify.app/api-reference/webhooks/suborganization.product_updated.md): Disparado quando um produto de uma suborganização é atualizado.
- [suborganization.subscription_canceled](https://scaleup-c34c4386.mintlify.app/api-reference/webhooks/suborganization.subscription_canceled.md): Disparado quando uma assinatura de uma suborganização é cancelada.
- [suborganization.subscription_created](https://scaleup-c34c4386.mintlify.app/api-reference/webhooks/suborganization.subscription_created.md): Disparado quando uma assinatura é criada em um produto de uma suborganização.
- [suborganization.subscription_updated](https://scaleup-c34c4386.mintlify.app/api-reference/webhooks/suborganization.subscription_updated.md): Disparado quando uma assinatura de uma suborganização é atualizada.
- [suborganization.updated](https://scaleup-c34c4386.mintlify.app/api-reference/webhooks/suborganization.updated.md): Disparado quando o status de ativação financeira de uma sub-organização muda.
- [subscription.active](https://scaleup-c34c4386.mintlify.app/api-reference/webhooks/subscription.active.md): Disparado quando uma assinatura se torna ativa.
- [subscription.canceled](https://scaleup-c34c4386.mintlify.app/api-reference/webhooks/subscription.canceled.md): Disparado quando uma assinatura é cancelada.
- [subscription.created](https://scaleup-c34c4386.mintlify.app/api-reference/webhooks/subscription.created.md): Disparado quando uma nova assinatura é criada.
- [subscription.revoked](https://scaleup-c34c4386.mintlify.app/api-reference/webhooks/subscription.revoked.md): Disparado quando uma assinatura é revogada imediatamente.
- [subscription.uncanceled](https://scaleup-c34c4386.mintlify.app/api-reference/webhooks/subscription.uncanceled.md): Disparado quando o cancelamento de uma assinatura é revertido.
- [subscription.updated](https://scaleup-c34c4386.mintlify.app/api-reference/webhooks/subscription.updated.md): Disparado quando uma assinatura é atualizada.
- [Changelog da API](https://scaleup-c34c4386.mintlify.app/changelog/api.md): Histórico de mudanças na API REST da Chargefy
- [Changelog](https://scaleup-c34c4386.mintlify.app/changelog/recent.md): Últimas atualizações e melhorias da plataforma Chargefy
- [Analytics](https://scaleup-c34c4386.mintlify.app/features/analytics.md): Acompanhe métricas de receita, assinaturas e clientes com o dashboard de analytics da Chargefy.
- [Checkout Embarcado](https://scaleup-c34c4386.mintlify.app/features/checkout/embed.md): Incorpore o checkout diretamente no seu site
- [Checkout Links](https://scaleup-c34c4386.mintlify.app/features/checkout/links.md): Venda seus produtos digitais compartilhando um link de checkout
- [Checkout API](https://scaleup-c34c4386.mintlify.app/features/checkout/session.md): Crie sessões de checkout programaticamente para controle total
- [Gestão de Clientes](https://scaleup-c34c4386.mintlify.app/features/customer-management.md): Gerencie seus clientes, visualize histórico de compras e assinaturas.
- [Portal do Cliente](https://scaleup-c34c4386.mintlify.app/features/customer-portal.md): Ofereça um portal self-service para seus clientes gerenciarem assinaturas, pagamentos e vendas.
- [Descontos](https://scaleup-c34c4386.mintlify.app/features/discounts.md): Crie e gerencie cupons de desconto fixos ou percentuais para seus checkouts.
- [Contas e KYC](https://scaleup-c34c4386.mintlify.app/features/finance/accounts.md): Gerencie contas de vendedor na Chargefy, incluindo verificação de identidade (KYC) para Pessoa Física e Jurídica.
- [Saldo e Movimentações](https://scaleup-c34c4386.mintlify.app/features/finance/balance.md): Consulte o saldo disponível, saldo a liberar e acompanhe todas as movimentações financeiras da sua conta.
- [Métodos de Pagamento](https://scaleup-c34c4386.mintlify.app/features/payment-methods.md): PIX, Cartão de Crédito e Boleto — todos os métodos de pagamento brasileiros em uma única plataforma
- [Preços](https://scaleup-c34c4386.mintlify.app/features/prices.md): Como modelar valores de cobrança na Chargefy
- [Produtos](https://scaleup-c34c4386.mintlify.app/features/products.md): Modele o que você vende e atrele preços — estilo Stripe.
- [Reembolsos](https://scaleup-c34c4386.mintlify.app/features/refunds.md): Processe reembolsos totais ou parciais para transações via PIX, Cartão de Crédito e Boleto.
- [Precificação por Quantidade](https://scaleup-c34c4386.mintlify.app/features/seat-based-pricing.md): Cobre por unidade/assento usando o campo quantity do checkout (modelo Stripe licensed)
- [Assinaturas & Recorrência](https://scaleup-c34c4386.mintlify.app/features/subscriptions.md): Gerencie cobranças recorrentes com o sistema de recorrência da Chargefy
- [Períodos Trial](https://scaleup-c34c4386.mintlify.app/features/trials.md): Ofereça períodos de teste gratuitos para seus clientes experimentarem antes de pagar
- [Múltiplas Assinaturas](https://scaleup-c34c4386.mintlify.app/guides/allow-multiple-subscriptions.md): Como permitir que clientes tenham varias assinaturas ativas simultaneamente na Chargefy
- [Guia Boleto Bancário](https://scaleup-c34c4386.mintlify.app/guides/boleto-checkout.md): Integre pagamento via Boleto Bancário com a Chargefy — gerar boleto, exibir linha digitável, aguardar compensação e tratar vencimento
- [Checkout com Cartão de Crédito](https://scaleup-c34c4386.mintlify.app/guides/card-checkout.md): Guia completo para integrar pagamentos com cartão de crédito — tokenização segura, parcelamento em até 12x, pré-autorização e captura
- [Variantes de Produto](https://scaleup-c34c4386.mintlify.app/guides/create-variants.md): Como criar variantes de produto com diferentes precos e intervalos de cobranca na Chargefy
- [Guia Express / Node.js](https://scaleup-c34c4386.mintlify.app/guides/express.md): Integre a Chargefy com Express — API de checkout, processamento de pagamentos PIX/Cartão/Boleto e webhooks
- [Guias](https://scaleup-c34c4386.mintlify.app/guides/introduction.md): Tutoriais passo a passo para integrar a Chargefy na sua aplicação
- [Guia Laravel](https://scaleup-c34c4386.mintlify.app/guides/laravel.md): Guia completo de integração da Chargefy com Laravel
- [Guia Next.js](https://scaleup-c34c4386.mintlify.app/guides/nextjs.md): Integre a Chargefy com Next.js — checkout com PIX, Cartão e Boleto, webhooks e gerenciamento de assinaturas
- [Marketplace: OAT da organização pai e sub-organizações](https://scaleup-c34c4386.mintlify.app/guides/parent-marketplace-suborganizations.md): Use apenas o token da sua organização (pai) para gerenciar clientes, checkouts e links de checkout das sub-organizações vinculadas.
- [Checkout PIX](https://scaleup-c34c4386.mintlify.app/guides/pix-checkout.md): Guia completo para integrar pagamentos PIX na Chargefy — QR Code, copia e cola, polling, webhooks e exemplos prontos para produção
- [Precificação por Assento](https://scaleup-c34c4386.mintlify.app/guides/seat-based-pricing.md): Guia passo a passo para implementar precificacao baseada em numero de usuarios (assentos) com a Chargefy
- [Downgrade de Assinatura](https://scaleup-c34c4386.mintlify.app/guides/subscription-downgrades.md): Como implementar downgrade de plano com controle de periodo e revogacao de recursos na Chargefy
- [Upgrade de Assinatura](https://scaleup-c34c4386.mintlify.app/guides/subscription-upgrades.md): Como implementar upgrade de plano com calculo de prorata e cobranca imediata na Chargefy
- [Assinaturas e Pagamentos Recorrentes](https://scaleup-c34c4386.mintlify.app/guides/subscriptions.md): Guia completo para implementar assinaturas e cobranças recorrentes com a Chargefy — criação de produtos, gerenciamento do ciclo de vida, webhooks e boas práticas
- [Gerenciar Api Keys](https://scaleup-c34c4386.mintlify.app/integrate/api-keys.md): Como criar, listar e revogar chaves de API no dashboard da Chargefy
- [Autenticação](https://scaleup-c34c4386.mintlify.app/integrate/authentication.md): Como autenticar suas requisições à API da Chargefy
- [Estado do Cliente](https://scaleup-c34c4386.mintlify.app/integrate/customer-state.md): Gerencie o estado do cliente na sua aplicação e mantenha sincronizado com a API Chargefy
- [Ambiente Sandbox](https://scaleup-c34c4386.mintlify.app/integrate/sandbox.md): Como usar o ambiente de testes da Chargefy para desenvolver e testar integrações
- [Astro Adapter](https://scaleup-c34c4386.mintlify.app/integrate/sdk/adapters/astro.md): Adapter do SDK Chargefy para Astro
- [Elysia Adapter](https://scaleup-c34c4386.mintlify.app/integrate/sdk/adapters/elysia.md): Adapter do SDK Chargefy para Elysia
- [Express Adapter](https://scaleup-c34c4386.mintlify.app/integrate/sdk/adapters/express.md): Adapter do SDK Chargefy para Express.js
- [Fastify Adapter](https://scaleup-c34c4386.mintlify.app/integrate/sdk/adapters/fastify.md): Adapter do SDK Chargefy para Fastify
- [Hono Adapter](https://scaleup-c34c4386.mintlify.app/integrate/sdk/adapters/hono.md): Adapter do SDK Chargefy para Hono
- [Laravel Adapter](https://scaleup-c34c4386.mintlify.app/integrate/sdk/adapters/laravel.md): Adapter do SDK Chargefy para Laravel
- [Next.js Adapter](https://scaleup-c34c4386.mintlify.app/integrate/sdk/adapters/nextjs.md): Adapter do SDK Chargefy para Next.js
- [Nuxt Adapter](https://scaleup-c34c4386.mintlify.app/integrate/sdk/adapters/nuxt.md): Adapter do SDK Chargefy para Nuxt
- [Remix Adapter](https://scaleup-c34c4386.mintlify.app/integrate/sdk/adapters/remix.md): Adapter do SDK Chargefy para Remix
- [SvelteKit Adapter](https://scaleup-c34c4386.mintlify.app/integrate/sdk/adapters/sveltekit.md): Adapter do SDK Chargefy para SvelteKit
- [SDK Go](https://scaleup-c34c4386.mintlify.app/integrate/sdk/golang.md): SDK Go para integração com a API Chargefy
- [SDK PHP](https://scaleup-c34c4386.mintlify.app/integrate/sdk/php.md): SDK PHP para integração com a API Chargefy
- [SDK Python](https://scaleup-c34c4386.mintlify.app/integrate/sdk/python.md): SDK Python para integração com a API Chargefy
- [SDK TypeScript](https://scaleup-c34c4386.mintlify.app/integrate/sdk/typescript.md): SDK oficial da Chargefy para TypeScript/Node.js
- [Webhook Delivery](https://scaleup-c34c4386.mintlify.app/integrate/webhooks/delivery.md): Mecanismo de entrega, retry automático e verificação de assinatura HMAC
- [Webhook Endpoints](https://scaleup-c34c4386.mintlify.app/integrate/webhooks/endpoints.md): Configure endpoints para receber notificações em tempo real de eventos da Chargefy
- [Webhook Events](https://scaleup-c34c4386.mintlify.app/integrate/webhooks/events.md): Lista completa de eventos de webhook disponíveis na Chargefy
- [Chargefy: Pagamentos & Billing para Plataformas](https://scaleup-c34c4386.mintlify.app/introduction.md): Plataforma completa de pagamentos com PIX, Cartão de Crédito, Boleto e Recorrência. Integre em minutos com nossa API e SDKs.
- [Política de Uso Aceitável](https://scaleup-c34c4386.mintlify.app/merchant-of-record/acceptable-use.md): Conheça as regras sobre o que pode e não pode ser vendido na plataforma Chargefy, restrições de conteúdo e processo de revisão.
- [Taxas e Custos](https://scaleup-c34c4386.mintlify.app/merchant-of-record/fees.md): Conheça as taxas da Chargefy por método de pagamento, custos de transferência e comparativo com o mercado.
- [Modelo de Negócio](https://scaleup-c34c4386.mintlify.app/merchant-of-record/introduction.md): Entenda como funciona o modelo de marketplace de pagamentos da Chargefy, o fluxo do dinheiro e as vantagens para o seu negócio.
- [Verificação KYC](https://scaleup-c34c4386.mintlify.app/merchant-of-record/kyc.md): Entenda o processo de verificação KYC (Know Your Customer) da Chargefy, documentos necessários e como consultar o status via API.
- [Países Atendidos](https://scaleup-c34c4386.mintlify.app/merchant-of-record/supported-countries.md): Saiba onde a Chargefy está disponível, requisitos de documentação e moedas suportadas.
- [Migração para Chargefy](https://scaleup-c34c4386.mintlify.app/migrate.md): Guia para migrar de outras plataformas de pagamento para a Chargefy.
- [Suporte](https://scaleup-c34c4386.mintlify.app/support.md): Entre em contato com a equipe da Chargefy para obter ajuda.

## OpenAPI Specs

- [openapi](https://scaleup-c34c4386.mintlify.app/api-reference/openapi.json)