GET /api/v1/organizations/:id/payment-status

Retorna o status de onboarding de pagamentos da organização

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

Show Propriedades de cada etapa

id · string

Identificador da etapa: create_product, integrate_checkout, setup_account

title · string

Título descritivo da etapa

description · string

Descrição do que deve ser feito

completed · boolean

Se a etapa foi concluída

​

Etapas de Onboarding

Etapa	ID	Condição de conclusão
Criar produto	create_product	Pelo menos um produto ativo cadastrado
Integrar checkout	integrate_checkout	Pelo menos um produto ativo (mesmo critério atual)
Configurar conta	setup_account	account_id definido na organização

​

Exemplo

cURL

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
    }
  ]
}