Default notifications

By default, the API creates the following notifications when registering a new customer:

Payment created notification

Notification sent at the moment the charge is created, except for charges created by subscriptions.

{
    "object": "notification",
    "id": "not_NhHT6M5yUe0C",
    "customer": "cus_Y4AEif5zrMGK",
    "enabled": true,
    "emailEnabledForProvider": false,
    "smsEnabledForProvider": false,
    "emailEnabledForCustomer": true,
    "smsEnabledForCustomer": true,
    "phoneCallEnabledForCustomer": false,
    "whatsappEnabledForCustomer": false,
    "event": "PAYMENT_CREATED",
    "scheduleOffset": 0,
    "deleted": false
}

Due Date notification

Notification sent on the due date of the charge.

{
    "object": "notification",
    "id": "not_1igKsZL9xpsl",
    "customer": "cus_Y4AEif5zrMGK",
    "enabled": true,
    "emailEnabledForProvider": false,
    "smsEnabledForProvider": false,
    "emailEnabledForCustomer": true,
    "smsEnabledForCustomer": true,
    "phoneCallEnabledForCustomer": false,
    "whatsappEnabledForCustomer": false,
    "event": "PAYMENT_DUEDATE_WARNING",
    "scheduleOffset": 0,
    "deleted": false
}

Payment received notification

Notification sent at the moment Asaas registers the receipt of a charge.

{
    "object": "notification",
    "id": "not_f8JpoWuEjEKd",
    "customer": "cus_Y4AEif5zrMGK",
    "enabled": true,
    "emailEnabledForProvider": true,
    "smsEnabledForProvider": false,
    "emailEnabledForCustomer": true,
    "smsEnabledForCustomer": true,
    "phoneCallEnabledForCustomer": false,
    "whatsappEnabledForCustomer": false,
    "event": "PAYMENT_RECEIVED",
    "scheduleOffset": 0,
    "deleted": false
}

Digital Line on Due Date notification

Notification sent on the due date of the charge if the invoice or billet has not been viewed by your customer.

{
    "object": "notification",
    "id": "not_AWAz6FbrgCPG",
    "customer": "cus_Y4AEif5zrMGK",
    "enabled": true,
    "emailEnabledForProvider": false,
    "smsEnabledForProvider": false,
    "emailEnabledForCustomer": true,
    "smsEnabledForCustomer": true,
    "phoneCallEnabledForCustomer": false,
    "whatsappEnabledForCustomer": false,
    "event": "SEND_LINHA_DIGITAVEL",
    "scheduleOffset": 0,
    "deleted": false
}

Overdue Payment notification

Notification sent at the moment Asaas identifies that the charge has expired and has not been paid.

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

Every 7 Days After Due Date notification

Notification sent every 7 days as long as the charge is not paid.

📘
Note that we have two notifications with the event PAYMENT_OVERDUE, but this one has the scheduleOffset defined, yet the IDs of the notifications are different.

{
    "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
}

10 Days Before Due Date notification

Notification sent 10 days before the charge's due date.

📘
Note that we have two notifications with the event PAYMENT_DUEDATE_WARNING, but this one has the scheduleOffset defined, yet the IDs of the notifications are different.

{
    "object": "notification",
    "id": "not_uf8KkANRwUgh",
    "customer": "cus_Y4AEif5zrMGK",
    "enabled": true,
    "emailEnabledForProvider": false,
    "smsEnabledForProvider": false,
    "emailEnabledForCustomer": true,
    "smsEnabledForCustomer": true,
    "phoneCallEnabledForCustomer": false,
    "whatsappEnabledForCustomer": false,
    "event": "PAYMENT_DUEDATE_WARNING",
    "scheduleOffset": 10,
    "deleted": false
}

Payment Updated notification

Notification sent whenever a charge undergoes a change in due date or amount.

{
    "object": "notification",
    "id": "not_0YmiEVhOUsyJ",
    "customer": "cus_Y4AEif5zrMGK",
    "enabled": true,
    "emailEnabledForProvider": false,
    "smsEnabledForProvider": false,
    "emailEnabledForCustomer": true,
    "smsEnabledForCustomer": true,
    "phoneCallEnabledForCustomer": false,
    "whatsappEnabledForCustomer": false,
    "event": "PAYMENT_UPDATED",
    "scheduleOffset": 0,
    "deleted": false
}

Updated 8 months ago