Funções da conta
As funções que você solicita para uma conta conectada determinam os dados que devem ser coletados para essa conta. Para reduzir o esforço de onboarding, solicite apenas as funções necessárias. Quantos mais funções você solicita, mais dados precisa coletar.
Você pode começar preenchendo o perfil da plataforma para compreender quais funções podem ser adequadas para ela.
Observação
Para a maioria das funções, a solicitação feita as habilita permanentemente. Tentar remover ou cancelar a solicitação de uma função permanente retorna um erro.
Funções aceitas
Veja a seguir uma lista das funções disponíveis. Clique em um item para expandi-lo ou recolhê-lo.
Transferências
Pagamento com cartão
Declaração fiscal dos EUA
Formas de pagamento
Pagamentos internacionais na Índia
Várias funções
A solicitação de várias funções para uma conta conectada é comum, mas envolve as seguintes considerações:
- As funções operam de forma independente entre si.
- Se uma conta conectada tiver
card_payments
etransfers
, e ostatus
de qualquer um deles forinactive
, ambos os recursos serão desativados. - Você pode solicitar ou cancelar a solicitação de uma função de uma conta conectada a qualquer momento durante o ciclo de vida da conta.
As funções também permitem a coleta de dados para várias finalidades ao mesmo tempo, para evitar que os usuários tenham de enviar os mesmos dados mais de uma vez. Por exemplo, você pode coletar dados fiscais obrigatórios e de dados obrigatórios para uma função solicitada. Se você faz onboarding de um usuário com a função transfers
e ele precisa preencher o informe 1099-MISC do IRS (um informe de declaração de impostos federal dos EUA), é possível coletar dados para as duas finalidades ao mesmo tempo.
Criar uma conta com funções
As funções são definidas no objeto Account. Para encontrar a lista de funções disponíveis, use o endpoint list_capabilities.
As funções de criação e solicitação de contas são diferentes para contas conectadas em configurações diferentes.
- As funções são solicitadas automaticamente em qualquer conta que você criar com acesso ao Stripe Dashboard completo, incluindo contas Standard.
- Para contas com acesso ao Dashboard Express, inclusive contas Express, você pode solicitar funções ao criar a conta ou usar as definições de configuração de onboarding para automatizar as funções solicitadas.
- Você deve solicitar funções quando criar contas conectadas sem acesso a um Dashboard hospedado pela Stripe, incluindo contas Custom.
Os requisitos de dados variam conforme a função, mas costumam estar relacionados à verificação de identidade ou outros dados específicos de um tipo de pagamento.
Após a criação da conta conectada, você pode ver quais são os requisitos:
Na resposta, verifique o hash requirements
para ver quais dados são necessários. Os valores de payouts_enabled
e charges_enabled
indicam se repasses e cobranças estão habilitados para a conta.
Mais informações sobre funções
Os conceitos básicos da criação de contas foram mostrados acima. No entanto, há situações em que você pode desejar ver os requisitos de dados ou gerenciar funções de contas existentes. As seções a seguir descrevem como executar essas ações usando a API Capabilities.
Ver requisitos de dados
Você pode ver quais dados de usuário são necessários para uma função específica antes ou depois da solicitação da função.
Quando você solicita funções, webhooks account.updated
são acionados e os requisitos da conta podem mudar. Se você viu os requisitos antes, colete os dados necessários para a conta e solicite a função. Assim, você pode ajudar a agilizar a habilitação de cobranças e repasses para a conta. Além disso, você evita a possibilidade de desativação da conta, pois os dados já foram coletados antecipadamente.
Este é um exemplo que relaciona os requisitos da função card_payments
de uma conta específica.
Na resposta, verifique o hash requirements
para ver quais dados são necessários:
{ "id": "card_payments", "object": "capability", "account":
, "requested": false, "requested_at": null, "requirements": { "past_due": [], "currently_due": ["company.tax_id", ...], "eventually_due": [...], "disabled_reason": ..., "current_deadline": ..., }, "status": "unrequested" }"{{CONNECTED_ACCOUNT_ID}}"
O valor de status
identifica onde a função foi requested
. Quando a função é solicitada, requisitos são ativados para a conta.
Essas etapas mostram como ver os requisitos de uma função antes de solicitá-la. No entanto, você pode usar o mesmo endpoint para ver os requisitos atuais de uma função. Com esse recurso, você fica a par dos requisitos de uma função e de eventuais mudanças em um requisito.
Funções de solicitação e cancelamento de solicitação
Após criar a maioria das contas, você pode solicitar funções adicionais e remover as existentes. Para solicitar uma função, defina o valor requested
da função como true
atualizando a conta. Se a solicitação for bem-sucedida, a API retorna requested: true
na resposta. Não é possível solicitar funções para contas conectadas com acesso ao Stripe Dashboard completo, incluindo contas Standard.
Para cancelar a solicitação de uma função, defina o valor requested
da função como false
atualizando a conta. Se não for possível remover a função, a chamada retorna um erro. Se a chamada for bem-sucedida, a API retornará requested: false
na resposta.
Você também pode solicitar e remover as funções de uma conta no Dashboard. Se uma função não puder ser removida, seu botão Remover é desativado.
O exemplo abaixo solicita a função transfers
para uma conta conectada específica:
O exemplo abaixo solicita várias funções para uma conta conectada específica: