Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.chargefy.io/llms.txt

Use this file to discover all available pages before exploring further.

Retorna as etapas de configuração de pagamentos da organização e se ela está pronta para receber pagamentos.

​
Autenticação

Requer token de usuário (JWT Supabase) via header Authorization: Bearer. O usuário deve pertencer à organização.

​
Parâmetros de Path

​
id
string
required
ID da organização

​
Resposta

​
payment_ready
boolean
true se todas as etapas estiverem concluídas
​
steps
array
Lista de etapas de configuração

​
Etapas de Onboarding

EtapaIDCondição de conclusão
Criar produtocreate_productPelo menos um produto ativo cadastrado
Integrar checkoutintegrate_checkoutPelo menos um produto ativo (mesmo critério atual)
Configurar contasetup_accountaccount_id definido na organização

​
Exemplo

curl -X GET "https://api.chargefy.io/api/v1/organizations/org_abc123/payment-status" \
  -H "Authorization: Bearer $CHARGEFY_ACCESS_TOKEN"

​
Resposta de Exemplo

{
  "payment_ready": false,
  "steps": [
    {
      "id": "create_product",
      "title": "Crie seu primeiro produto",
      "description": "Configure produtos ou serviços que os clientes podem comprar.",
      "completed": true
    },
    {
      "id": "integrate_checkout",
      "title": "Integrar checkout",
      "description": "Adicione checkout ao seu site com API ou links.",
      "completed": true
    },
    {
      "id": "setup_account",
      "title": "Configurar conta de pagamento",
      "description": "Conecte sua conta bancária para receber pagamentos.",
      "completed": false
    }
  ]
}