Pular para o conteúdo
Criar conta ou Entrar
O logotipo da documentação da Stripe
/
Criar contaLogin

Integre sua conta conectada

Integre suas contas conectadas ao seu marketplace.

Após criar e preencher previamente uma conta conectada, crie um Account Link e o envie ao usuário para que ele possa concluir o processo de onboarding. Um Account Link é um URL de uso único que você envia a uma conta conectada e que concede a ela permissão para acessar o fluxo Connect Onboarding.

Ou, você também pode criar um fluxo personalizado para fazer onboarding usando os componentes incorporados ou a API. Para simplificar a conformidade e a manutenção, use o Accounts Links ou crie seu próprio fluxo para fazer onboarding com componentes incorporados. Este guia usa Account Links.

O fluxo do Connect Onboarding não solicita à sua conta conectada nenhuma informação que você tenha preenchido previamente. No entanto, ele solicita à conta conectada que confirme as informações preenchidas previamente antes de aceitar o Contrato de serviços do Connect.

Observação

O onboarding hospedado pela Stripe só é aceito em navegadores da web. Não é possível usá-lo em visualizações da web incorporadas em aplicativos móveis ou para computador.

Criar um link da conta

Command Line
cURL
Stripe CLI
Ruby
Python
PHP
Java
Node.js
Go
.NET
No results
curl https://api.stripe.com/v1/account_links \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d account=
"{{CONNECTED_ACCOUNT_ID}}"
 \
  --data-urlencode refresh_url="https://example.com/reauth" \
  --data-urlencode return_url="https://example.com/return" \
  -d type=account_onboarding
ParâmetroValorObrigatório?Descrição
contaA ID da conta conectadaSimDefina isso como a ID da conta conectada para a qual você está criando um link da conta.
return_urlum URL válidoSimO URL para o qual o usuário deve ser redirecionado após sair ou concluir o fluxo de onboarding.
refresh_urlum URL válidoSimO URL para o qual o usuário será redirecionado se o Account Link tiver expirado, tiver sido visitado anteriormente ou se for inválido. Use esse URL para gerar um novo Account Link com os mesmos parâmetros que você usou para criar o Account Link original.
typeaccount_onboardingSimFornece um formulário para recolher apenas as novas informações de que você precisa.

Redirecionar o usuário ao URL de Account Link

A resposta à sua solicitação Account Links inclui um valor para a chave url. Redirecione para esse link para enviar a conta conectada para o fluxo de onboarding.

URLs from the Account Links API are temporary and can only be used once, because they grant access to the connected account user’s personal information. Authenticate the user in your application before redirecting them to this URL. If you want to prefill information, you must do so before generating the Account Link. After you create the Account Link, you can’t read or write information for the connected account.

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.

Gerenciar o usuário que volta à plataforma

O Connect Onboarding exige que você passe um return_url e um refresh_url para gerenciar todos os casos em que o usuário é redirecionado à sua plataforma. É importante implementá-los corretamente para proporcionar a melhor experiência ao usuário.

Observação

Você pode usar HTTP para return_url e refresh_url enquanto estiver em um ambiente de teste (por exemplo, para testar com localhost), mas o modo de produção só aceita HTTPS. Não se esqueça de trocar os URLs de teste para HTTPS antes de entrar em modo de produção.

Definir o URL de retorno

A Stripe redireciona a conta conectada de volta para return_url quando o usuário conclui o fluxo de onboarding ou clica em Salvar para depois em qualquer momento do fluxo. Isso não significa que todas as informações tenham sido coletadas ou que não haja requisitos pendentes na conta. Significa apenas que o fluxo foi iniciado e encerrado corretamente.

Nenhum estado é passado com esse URL. Após uma conta conectada ser redirecionada para o return_url, determine se a conta concluiu o onboarding:

  • Como recuperar a conta e verificar os requisitos do hash para verificar se há requisitos pendentes.
  • Ouça o evento account.updated enviado ao seu endpoint Webhook e armazene em cache o estado da conta no seu aplicativo. Se a conta não tiver concluído o onboarding, forneça instruções no seu aplicativo para permitir que o onboarding continue posteriormente.

Defina o URL de atualização

A Stripe redireciona seu usuário para o refresh_url nestes casos:

  • O link expirou (alguns minutos se passaram após a criação do link).
  • O usuário já acessou o URL (atualizou a página ou clicou em Voltar ou Avançar no navegador).
  • Sua plataforma não consegue mais acessar a conta.
  • O link foi compartilhado em um aplicativo de terceiros, como um cliente de mensagens que tenta acessar o URL para fazer preview. Muitos clientes acessam links automaticamente, o que faz com que um link da conta expire.
  • A conta foi recusada.

Configure o refresh_url para chamar um método em seu servidor para chamarLinks da conta novamente para criar um novo Link de conta com os mesmos parâmetros e, em seguida, redirecione o conta conectada para a nova URL do Link da conta.

Tratando usuários que não concluíram o onboarding

Um usuário que é redirecionado para seu return_url pode não ter concluído o processo de onboarding. Para verificar se um usuário concluiu o processo de onboarding, recupere a conta do usuário e confira se details_submitted está definido como true. Se details_submitted for false, o onboarding da conta não foi concluído. Forneça instruções na IU do seu aplicativo para permitir que o usuário continue a fazer onboarding posteriormente. O usuário pode concluir a ativação da conta por meio de um novo link da conta gerado pela sua integração.

Próximas etapas

Em seguida, habilite as formas de pagamento que você deseja aceitar.

Esta página foi útil?
SimNão