Eventos para verificar situação da conta

Use os eventos de situação cadastral para acompanhar automaticamente alterações nos dados comerciais, conta bancária, documentação e aprovação geral de uma conta.

Cada notificação informa a alteração em event e a situação cadastral atual no objeto accountStatus.

Eventos disponíveis

Conta bancária

Informações comerciais

Documentação

Aprovação geral

Quando accountStatus.general estiver como APPROVED, a conta está com a aprovação geral concluída.

Confirmação anual dos dados comerciais

Para subcontas sujeitas à confirmação anual, também podem ser enviados:

ACCOUNT_STATUS_COMMERCIAL_INFO_EXPIRING_SOON é enviado antes da data de expiração para que a integração possa solicitar a confirmação ou atualização dos dados.

Ao receber ACCOUNT_STATUS_COMMERCIAL_INFO_EXPIRED, trate a pendência mesmo que accountStatus.commercialInfo e accountStatus.general ainda estejam como APPROVED. A expiração anual é controlada separadamente da aprovação cadastral.

Consulte o fluxo completo em Confirmação Anual de Dados Comerciais para Subcontas.

Payload do evento

A notificação é enviada via POST com o evento e a situação atual da conta.

{
    "id": "evt_05b708f961d739ea7eba7e4db318f621&368604920",
    "event": "ACCOUNT_STATUS_COMMERCIAL_INFO_APPROVED",
    "dateCreated": "2024-06-12 16:45:03",
    "account": {
        "id": "47ed0d25-f9fb-4b35-b23a-d8895caf92b7",
        "ownerId": null
    },
    "accountStatus": {
        "id": "175027c1-029c-41e5-8b9a-e289b9788c33",
        "commercialInfo": "APPROVED",
        "bankAccountInfo": "APPROVED",
        "documentation": "APPROVED",
        "general": "APPROVED"
    }
}

Campos importantes do payload

Como tratar os eventos

Ao receber um evento de situação cadastral:

1. identifique a alteração pelo campo event;
2. persista o id para impedir processamento duplicado;
3. utilize account.id para identificar a conta no seu sistema;
4. atualize a dimensão correspondente utilizando os dados de accountStatus;
5. responda HTTP 200 após confirmar a persistência;
6. processe regras adicionais de forma assíncrona.

Os Webhooks seguem o modelo at least once, portanto o mesmo evento pode ser enviado mais de uma vez.

Consulte como implementar idempotência em Webhooks.

Para acompanhar mudanças cadastrais, prefira esses eventos em vez de consultar continuamente a situação da conta pela API. Utilize a consulta individual quando precisar recuperar o estado atual sob demanda.

Próximos passos

• Entenda a confirmação anual de dados comerciais das subcontas
• Receba eventos do Asaas no seu endpoint de Webhook
• Implemente idempotência em Webhooks
• Monitore os Logs de Webhooks
• Consulte os demais Eventos de Webhooks