Skip to main content
Get an Onboarding Session
curl --request GET \
  --url https://api.chargefy.io/v1/onboarding-sessions/{id}
{
  "id": "os_123",
  "object": "onboarding_session",
  "created_at": "2026-04-30T18:30:00Z",
  "expires_at": null,
  "livemode": true,
  "metadata": {},
  "opened_at": "2026-04-30T18:30:45Z",
  "organization": "org_789",
  "platform": "plat_456",
  "return_url": "https://meusite.com/onboarding/return",
  "status": "submitted",
  "updated_at": "2026-04-30T18:32:10Z",
  "url": null
}
Devolve o recurso onboarding_session. O GET nunca reemite URL hospedada: url e expires_at sempre vêm null. Para renovar a URL, chame POST /v1/onboarding-sessions com o mesmo organization.

​
Autenticação

Requer API key de plataforma com escopo administrativo via header Authorization: Bearer {{API_KEY}}.

​
Parâmetros de caminho

​
id
string
required
ID do onboarding session (os_*).
curl -X GET "https://api.chargefy.io/v1/onboarding-sessions/os_123" \
  -H "Authorization: Bearer {{API_KEY}}"

​
Resposta

Mesmo formato de POST /v1/onboarding-sessions. 
{
  "id": "os_123",
  "object": "onboarding_session",
  "created_at": "2026-04-30T18:30:00Z",
  "expires_at": null,
  "livemode": true,
  "metadata": {},
  "opened_at": "2026-04-30T18:30:45Z",
  "organization": "org_789",
  "platform": "plat_456",
  "return_url": "https://meusite.com/onboarding/return",
  "status": "submitted",
  "updated_at": "2026-04-30T18:32:10Z",
  "url": null
}
Para saber se a organização conectada pode transacionar, consulte GET /v1/organizations/{id} usando o organization da sessão.