Usar o Connect com contas Standard
Uma conta Stripe Standard é uma conta Stripe convencional em que o titular da conta (ou seja, o usuário da sua plataforma) tem um relacionamento com a Stripe, pode acessar o Dashboard e pode processar os próprios pagamentos.
O exemplo de integração da Stripe, Kavholm, mostra como usar o Connect Onboarding para oferecer uma experiência integrada de onboarding de usuários.
Começar
Se você é usuário iniciante do Connect, comece com o guia sobre como usar contas Standard para permitir que outras empresas aceitem pagamentos diretamente.
Como usar o Connect Onboarding para contas Standard
Acesse a página de configurações do Connect para personalizar a aparência do formulário com o nome, a cor e o ícone da sua marca. O Connect Onboarding exige esses dados.
Use a API
/v1/accounts
para criar uma conta e o ID associado. É possível preencher os dados no objeto da conta para o usuário antes de gerar o link para a conta. Você pode passar o seguinte parâmetro:type
=standard
Observação
Depois de criar a conta, verifique se ela é exibida no Dashboard.
Chame a API Account Links para criar um link para a conta que fará onboarding.
No fluxo de onboarding da sua plataforma, redirecione o usuário para o
url
retornado pela API Account Links.Processe estados de conta adicionais, redirecionando sua conta para o fluxo do Connect Onboarding, se necessário.
Opcional: é possível adicionar outros procedimentos, como Tax ou Climate, ao fluxo do Connect Onboarding usando a configuração do produto da plataforma no Dashboard.
Crie uma conta Standard e preencha os dados
Use a API1 Create Accountpara criar uma conta conectada com type
definido como standard
. Você pode preencher qualquer informação, mas no mínimo deve especificar o type
. O país da conta é definido automaticamente como o mesmo país da sua plataforma, e a conta confirma a seleção durante o onboarding.
Observação
Este exemplo inclui apenas alguns dos campos que você pode definir ao criar uma conta. Para ver uma lista completa dos campos que você pode definir, como address
e website_url
. Consulte a referência da API Create Account.
Se você já coletou dados de suas contas conectadas, pode usá-los para preencher o objeto da conta. Você pode preencher quaisquer dados de conta, incluindo dados pessoais e comerciais, dados de contas externas e muito mais.
O Connect Onboarding não solicita os dados preenchidos. No entanto, ele solicita que o titular da conta confirme as informações pré-preenchidas antes de aceitar o Contrato de serviços do Connect.
Ao testar sua integração, preencha antecipadamente os dados da conta usando dados de teste.
Crie um link da conta
É possível criar um link da conta chamando a API Account Links com os seguintes parâmetros:
account
- use o ID da conta retornado pela API na etapa anteriorrefresh_url
return_url
type
=account_onboarding
Redirecione o usuário ao URL do link da conta
A resposta à sua solicitação de Account Links inclui um valor para a chave url
. Redirecione para esse link para enviar seu usuário ao fluxo. Você só pode usar URLs da API Account Links uma vez porque concedem acesso aos dados pessoais do titular da conta. Autentique o usuário no seu aplicativo antes de redirecioná-lo para esse URL. Após criar um link de conta em uma conta Standard, você não poderá ler ou escrever informações de Know Your Customer (KYC). Faça o preenchimento prévio de informações de KYC antes de criar o primeiro link de conta.
Dica de segurança
Não envie URLs de links de conta por e-mail, SMS ou outra maneira para fora do aplicativo da sua plataforma. Em vez disso, forneça-os ao titular da conta autenticado dentro do seu aplicativo.
Gerencie o usuário que volta à plataforma
O Connect Onboarding exige a passagem de return_url
e refresh_url
para gerenciar todos os casos em que você redireciona o usuário à sua plataforma. É importante implementá-los corretamente para proporcionar a melhor experiência ao usuário.
Observação
Para return_url
e refresh_url
, você pode usar HTTP enquanto estiver em modo de teste (por exemplo, para testar com localhost), mas somente HTTPS pode ser usado no modo de produção. Não se esqueça de trocar os URLs de teste para HTTPS antes de entrar em modo de produção.
return_url
A Stripe emite um redirecionamento para este URL quando o usuário conclui o fluxo do Connect Onboarding. Isso não significa que todas as informações foram coletadas ou que não há requisitos pendentes na conta. Significa somente que a entrada e saída do fluxo foram normais.
Nenhum estado é passado através deste URL. Após redirecionar um usuário para o return_url
, verifique o estado do parâmetro details_submitted
na conta dele, realizando uma das seguintes ações:
refresh_url
O usuário é redirecionado para refresh_url
nestes casos:
- O link expirou (alguns minutos se passaram desde a criação do link)
- O usuário já acessou o link (atualizou a página ou clicou em Voltar ou Avançar no navegador)
- Sua plataforma não consegue mais acessar a conta
- A conta foi recusada
O refresh_url
aciona um método no servidor para chamar novamente a API Account Links com os mesmos parâmetros e redirecionar o usuário ao fluxo do Connect Onboarding para criar uma experiência ideal.
Gerencie usuários que não concluíram o onboarding
Um usuário que é redirecionado para o seu return_url
pode não ter concluído o processo de onboarding. Use o endpoint /v1/accounts
para recuperar a conta do usuário e verificar charges_enabled
. Se a conta não estiver totalmente integrada, forneça solicitações de IU para permitir que o usuário continue o onboarding mais tarde. O usuário pode concluir a ativação da conta por meio de um novo link de conta (gerado por sua integração). Verifique o estado do parâmetro details_submitted
na conta dele para ver se o processo de onboarding foi concluído.