Subcontas
Entenda as diferenças entre subcontas BaaS e não-BaaS, quando usar cada modelo e como seguir o fluxo de integração via API.
Qual diferença de uma subconta de um cliente BaaS para uma subconta não-BaaS?
Entenda quando usar subcontas BaaS ou não-BaaS, quais responsabilidades mudam em cada modelo e como seguir o fluxo de criação via API.
Subcontas permitem criar contas Asaas para parceiros, clientes ou estabelecimentos vinculados a uma Conta Pai. Cada subconta pode ter sua própria gestão financeira, clientes, cobranças, transferências, saldo e configurações operacionais.
Antes de começar
Antes de criar subcontas pela API:
- Confirme com seu gerente de contas se sua operação deve usar o modelo BaaS ou não-BaaS.
- Configure a conta de sandbox para testar o fluxo de criação, envio de documentos, webhooks e consulta cadastral.
- Separe os dados cadastrais do titular da subconta, incluindo documento, e-mail, telefones e endereço.
- Defina quais eventos sua aplicação precisa receber por webhook para acompanhar a operação da subconta.
- Prepare um local seguro para armazenar a
apiKeyretornada na criação da subconta.
Escolha o modelo de subconta
Use esta comparação para decidir qual modelo atende melhor sua integração.
| Modelo | Quando usar | Como o cliente final acessa | Quem faz a comunicação com o cliente final |
|---|---|---|---|
| Subconta não-BaaS | Quando o titular da subconta deve acessar a interface do Asaas e usar as funcionalidades disponíveis diretamente no Asaas. | Pelo site ou aplicativo do Asaas, após definição de senha. | O Asaas envia o e-mail de boas-vindas e o link para definição de senha. |
| Subconta BaaS | Quando você quer oferecer serviços financeiros dentro do seu site ou aplicativo, sem que o cliente final precise sair do seu ambiente. | Pelo sistema da Conta Pai, usando a integração com a API do Asaas. | A Conta Pai é responsável pelas comunicações, avisos, telas e fluxos de gestão do cliente final. |
No modelo não-BaaS, a subconta acessa a interface do Asaas com as funcionalidades disponíveis para ela. Subcontas nesse formato são originadas do formato Correspondente Bancário.
No modelo BaaS, o Tomador — cliente responsável pela Conta Pai — integra o Asaas ao próprio sistema usando a API e o produto BaaS Asaas. Nesse cenário, o cliente final não precisa acessar a conta no Asaas para gestão ou acompanhamento das informações.
O formato BaaS precisa estar previamente alinhado e implantado pelo seu gerente de contas. Criar contas Asaas via API sem essa definição prévia pode resultar na criação de subcontas fora da estrutura BaaS.
Fluxo de integração BaaS
Siga este fluxo quando sua operação estiver habilitada para BaaS:
- Solicite ao seu gerente de contas a liberação e o alinhamento da funcionalidade BaaS.
- Configure sua conta de sandbox para validar a criação de subcontas antes de operar em produção.
- Crie a subconta pela API usando o endpoint
POST /v3/accounts. - Configure webhooks já na criação da subconta para acompanhar eventos de criação e atualização sem depender de configurações manuais posteriores.
- Armazene a
apiKeyretornada na criação da subconta em local seguro, pois ela será usada nas chamadas autenticadas em nome da subconta. - Armazene o
walletIdretornado caso sua integração use recursos como Split de pagamentos ou transferências entre contas Asaas. - Envie a documentação cadastral da subconta pelo fluxo de onboarding com envio de documentos via link.
- Consulte a situação cadastral da subconta antes de liberar operações financeiras para o cliente final.
- Implemente, no seu próprio sistema, as telas, avisos e ferramentas de gestão que o cliente final usará.
Criar subconta
↓
Receber apiKey e walletId
↓
Armazenar credenciais com segurança
↓
Configurar webhooks e recursos operacionais
↓
Enviar documentos cadastrais
↓
Consultar situação cadastral
↓
Operar em nome da subconta pela APIExemplo de criação com webhooks
Use o endpoint POST /v3/accounts para criar uma subconta. Consulte a referência completa de criação de subconta para ver todos os campos, regras e respostas disponíveis.
{
"name": "Subconta criada via API",
"email": "[email protected]",
"cpfCnpj": "66625514000140",
"birthDate": "1994-05-16",
"companyType": "MEI",
"phone": "11 32300606",
"mobilePhone": "11 988451155",
"address": "Av. Rolf Wiest",
"addressNumber": "277",
"complement": "Sala 502",
"province": "Bom Retiro",
"postalCode": "89223005",
"webhooks": [
{
"name": "Webhook para cobranças",
"url": "http://meusite.com/webhook/payments",
"email": "[email protected]",
"sendType": "SEQUENTIALLY",
"interrupted": false,
"enabled": true,
"apiVersion": 3,
"authToken": "5tLxsL6uoN",
"events": [
"PAYMENT_CREATED",
"PAYMENT_UPDATED",
"PAYMENT_CONFIRMED",
"PAYMENT_RECEIVED"
]
}
]
}curl --request POST \
--url https://api.asaas.com/v3/accounts \
--header 'Content-Type: application/json' \
--header 'access_token: SUA_API_KEY_DA_CONTA_PAI' \
--data '{
"name": "Subconta criada via API",
"email": "[email protected]",
"cpfCnpj": "66625514000140",
"birthDate": "1994-05-16",
"companyType": "MEI",
"phone": "11 32300606",
"mobilePhone": "11 988451155",
"address": "Av. Rolf Wiest",
"addressNumber": "277",
"complement": "Sala 502",
"province": "Bom Retiro",
"postalCode": "89223005",
"webhooks": [
{
"name": "Webhook para cobranças",
"url": "http://meusite.com/webhook/payments",
"email": "[email protected]",
"sendType": "SEQUENTIALLY",
"interrupted": false,
"enabled": true,
"apiVersion": 3,
"authToken": "5tLxsL6uoN",
"events": [
"PAYMENT_CREATED",
"PAYMENT_UPDATED",
"PAYMENT_CONFIRMED",
"PAYMENT_RECEIVED"
]
}
]
}'Configurar webhooks na criação da subconta ajuda a evitar perda de eventos de criação ou atualização da conta. Os eventos disponíveis estão descritos no guia Sobre os webhooks.
Trate o retorno da criação
Após criar a subconta, sua aplicação deve tratar pelo menos três resultados:
| Resultado | Como tratar |
|---|---|
| Criação concluída | Armazene a apiKey, associe a subconta ao cadastro interno do seu sistema e salve o walletId quando sua integração usar Split de pagamentos ou transferências entre contas Asaas. |
| Erro de validação | Corrija os campos enviados no cadastro e permita nova tentativa sem criar registros duplicados no seu sistema. |
| Falha temporária de integração | Registre a falha, evite expor a apiKey em logs e só libere a jornada do cliente final depois de confirmar a criação da subconta. |
A
apiKeyretornada dá acesso às chamadas autenticadas em nome da subconta. Não salve essa chave em texto aberto, não exiba em telas administrativas e não envie em mensagens de erro.
Campos e dados que exigem atenção
A referência da API é a fonte completa para obrigatoriedade, validações e formato de cada campo. Durante a implementação, trate estes dados com atenção:
| Campo ou configuração | Como usar na integração |
|---|---|
name | Informe o nome da subconta que será criada. |
email | Informe o e-mail vinculado à subconta. Em subcontas não-BaaS, esse e-mail recebe a comunicação de boas-vindas e definição de senha. |
cpfCnpj | Informe o documento do titular da subconta. |
birthDate | Informe a data de nascimento quando aplicável ao cadastro. |
companyType | Informe o tipo de empresa quando a subconta for pessoa jurídica. |
phone e mobilePhone | Informe telefones de contato do titular da subconta. |
address, addressNumber, complement, province e postalCode | Informe os dados de endereço usados no cadastro. |
webhooks | Configure os eventos que sua aplicação precisa receber para acompanhar a operação da subconta. |
apiKey | Armazene a chave retornada na criação para realizar chamadas em nome da subconta. |
walletId | Use o identificador da carteira em recursos como Split de pagamentos e transferências entre contas Asaas. |
Esses campos não substituem a consulta à referência da API. Use a referência para validar obrigatoriedade, tipos, formatos aceitos e mensagens de erro antes de concluir sua implementação.
Comportamentos importantes
Ao criar subcontas, considere estes comportamentos na sua jornada de integração:
- Quando uma subconta não-BaaS é criada, o Asaas envia um e-mail de boas-vindas com o link para definição da senha de acesso.
- No modelo BaaS Asaas, nenhuma comunicação é realizada pelo Asaas ao cliente final. A Conta Pai deve realizar as comunicações e disponibilizar os recursos necessários dentro do próprio sistema.
- Algumas configurações precisam ser realizadas individualmente em cada subconta, como webhooks, informações fiscais para emissão de notas e outras configurações operacionais.
- A criação da subconta não substitui o acompanhamento cadastral. Consulte a situação cadastral antes de liberar operações financeiras para o cliente final.
- Novas operações de criação de subcontas via API entram inicialmente no período de avaliação regulatória para serviços na API.
- Durante a avaliação regulatória, há limites de quantidade de subcontas, volume emitido em cobranças por subconta e prazo de vigência. Consulte o FAQ do período de avaliação para ver os detalhes atualizados.
Em sandbox, consulte o guia de configuração da conta sandbox antes de testar o fluxo BaaS: Como configurar sua conta no sandbox.
Boas práticas para subcontas BaaS
- Confirme a habilitação do modelo BaaS com seu gerente de contas antes de criar subcontas via API.
- Configure webhooks no momento da criação da subconta para acompanhar eventos desde o início da operação.
- Armazene a
apiKeyem local seguro assim que ela for retornada e não a exponha em logs, telas administrativas ou mensagens de erro. - Associe internamente a subconta criada ao cadastro correspondente no seu sistema para evitar divergências operacionais.
- Informe o cliente final sobre as jornadas relevantes dentro do seu próprio sistema, já que ele não receberá comunicações automáticas do Asaas no modelo BaaS.
- Evidencie o Asaas como Instituição Prestadora nos pontos de contato exigidos pela regulamentação aplicável ao modelo BaaS.
Solução de problemas
Use esta lista para tratar falhas comuns durante a implementação:
| Situação | Como resolver |
|---|---|
| A subconta foi criada fora do modelo BaaS | Confirme com seu gerente de contas se o formato BaaS foi alinhado e implantado antes de criar novas subcontas via API. |
| Eventos não chegam no seu sistema | Verifique se os webhooks foram configurados na criação da subconta, se a URL está acessível e se os eventos necessários foram incluídos. |
| A operação financeira não deve ser liberada | Consulte a situação cadastral da subconta e libere o cliente final apenas depois de validar que a jornada cadastral necessária foi concluída. |
| Há divergência entre seu sistema e o Asaas | Mantenha o identificador interno do cliente final associado à subconta criada e use webhooks para atualizar estados operacionais. |
Impactos operacionais para planejar
Considere estes pontos antes de colocar a integração em produção:
- Conciliação: relacione cada subconta ao cliente final correspondente no seu sistema para conciliar cobranças, transferências, saldos e eventos recebidos.
- Segurança: proteja a
apiKeyde cada subconta com o mesmo cuidado aplicado à chave da Conta Pai. - Comunicação: no modelo BaaS, implemente no seu próprio sistema as telas, avisos e notificações que o cliente final precisa receber.
- Operação: planeje a configuração individual de webhooks, informações fiscais e recursos operacionais em cada subconta.
- Regulação: acompanhe os limites e prazos do período de avaliação regulatória antes de escalar a criação de subcontas.
Próximos passos
Aprofunde a implementação nos conteúdos relacionados:
- BaaS com o Asaas
- Criação de subcontas com o BaaS do Asaas
- Referência: criar subconta
- Onboarding e envio de documentos via link
- Sobre os webhooks
- FAQ do período de avaliação regulatória
- Split de pagamentos
Updated 20 days ago
