Events for Receivable Anticipations

You can use Webhooks so that your system is notified about changes that occur in receivable anticipations.

The events notified by Asaas are:

• RECEIVABLE_ANTICIPATION_CANCELLED - Anticipation canceled.
• RECEIVABLE_ANTICIPATION_SCHEDULED - Anticipation scheduled.
• RECEIVABLE_ANTICIPATION_PENDING - Anticipation under analysis.
• RECEIVABLE_ANTICIPATION_CREDITED - Anticipation credited.
• RECEIVABLE_ANTICIPATION_DEBITED - Anticipation debited.
• RECEIVABLE_ANTICIPATION_DENIED - Anticipation request denied.
• RECEIVABLE_ANTICIPATION_OVERDUE - Anticipation overdue.

Important behaviors

Asaas Webhooks use the at least once delivery model, meaning the same event may be sent more than once.

For this reason, it is recommended to implement idempotency using the event identifier:

id

In addition:

• HTTP responses outside the 2xx family may trigger new delivery attempts;
• the synchronization queue may be interrupted after consecutive failures;
• events remain stored for up to 14 days;
• new attributes may be added to the payload in the future.

Example JSON received [POST]

The notification consists of a POST containing a JSON, as shown below:

{
  "id": "evt_05b708f961d739ea7eba7e4db318f621&368604920",
  "event": "RECEIVABLE_ANTICIPATION_CREDITED",
  "dateCreated": "2024-06-12 16:45:03",
  "account": {
    "id": "47ed0d25-f9fb-4b35-b23a-d8895caf92b7",
    "ownerId": null
  },
  "anticipation": {
    "object": "anticipation",
    "id": "29ad50e9-64ee-427e-a00c-a3999510ca0a",
    "installment": null,
    "payment": "pay_4310966350068380",
    "status": "CREDITED",
    "anticipationDate": "2022-09-19",
    "dueDate": "2022-09-30",
    "requestDate": "2022-09-19",
    "fee": 5.64,
    "anticipationDays": 11,
    "netValue": 302.37,
    "totalValue": 310,
    "value": 308.01,
    "denialObservation": null
  }
}

Important fields

👍

Webhook response with typing and ENUMs

If you want to know the type of each field and the available ENUM values, check the 200 response of the endpoint "Retrieve a single receivable anticipation" in the documentation.

Best practices

We recommend:

• validating the asaas-access-token header;
• responding quickly using HTTP 2xx status codes;
• implementing idempotency using the id field;
• processing events asynchronously;
• continuously monitoring Webhook Logs;
• preparing the application to accept new attributes without throwing exceptions.

Common errors

Event processed more than once

Since delivery follows the at least once model, the same event may be resent.

Use the event identifier to avoid duplicates.

HTTP responses outside the 2xx range

Responses outside the 2xx family may trigger new delivery attempts.

Processing failures

If consecutive failures occur, the queue may be interrupted, preventing the delivery of new events until the issue is resolved.

🚧

Attention

• As new products and features are introduced in Asaas, new attributes may be added to the Webhook. It is very important that your code is prepared not to throw exceptions if Asaas returns new attributes not handled by your application, as this may cause interruption of the synchronization queue.
• We will send an email and notify our Discord whenever new fields are added to the Webhook. Notifications will be sent to the email address configured in the Webhook settings.