Consultar plataforma

curl "https://api.chargefy.io/v1/platforms/plat_5Nq8rT2wX7mK4pV9" \
  -H "Authorization: Bearer {{API_KEY}}"

{
  "id": "plat_5Nq8rT2wX7mK4pV9",
  "object": "platform",
  "created_at": "2026-10-06T12:00:00Z",
  "livemode": true,
  "metadata": {},
  "name": "Minha plataforma",
  "organization": "org_7Dk9mQ2vX5rT8pWN",
  "status": "active",
  "updated_at": null
}

Este recurso é exclusivo de Chargefy for Platforms, produto usado para operar os pagamentos de suas organizações filhas.

Use a API key com escopo platform_admin. A consulta funciona mesmo antes de criar a primeira organização filha. O ID deve pertencer à plataforma da chave; outro ID retorna 404, sem revelar dados de outra plataforma. Não envie o header Organization. O ambiente vem da chave, não de um parâmetro da requisição.

string

obrigatório

ID da plataforma (plat_*).

curl "https://api.chargefy.io/v1/platforms/plat_5Nq8rT2wX7mK4pV9" \
  -H "Authorization: Bearer {{API_KEY}}"

Resposta

string

ID da plataforma.

string

Sempre platform.

string

Data de criação em ISO 8601.

boolean

true para chave de produção; false para teste.

object

Objeto vazio; esta consulta não edita metadata.

string

Nome de exibição da plataforma.

string

Organização proprietária da plataforma.

string

active ou suspended.

string | null

Última atualização em ISO 8601, quando disponível.

{
  "id": "plat_5Nq8rT2wX7mK4pV9",
  "object": "platform",
  "created_at": "2026-10-06T12:00:00Z",
  "livemode": true,
  "metadata": {},
  "name": "Minha plataforma",
  "organization": "org_7Dk9mQ2vX5rT8pWN",
  "status": "active",
  "updated_at": null
}

HTTP	Quando ocorre
`400`	Header `Organization` enviado.
`401`	Chave inválida, expirada ou revogada.
`403`	Chave sem escopo `platform_admin`.
`404`	Plataforma ausente ou ID diferente daquele da chave.
`405`	Método diferente de `GET`.
`503`	Consulta temporariamente indisponível.

curl "https://api.chargefy.io/v1/platforms/plat_5Nq8rT2wX7mK4pV9" \
  -H "Authorization: Bearer {{API_KEY}}"

{
  "id": "plat_5Nq8rT2wX7mK4pV9",
  "object": "platform",
  "created_at": "2026-10-06T12:00:00Z",
  "livemode": true,
  "metadata": {},
  "name": "Minha plataforma",
  "organization": "org_7Dk9mQ2vX5rT8pWN",
  "status": "active",
  "updated_at": null
}

Visão geral

Ativação de organizações

Planos de taxas

Marca e domínio próprio

Modelo de negócio

Consultar plataforma

Resposta

​Resposta

Resposta