Começar com o Pharos

Use o painel para gerenciar cobranças e operações financeiras ou conecte seu aplicativo ao checkout hospedado pela API.

Escolha por onde começar

Sua tarefa	Guia
Criar uma oferta e compartilhar seu link	Links de pagamento
Criar uma fatura para um cliente	Faturas
Gerenciar faturamento recorrente	Assinaturas
Revisar contas de fornecedores e preparar pagamentos	Pagamentos
Abrir uma conta financeira ou consultar o saldo	Contas financeiras
Integrar o checkout ao seu aplicativo	Cart Checkout

O cadastro cria uma conta de Produção. No seletor de contas, você pode criar outra conta, criar uma subconta que herda a equipe da conta principal ou abrir o Sandbox vinculado. Administradores também podem criar e abrir o Sandbox em Painel → Configurações → Sandboxes.

Um novo Sandbox não contém clientes, faturas, pagamentos, contas financeiras, integrações ou chaves de API. Configure os dados de teste e a conexão de pagamentos antes de testar. Confirme a conta e o ambiente ativos antes de fazer alterações.

Autenticação

Para integrar a API, crie uma chave nas configurações para desenvolvedores do painel. Todos os endpoints /api/v1 exigem o cabeçalho x-api-key. Mantenha a chave no servidor.

Esta solicitação usa um ambiente de desenvolvimento local:

curl -H 'x-api-key: YOUR_API_KEY' \
  'http://localhost:3000/api/v1/products?limit=20'

Primeira integração

Confirme a conta conectada com GET /api/v1/account e uma chave com permissão READ.
Liste produtos ou consulte IDs salvos com GET /api/v1/products/{id} ou GET /api/v1/products?ids[]=.... Consulte Paginação para interpretar listas e cursores.
Crie um link de pagamento reutilizável ou uma Checkout Session para um carrinho controlado pelo backend.
Configure Webhooks. Verifique as assinaturas e evite processar entregas duplicadas antes de entregar uma compra.
Conclua uma compra no Sandbox, confira a fatura e o pagamento e verifique o recebimento do evento assinado invoice.paid antes de passar para produção.

Guias principais

Conceitos principais

Produtos

Produtos descrevem o que você vende. Planos definem como você cobra, e preços indicam o valor em cada moeda.

Links de pagamento

Um link de pagamento é uma URL reutilizável do checkout hospedado. Ao iniciar o checkout, o Pharos cria ou retoma uma Checkout Session com uma cópia da oferta. Use o link para compartilhar a mesma oferta no seu site, em mensagens ou campanhas.

Webhooks

Webhooks notificam seu backend sobre eventos de checkout, pagamentos e assinaturas. O Pharos assina as entregas com Pharos-Signature. Um redirecionamento ou uma tela de sucesso não confirma um pagamento: entregue uma compra paga somente após verificar o evento assinado invoice.paid.