Notificações padrões

Entenda as notificações padrões

Ao cadastrar um cliente, o Asaas cria automaticamente um conjunto de notificações para acompanhar o ciclo das cobranças.

Cada notificação possui um id próprio e pode ser posteriormente configurada para alterar canais, destinatários ou momento de envio.

Notificações criadas automaticamente

Por padrão, todas são criadas com enabled: true e deleted: false.

O WhatsApp fica desabilitado em todas as configurações iniciais.

NotificaçãoeventscheduleOffsetEnvio padrão
Cobrança criadaPAYMENT_CREATED0Cliente: e-mail e SMS
Dia do vencimentoPAYMENT_DUEDATE_WARNING0Cliente: e-mail e SMS
Cobrança recebidaPAYMENT_RECEIVED0Cliente: e-mail e SMS; provedor: e-mail
Linha digitável no vencimentoSEND_LINHA_DIGITAVEL0Cliente: e-mail e SMS
Cobrança vencidaPAYMENT_OVERDUE0Cliente: e-mail, SMS e ligação; provedor: e-mail
7 dias após o vencimentoPAYMENT_OVERDUE7Cliente: e-mail, SMS e ligação
10 dias antes do vencimentoPAYMENT_DUEDATE_WARNING10Cliente: e-mail e SMS
Cobrança atualizadaPAYMENT_UPDATED0Cliente: e-mail e SMS

Cobrança criada

PAYMENT_CREATED é enviada quando a cobrança é criada, exceto para cobranças geradas por assinaturas.

Linha digitável

SEND_LINHA_DIGITAVEL é enviada no vencimento quando a fatura ou o boleto ainda não tiver sido visualizado pelo cliente.

Cobrança atualizada

PAYMENT_UPDATED é enviada quando o valor ou a data de vencimento da cobrança é alterado.

Entenda o scheduleOffset

Um mesmo evento pode possuir mais de uma notificação.

Por exemplo, PAYMENT_DUEDATE_WARNING é criado com:

  • scheduleOffset: 0 para o dia do vencimento;
  • scheduleOffset: 10 para 10 dias antes do vencimento.
📘

Você pode notar que temos duas notificações com o evento PAYMENT_DUEDATE_WARNING, porém esta existe a configuração do scheduleOffset definida, porém os IDs das notificações são diferentes.

O mesmo ocorre com PAYMENT_OVERDUE:

  • scheduleOffset: 0 para o aviso quando a cobrança vence sem pagamento;
  • scheduleOffset: 7 para o aviso periódico após o vencimento enquanto a cobrança continuar sem pagamento.
📘

Você pode notar que temos duas notificações com o evento PAYMENT_OVERDUE, porém esta existe a configuração do scheduleOffset definida, porém os IDs das notificações são diferentes.

Cada configuração possui seu próprio id, mesmo quando utiliza o mesmo event.

Exemplo:

{
  "object": "notification",
  "id": "not_EDaloT543tss",
  "customer": "cus_Y4AEif5zrMGK",
  "enabled": true,
  "emailEnabledForProvider": false,
  "smsEnabledForProvider": false,
  "emailEnabledForCustomer": true,
  "smsEnabledForCustomer": true,
  "phoneCallEnabledForCustomer": true,
  "whatsappEnabledForCustomer": false,
  "event": "PAYMENT_OVERDUE",
  "scheduleOffset": 7,
  "deleted": false
}

Consulte as notificações do cliente

Os IDs apresentados nesta página são exemplos. Consulte as notificações do cliente para obter os identificadores criados para ele:

GET /v3/customers/{id}/notifications

Consulte o endpoint Recuperar notificações de um cliente.

As notificações são criadas pelo Asaas e possuem estrutura fixa. Você pode alterar as configurações existentes, mas não criar ou excluir tipos de notificação pela API.

Para personalizar canais, destinatários ou momento de envio, consulte Alterando notificações de um cliente.

Próximos passos


Did this page help you?