Bill events

Listen to Asaas events to keep your integration up to date.

You can use webhooks so your system is notified about changes that occur in bill payments. The events that Asaas notifies are:

  • BILL_CREATED - Creation of a new bill payment.
  • BILL_PENDING - Bill payment awaiting processing.
  • BILL_BANK_PROCESSING - Bill payment awaiting bank processing.
  • BILL_PAID - Bill payment made.
  • BILL_CANCELLED - Bill payment cancelled.
  • BILL_FAILED - Bill payment failed.
  • BILL_REFUNDED - Bill payment refunded.

Example of JSON to be received [POST]

The notification consists of a POST containing a JSON, as in this example:

{
    "event":"BILL_PAID",
    "bill": {
        "object": "bill",
        "id": "f1bce822-6f37-4905-8de8-f1af9f2f4bab",
        "status": "PAID",
        "value": 29.90,
        "discount": 0.00,
        "interest": 0.00,
        "fine": 0.00,
        "identificationField": "03399.77779 29900.000000 04751.101017 1 81510000002990",
        "dueDate": "2020-01-31",
        "scheduleDate": "2020-01-31",
        "paymentDate": null,
        "fee": 0.00,
        "description": "Mobile 01/12",
        "companyName": null,
        "transactionReceiptUrl": "https://www.asaas.com/comprovantes/00016578",
        "canBeCancelled": false,
        "failReasons": null
    }
}

🚧

  • With the introduction of new products and functionalities within Asaas, it's possible that new attributes may be included in the Webhook. It's very important that your code is prepared not to generate exceptions if Asaas returns new attributes not handled by your application, as this could interrupt the synchronization queue.
  • We will send an email and notify on our Discord when new fields are included in the Webhook. The notification will be sent to the email defined in the webhook settings.