Eventos para Checkout

Os Webhooks são a melhor e mais segura forma de manter os dados da sua aplicação atualizados com os dados do Asaas. Você sempre receberá um novo evento quando o status do Webhook mudar.

Como utilizar os webhooks do checkout:

POST https://api.asaas.com/api/v3/webhooks
header: access_token

{  
"name": "teste",  
"url":"<https://minha-url.com">,  
"sendType":"SEQUENTIALLY",  
"email":"[[email protected]](mailto:[email protected])",  
"enabled":true,  
"interrupted":false,  
"events":[  
"CHECKOUT_CREATED",  
"CHECKOUT_CANCELED",  
"CHECKOUT_EXPIRED",  
"CHECKOUT_PAID"  
]  
}

O endpoint de webhook do checkout é o mesmo utilizado para criação de webhook do asaas e podemos encontrar mais informações na documentação padrão da API.

A única mudança são os eventos do checkout, no body params da requisição deve ser adicionado os eventos que desejamos acompanhar:

CHECKOUT_CREATED - Checkout criado
CHECKOUT_CANCELED - Checkout cancelado
CHECKOUT_EXPIRED - Checkout expirado
CHECKOUT_PAID - Checkout pago

Feito a configuração acima, o webhook do checkout passará a enviar requisições para a url configurada. Segue exemplo da requisição POST que será feita pelo webhook para a sua URL cadastrada:

{  
  "id": "evt_37260be8159d4472b4458d3de13efc2d&15370",  
  "event": "CHECKOUT_CREATED",  
  "dateCreated": "2024-10-31 18:07:47",  
  "checkout": {  
    "id": "2bd251f0-09b2-44ff-8a0c-a5cb29e5bbda",  
    "link": null,  
    "status": "ACTIVE",  
    "minutesToExpire": 10,  
    "billingTypes": [  
      "MUNDIPAGG_CIELO"  
    ],  
    "chargeTypes": [  
      "RECURRENT"  
    ],  
    "callback": {  
      "cancelUrl": "<https://google.com">,  
      "successUrl": "<https://google.com">,  
      "expiredUrl": "<https://google.com">  
    },  
    "items": [  
      {  
        "name": "teste2",  
        "description": "teste",  
        "quantity": 2,  
        "value": 100  
      },  
      {  
        "name": "teste2",  
        "description": "teste2",  
        "quantity": 2,  
        "value": 100  
      }  
    ],  
    "subscription": {  
      "cycle": "MONTHLY",  
      "nextDueDate": "2024-10-31T03:00:00+0000",  
      "endDate": "2025-10-29T03:00:00+0000"  
    },  
    "installment": null,  
    "split": [  
      {  
        "walletId": "c1ad713f-77fc-45b0-b734-b2ff9970d6d8",  
        "fixedValue": 2,  
        "percentualValue": null,  
        "totalFixedValue": null  
      },  
      {  
        "walletId": "c1ad713f-77fc-45b0-b734-b2ff9970d6d8",  
        "fixedValue": null,  
        "percentualValue": 2,  
        "totalFixedValue": null  
      }  
    ],  
    "customer": "cus_000000018936",  
    "customerData": null  
  }  
}