Skip to main content
Uma activation_session representa uma sessão hospedada para ativar ou reativar o perfil financeiro de uma organization conectada a uma plataforma. A sessão pertence a uma plataforma, aponta para uma organização existente e entrega uma URL temporária para o fluxo hospedado.
activation_session também é um recurso exclusivo do Chargefy for Platforms. Criar e consultar sessões exige uma API key de plataforma com escopo platform_admin.
Em termos práticos, session aqui não é uma sessão do seu backend nem um login permanente. É uma instância temporária de uma página hospedada pela Chargefy, com autorização embutida, para que o vendedor conectado preencha cadastro, dados de negócio, documentos e informações bancárias sem você precisar montar esse formulário. Depois de criar a sessão, redirecione o vendedor para a url, por exemplo:
Use return_url para trazer o vendedor de volta ao seu produto quando ele concluir ou sair do fluxo. O passo a passo completo — criação, redirect, eventos, resultado e reenvio — está no guia Ativação hospedada. O status financeiro não fica no objeto activation_session. Consulte GET /v1/organizations/{id} ou acompanhe organization.updated para ler organization.activation_status. Se o cadastro for reprovado, o motivo e a instrução de correção também chegam pela organização, em organization.requirements — veja Requisitos de ativação.

Data Object

Este é o formato completo retornado em create e em get.
string
Identificador da sessão de ativação. Usa o prefixo as_*.
string
Sempre "activation_session".
string
Data de criação em ISO 8601.
string | null
Data de expiração da URL em ISO 8601. No GET e em estados fechados, vem null.
boolean
true em produção; false em ambiente de teste.
object
Metadata enviada na criação desta sessão de ativação. Retorna {} quando vazia.
string | null
Quando o usuário abriu o fluxo hospedado pela primeira vez.
string
ID canônico da organização conectada existente (org_*).
string
ID da plataforma dona da sessão.
string
URL para onde o usuário volta ao concluir ou sair do fluxo hospedado.
string
Estado da sessão.Novas sessões percorrem created, in_progress e submitted. Os outros valores podem aparecer em registros históricos, mas não descrevem o estado financeiro atual. Para saber se a conta foi aprovada, reprovada ou permite novo envio, consulte a organization.
string | null
Data da última atualização em ISO 8601.
string | null
URL hospedada com authorization_code de uso único. No GET e em estados fechados, vem null.

Operações

Eventos

A sessão não emite evento próprio. O resultado chega pela organização conectada: o envio para análise aparece em organization.activation_status como in_review, a aprovação como active e, em caso de reprovação, motivo e instrução em organization.requirements.