Sessões do portal do cliente
Criar uma sessão do portal do cliente
Cria uma sessão hospedada do portal do cliente.
Cria uma
Quando o cliente conclui o formulário hospedado, o cartão salvo passa a ser o
customer_portal.session e retorna uma url temporária.
Apenas customer é obrigatório. flow_data, locale, metadata e
return_url são opcionais. A validade depende da finalidade, tanto no painel
quanto na API:
- Portal completo, sem
flow_data: 1 hora. Ao abrir, o cliente confirma o acesso pelo e-mail cadastrado antes de consultar seus dados. - Solicitação específica, com
flow_data: 30 dias. O link permite somente a ação indicada e deixa de autorizar alterações quando ela é concluída.
expires_at. O acesso no navegador encerra após
1 hora sem atividade e nunca ultrapassa o vencimento do link. Enquanto a
solicitação estiver pendente e o link válido, o cliente pode reabri-lo.
Autenticação
HeaderAuthorization: Bearer {{API_KEY}}. Escopo necessário: write.
Attributes
Fluxo inicial da hosted page. Padrão: omitido — o cliente abre a home do
portal (portal geral). Quando presente,
flow_data.type é obrigatório.O que a Chargefy resolve sozinha
- Validade do link — 1 hora para o portal completo; 30 dias para solicitações específicas.
authorization_code— gerado automaticamente e embutido naurl.- Fluxo inicial — sem
flow_data, o cliente confirma o e-mail para abrir o portal completo.
Deep link para cancelamento
Com flow_data (cancelamento)
200
Deep link para atualizar cartão de uma invoice
Com flow_data (troca de cartão)
default_payment_method do customer e da invoice informada. Se a sessão também
enviar subscription, o mesmo cartão passa a ser o padrão da assinatura.
Erros comuns
Próximos passos
Depois de criar a sessão, redirecione o cliente paraurl. Links de solicitações
podem ser enviados por e-mail ou mensagem: ficam válidos por 30 dias desde a
criação, até a conclusão da ação. Para um acesso público reutilizável ao portal,
use o link de login da organização.
