Eventos para pague contas

Escute os eventos do Asaas para ter sua integração em dia.

É possível utilizar webhook para que seu sistema seja notificado sobre alterações que ocorram
no pagamento de contas. Os eventos que o Asaas notifica são:

  • BILL_CREATED - Geração de um novo pague contas.
  • BILL_PENDING - Pagamento de contas aguardando processamento.
  • BILL_BANK_PROCESSING - Pagamento de contas aguardando processamento bancário.
  • BILL_PAID - Pagamento de contas pago.
  • BILL_CANCELLED - Pagamento de contas cancelado.
  • BILL_FAILED - Pagamento de contas falhou.
  • BILL_REFUNDED - Pagamento de contas estornado.

Exemplo de JSON a ser recebido [POST]

A notificação consiste em um POST contendo um JSON, conforme este exemplo:

{
    "id": "evt_05b708f961d739ea7eba7e4db318f621&368604920",
    "event":"BILL_PAID",
    "dateCreated": "2024-06-12 16:45:03",
    "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": "Celular 01/12",
        "companyName": null,
        "transactionReceiptUrl": "https://www.asaas.com/comprovantes/00016578",
        "canBeCancelled": false,
        "failReasons": null
    }
}

👍

Retorno do Webhook com tipagem e ENUMs

Caso você queira saber qual o tipo de cada campo e os retornos de ENUMs disponíveis, confira a resposta 200 no endpoint "Recuperar um único pagamento de contas" na documentação.

🚧

  • Com a entrada de novos produtos e funções dentro do Asaas, é possível que novos atributos sejam incluídos no Webhook. É muito importante que seu código esteja preparado para não gerar exceções caso o Asaas devolva novos atributos não tratados pela sua aplicação, pois isso poderá causar interrupção na fila de sincronização.
  • Enviaremos um e-mail e avisaremos em nosso Discord quando novos campos forem incluídos no Webhook. O disparo será feito para o e-mail de notificação definido nas configurações do webhook.