Criação de subcontas

Essa documentação adicional tem como finalidade explicar e detalhar o fluxograma de criação de contas Asaas no formato White Label.

A criação de subcontas possibilita que você crie contas Asaas para seus parceiros/clientes vinculadas a uma conta raiz, de forma que eles possam utilizar todas as funcionalidades do Asaas através do nosso site, aplicativo ou através de uma plataforma integrada desenvolvida por você.

Como resposta da criação da subconta Asaas, você receberá a chave de API (apiKey) da subconta criada para prosseguir com a integração, e também o walletId caso deseje trabalhar com o Split de pagamentos ou com a Transferência entre contas Asaas.

Com o White Label habilitado seu cliente não terá acesso ao nosso sistema e não receberá nenhum tipo de comunicação por parte do Asaas, cabendo a você nesse caso disponibilizar os recursos desejados de nossa documentação API dentro do seu sistema integrado.

Lembrando que, embora as subcontas geradas embaixo da sua conta raiz herdem definições de taxas e gerência da conta raiz, outras configurações devem ser realizadas individualmente em cada subconta criada, como webhooks, informações fiscais para emissão de notas, etc.

O processo para começar com criação de subcontas em white label se resume nos seguintes passos:

• Solicitação ao seu gerente de contas para liberação desta funcionalidade
• Criação da subconta Asaas com Webhooks sendo configurados
• Envio da Documentação da subconta, pelo onboarding com envio de documentos via link
• Consultar situação cadastral da subconta

🚧

O formato White Label precisa estar previamente alinhado e implantado pelo seu gerente de contas. A criação de contas Asaas usando os métodos listados abaixo sem uma definição prévia do funcionamento no formato White Label resultará na criação de subcontas fora dessa estrutura.

Em Sandbox, para fazer o teste, basta entrar em contato com o Suporte e solicitar a liberação.

📘

A criação de subcontas incide de cobranças de taxas para cada conta criada, verifique em Configurações de Contas > Taxas, quais taxas se aplicam.

Criação da subconta com Webhooks sendo configurados

POST /v3/accounts

Confira a referência completa deste endpoint

{
    "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": [
        {
            "url": "http://localhost:3000/webhook/accountStatus",
            "email": "[email protected]",
            "interrupted": false,
            "enabled": true,
            "apiVersion": 3,
            "authToken": "5tLxsL6uoN",
            "type": "ACCOUNT_STATUS"
        },
        {
            "url": "http://localhost:3000/webhook/transfers",
            "email": "[email protected]",
            "interrupted": false,
            "enabled": true,
            "apiVersion": 3,
            "authToken": "5tLxsL6uoN",
            "type": "TRANSFER"
        },
        {
            "url": "http://localhost:3000/webhook/payments",
            "email": "[email protected]",
            "interrupted": false,
            "enabled": true,
            "apiVersion": 3,
            "authToken": "5tLxsL6uoN",
            "type": "PAYMENT"
        },
        {
            "url": "http://localhost:3000/webhook/invoices",
            "email": "[email protected]",
            "interrupted": false,
            "enabled": true,
            "apiVersion": 3,
            "authToken": "5tLxsL6uoN",
            "type": "INVOICE"
        }
    ]
}

É de suma importância que os Webhooks sejam configurados de início para garantir que nenhum evento de criação ou atualização da conta sejam perdidos, evitando também a necessidade de requisições secundárias para configuração desses métodos.

Os detalhes sobre o Webhook de Cobranças, Transferências e Notas Fiscais podem ser encontrados nas referências da API.

🚧

Importante

Em Sandbox só é possível criar 20 subcontas por dia, caso a conta atinja o limite diário receberá uma notificação de erro.

Além disso, todas as comunicações de subcontas em Sandbox serão enviadas para o e-mail da conta raiz. O dono da subconta recebe notificações.

Guardando a chave de API da subconta

As chamadas seguintes para envio de documentos deverão ser realizadas utilizando a chave de API da subconta criada. A chave será devolvida como resposta da requisição de criação da conta e deverá ser armazenada nesse momento, não podendo ser recuperada posteriormente.