Usar o Connect com contas Express
Demonstração do Express
Para ver o fluxo completo de onboarding do Express em ação, experimente o exemplo de integração completa do Express antes de começar a criar o seu próprio fluxo. Essa demonstração contém um exemplo de uma experiência de onboarding do usuário e de gerenciamento de contas para o Rocket Rides, um marketplace sob demanda.
O código-fonte completo da demonstração está disponível no GitHub.
Antes de começar
Para criar contas Express, você precisa cumprir todos estes requisitos:
- Versão mínima da API: o Express exige a API versão 2017-05-25 ou posterior. As funções no Express exigem a API versão 2019-02-19 ou posterior.
- Plataforma em um país aceito: plataformas na Austrália, Áustria, Bélgica, Brasil, Bulgária, Canadá, Croácia, Chipre, República Tcheca, Dinamarca, Estônia, Finlândia, França, Alemanha, Grécia, Hong Kong, Hungria, Irlanda, Itália, Japão, Letônia, Lituânia, Luxemburgo, Malta, México, Países Baixos, Nova Zelândia, Noruega, Polônia, Portugal, Romênia, Singapura, Eslováquia, Eslovênia, Espanha, Suécia, Suíça, Tailândia, Reino Unido e Estados Unidos podem criar contas Express na maioria dos países aceitos pela Stripe. Para obter informações sobre restrições específicas de cada país ou para solicitar uma notificação quando as contas Express estiverem disponíveis no seu país, entre em contato conosco.
- Países que não aceitam autoatendimento: devido a restrições que se aplicam ao uso do Connect nos Emirados Árabes Unidos e na Tailândia, os usuários da plataforma nesses países não podem oferecer autoatendimento a contas Connect Express. Para começar o onboarding de contas Express nesses países, fale conosco.
- Plataformas nos EAU: só é possível usar contas Express nos EAU com os tipos de cobrança destination_charges e cobranças e transferências separadas. As cobranças de destino que usam o atributo on_behalf_of ainda não são aceitas em plataformas dos EAU.
- Verificação de fraude: como sua plataforma é responsável por perdas incorridas pelas contas Express, você deve examinar cuidadosamente todas as contas que se cadastram na sua plataforma para verificar se há fraudes. Consulte nosso guia de práticas recomendadas de gerenciamento de riscos para obter mais informações.
- Perfil da plataforma: você precisa preencher o perfil da sua plataforma.
Onboarding de contas Express fora do país da plataforma
Você pode habilitar o onboarding por país na seção Configurações do Connect do Dashboard.
O fluxo de onboarding de contas Express está localizado para os idiomas alemão, búlgaro, chinês simplificado, chinês tradicional, dinamarquês, eslovaco, esloveno, espanhol, estoniano, finlandês, francês, grego, húngaro, indonésio, inglês, italiano, japonês, letão, lituano, neerlandês, norueguês, polonês, português, romeno, tcheco e tailandês.
Quando fizer onboarding de contas em todo o mundo, lembre-se:
- Empresas internacionais: sua plataforma é responsável por compreender as implicações de fazer negócios internacionais, como relatórios fiscais e financeiros.
- Fluxos de cobrança: não se esqueça de analisar as opções de criação de cobranças dos países em que você pretende operar.
- Tipo de contrato de serviços: sua plataforma pode criar contas conectadas de acordo com o contrato de serviços do destinatário para habilitar transferências internacionais. Essas contas têm acesso limitado às funções.
Configurar a experiência de onboarding
Antes de fazer o onboarding da primeira conta, 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.
Criar uma conta Express e preencher as informações
Use a API1 Create Accountpara criar uma conta conectada com type
definido como express
. 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ê conhece o país e as funções da conta conectada, pode informar esses dados quando criar a conta. O Connect Onboarding coleta os requisitos para essas funções. Para simplificar o onboarding, solicite apenas as funções necessárias.
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.
Quando você faz onboarding de uma conta sem site próprio, e sua plataforma fornece um URL pessoal, preencha antecipadamente o business_profile.url
. Se a conta não tiver um URL, preencha business_profile.product_description
.
Ao testar sua integração, preencha antecipadamente os dados da conta usando dados de teste.
Se você omitir capabilities
, o Connect Onboarding usará as configurações da seção Definições de configuração do Stripe Dashboard para solicitar automaticamente as funções de acordo com o país da conta.
Criar um link da conta
Crie um Link de conta com os seguintes argumentos:
account
- use o ID da conta retornado pela API na etapa anteriorrefresh_url
return_url
type
=account_onboarding
Redirecione sua conta para o URL do link
Um Link de conta contém um url
. Redirecione a conta para esse link para enviar sua conta ao fluxo de onboarding. Cada URL de Link de conta só pode ser usado uma vez, pois concede acesso aos dados pessoais do titular da conta. Autentique a conta no aplicativo antes de redirecionar o titular para este URL.
Antes de criar o primeiro link para uma conta Express, preencha todas as informações de Conheça seu cliente (KYC). Depois de criar um link para uma conta Express, não é possível ler ou atualizar as informações de KYC.
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 refresh_url
para gerenciar todos os casos em que o usuário será redirecionado à sua plataforma. É importante que estejam corretos para que os usuários tenham a melhor experiência possível.
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 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.
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 o redirecionamento de um usuário para o return_url
, verifique o estado do parâmetro details_submitted
na conta dele, realizando uma das seguintes ações:
- Ouça os eventos
account.updated
com um webhook do Connect. - Acesse a conta com a API.
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 URL (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
deve acionar 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.
Gerenciar 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. Acesse a conta do usuário e verifique 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 um novo link (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.