Usar o Connect com contas conectadas Express

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.

Use the Create Account API to create a connected account with type set to express. You can prefill any information, but at a minimum, you must specify the type. The country of the account defaults to the same country as your platform, and the account confirms the selection during onboarding.

curl https://api.stripe.com/v1/accounts \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d type=express

If you know the country and capabilities for your connected account, you can provide that information when you create the account. Connect Onboarding then collects the requirements for those capabilities. To reduce onboarding effort, request only the capabilities you need.

curl https://api.stripe.com/v1/accounts \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d country=US \
  -d type=express \
  -d "capabilities[card_payments][requested]"=true \
  -d "capabilities[transfers][requested]"=true \
  -d business_type=individual \
  --data-urlencode "business_profile[url]"="https://example.com"

If you’ve already collected information for your connected accounts, you can prefill that information on the Account object. You can prefill any account information, including personal and business information, external account information, and so on.

Connect Onboarding doesn’t ask for the prefilled information. However, it does ask the account holder to confirm the prefilled information before accepting the Connect service agreement.

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.

When testing your integration, prefill account information using test data.

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.

Crie um Link de conta com os seguintes parâmetros:

• account - use o ID da conta retornado pela API na etapa anterior
• refresh_url
• return_url
• type = account_onboarding

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

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 conectada Express, preencha todas as informações de Conheça seu cliente (KYC). Depois de criar um link para uma conta conectada Express, não é possível ler ou atualizar as informações de KYC.

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

return_url

A Stripe emite um redirecionamento para este URL quando a conta conectada 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 por este URL. Após o redirecionamento de uma conta conectada 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.
• Recupere a conta com a API.

refresh_url

Sua conta conectada é redirecionada 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.
• A conta foi recusada.

Configure seu refresh_url para acionar um método no seu servidor para chamar Account Links novamente com os mesmos parâmetros e redirecione a conta conectada ao fluxo do Connect Onboarding para criar uma experiência satisfatória.

Uma conta conectada que é redirecionada ao seu return_url pode não ter concluído o processo de onboarding. Acesse a conta e verifique charges_enabled. Se a conta não estiver totalmente integrada, forneça instruções de IU para permitir que ela 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 para ver se o processo de onboarding foi concluído.