Skip to main content
Uma onboarding_session representa uma sessão hospedada para ativar ou reativar o perfil financeiro de uma organization conectada. A sessão pertence a uma plataforma, aponta para uma organização existente e entrega uma URL temporária para o fluxo hospedado. O status financeiro não fica no objeto onboarding_session. Consulte GET /v1/organizations/{id} ou acompanhe organization.updated para ler organization.activation_status.

​
Data Object

Este é o formato completo retornado em create, get e em data.object do webhook onboarding.session.submitted. 
{
  "id": "os_123",
  "object": "onboarding_session",
  "created_at": "2026-05-16T14:09:27Z",
  "expires_at": "2026-05-16T14:10:27Z",
  "livemode": true,
  "metadata": {},
  "opened_at": null,
  "organization": "org_789",
  "platform": "plat_456",
  "return_url": "https://meusite.com/onboarding/return",
  "status": "created",
  "updated_at": "2026-05-16T14:09:27Z",
  "url": "https://hosted.chargefy.io/onboarding/os_123?authorization_code={{AUTHORIZATION_CODE}}"
}
​
id
string
Identificador da onboarding session. Usa o prefixo os_*.
​
object
string
Sempre "onboarding_session".
​
created_at
string
Data de criação em ISO 8601.
​
expires_at
string | null
Data de expiração da URL em ISO 8601. No GET e em estados fechados, vem null.
​
livemode
boolean
true em produção; false em ambiente de teste.
​
metadata
object
Metadata enviada na criação desta onboarding session. Retorna {} quando vazia.
​
opened_at
string | null
Quando o usuário abriu o fluxo hospedado pela primeira vez.
​
organization
string
ID canônico da organização conectada existente (org_*).
​
platform
string
ID da plataforma dona da sessão.
​
return_url
string
URL para onde o usuário volta ao concluir ou sair do fluxo hospedado.
​
status
string
Estado da sessão: created, in_progress, submitted, failed ou expired.
​
updated_at
string | null
Data da última atualização em ISO 8601.
​
url
string | null
URL hospedada com authorization_code de uso único. No GET e em estados fechados, vem null.

​
Operações

​
Webhooks

onboarding.session.submitted informa que a sessão foi enviada. O resultado financeiro chega pela organização conectada.