Como saber se a liquidação de um débito é obrigatória?

Em nossa API, o parâmetro "required" no response retornado pelo webhook indica, em formato booleano, se a transação listada é um débito que obrigatoriamente deve ser pago.

Outros parâmetros no response também informam sobre obrigatoriedades e dependências. Para mais detalhes, consulte nosso artigo e nossa documentação.

Exemplo de uso do parâmetro "required":

"debts": [
    {
      "id": "87D4B252-1A3D-4918-A390-1C911424485B",
      "amount": 5.23,
      "title": "Seguro Obrigatório 2022",
      "description": "Seguro Obritatório 2022",
      "dueDate": null,
      "expirationDate": "2022-09-30T00:00:00",
      "hasDiscount": false,
      "isExpired": true,
      "type": "insurance",
      "year": 2022,
"required": true,
      "dependsOn": [],
      "distinct": []
    },
 ]

No exemplo acima, o débito é identificado como obrigatório para pagamento, pois o parâmetro "required" está definido como true.