added

Changelog API Grafeno: 2026-03-12

Added: [API de Cobranças] Fluxo de alteração de cobranças Vórtx

A API de Cobranças da Grafeno foi aprimorada para permitir maior flexibilidade no fluxo de alteração de títulos.
Agora é possível:

• Prorrogar a data de vencimento (dueDate) mesmo quando a cobrança possui regras de desconto configuradas.
• Incluir, remover ou alterar o valor de abatimento (abatementValue) de uma cobrança já registrada.

Essas alterações somente podem ser realizadas em cobranças já registradas.

Novo fluxo de atualização assíncrona

Para melhorar a observabilidade e previsibilidade das alterações, a API passa a expor dois novos campos no recurso de cobrança:

updateStatus
updateDetails

Esses campos permitem acompanhar o status de processamento das solicitações de alteração realizadas na cobrança.

Uma única requisição pode solicitar simultaneamente a alteração de dueDate, abatementValue e yourNumber, cada alteração é processada de forma independente, e o tempo máximo para conclusão do processamento pode chegar a até 30 minutos.

Parâmetro updateStatus

Indica o status global da última solicitação de atualização da cobrança. Valores possíveis:

ValorDescrição
pendingSolicitação de alteração recebida e aguardando processamento.
processingSolicitação de alteração em processamento.
completedTodas as alterações foram processadas e concluídas com sucesso.
completed_with_errorsPelo menos uma alteração foi concluída com sucesso enquanto outras falharam.
failedTodas as solicitações de alteração falharam.

Parâmetro updateDetails

Lista detalhada com o resultado de cada alteração solicitada.

Exemplos da estrutura updateDetails:

{
  "updateStatus": "processing",
  "updateDetails": [
    {
      "field": "dueDate",
      "status": "processing"
    }
  ]
}

{
  "updateStatus": "completed",
  "updateDetails": [
    {
      "field": "dueDate",
      "status": "success",
      "previousValue": "2026-08-01",
      "newValue": "2026-10-18",
      "updatedAt": "2026-03-12T14:14:19-03:00"
    },
    {
      "field": "abatementValue",
      "status": "success",
      "previousValue": 12,
      "newValue": 15,
      "updatedAt": "2026-03-12T14:14:19-03:00"
    }
  ]
}

{
  "updateStatus": "completed_with_errors",
  "updateDetails": [
    {
      "field": "dueDate",
      "status": "failed",
      "message": "Não foi possível alterar a data de vencimento, a data informada é inválida.",
      "error_code": "DUE_DATE_ERROR"
    },
    {
      "field": "abatementValue",
      "status": "success",
      "previousValue": 12,
      "newValue": 15,
      "updatedAt": "2026-03-12T14:14:19-03:00"
    }
  ]
}

{
  "updateStatus": "failed",
  "updateDetails": [
    {
      "field": "dueDate",
      "status": "failed",
      "message": "Não foi possível alterar a data de vencimento, a data informada é inválida.",
      "error_code": "DUE_DATE_ERROR"
    },
    {
      "field": "abatementValue",
      "status": "failed",
      "message": "Não foi possível incluir o abatimento.",
      "error_code": "GENERIC_ERROR"
    }
  ]
}

A nova estrutura permite que integrações acompanhem o processamento de cada alteração individualmente, facilitando tratamento de erros, observabilidade e automação de retries quando necessário.

Acesse a especificação técnica da API de Cobranças Grafeno para obter informações sobre como utilizar este recurso.