GET /api/v1/organizations/:id/account

Retorna a conta de pagamento associada à organização

Retorna os dados da conta de pagamento no gateway vinculada à organização. O usuário autenticado deve ser o administrador da conta (admin_id).

​

Autenticação

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

​

Parâmetros de Path

id · string · required

ID da organização

​

Resposta

id · string

ID da conta

account_type · string

Identificador do tipo de conta no gateway (valor conforme contrato da API)

status · string

Status da conta

stripe_id · string

ID Stripe (se aplicável, caso contrário null)

open_collective_slug · string

Slug Open Collective (se aplicável)

has_bank_account · boolean

Se a conta possui conta bancária ativa no gateway

is_details_submitted · boolean

Se os detalhes da conta foram enviados

is_charges_enabled · boolean

Se cobranças estão habilitadas

country · string

País da conta

billing_name · string

Nome de faturamento

billing_address · object

Endereço de faturamento

billing_additional_info · string

Informações adicionais de faturamento

billing_notes · string

Observações de faturamento

sellers · array

Sellers do gateway de pagamentos associados à conta

users · array

Usuários administradores

organizations · array

Organizações vinculadas à conta

​

Erros

Código	Descrição
403	O usuário não é o administrador da conta
404	Organização ou conta não encontrada

​

Exemplo

cURL

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

​

Resposta de Exemplo

{
  "id": "acc_abc123",
  "account_type": "default",
  "status": "active",
  "stripe_id": null,
  "open_collective_slug": null,
  "has_bank_account": true,
  "is_details_submitted": true,
  "is_charges_enabled": true,
  "country": "BR",
  "billing_name": "Minha Empresa Ltda",
  "billing_address": {
    "line1": "Rua Exemplo, 123",
    "city": "São Paulo",
    "state": "SP",
    "postal_code": "01310-100",
    "country": "BR"
  },
  "billing_additional_info": null,
  "billing_notes": null,
  "sellers": [
    {
      "seller_id": "seller_xyz",
      "seller_type": "individual",
      "status": "active"
    }
  ],
  "users": [
    {
      "id": "user_abc",
      "email": "[e-mail]",
      "avatar_url": null
    }
  ],
  "organizations": [
    {
      "id": "org_abc123",
      "name": "Minha Empresa",
      "slug": "minha-empresa",
      "avatar_url": null
    }
  ]
}