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

Para ajudar sua aplicação a diferenciar o que é opcional do que é indispensável, nossa API utiliza o parâmetro "required" dentro do retorno do Webhook.

Ele funciona de forma muito simples:

• True (Verdadeiro): Indica que aquele débito é obrigatório e precisa ser quitado para que o veículo fique em dia.

• False (Falso): Indica que o débito é opcional ou pode ser pago em outro momento.

Essa marcação é essencial para que você possa sinalizar ao seu usuário, logo na tela de seleção, quais taxas ele não pode deixar de pagar para concluir, por exemplo, um licenciamento ou uma transferência.

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.