Endpoint responsável por consultar negativações cadastradas na conta de forma paginada, com suporte a filtros por status, tipo, cobrança e período de solicitação.

Diferente da recuperação de uma negativação específica, essa chamada retorna uma lista de registros compatíveis com os filtros informados na consulta.

Funcionamento da listagem

A resposta desse endpoint é paginada.

Isso significa que as negativações são retornadas em blocos, respeitando os parâmetros de navegação enviados na requisição. Esse comportamento é importante para integrações que realizam acompanhamento operacional, rotinas administrativas ou consultas em maior volume.

Parâmetros principais da requisição

Alguns filtros são mais comuns na integração:

offset - Define o elemento inicial da lista.

limit - Define a quantidade máxima de elementos retornados por chamada. O limite máximo é 100.

status - Filtra as negativações pelo status atual.

Os status possíveis incluem:

• PENDING
• AWAITING_APPROVAL
• AWAITING_CANCELLATION
• PROCESSED
• PAID
• PARTIALLY_PAID
• DENIED
• CANCELLED

type - Filtra pelo tipo de negativação.

Os valores possíveis são:

• CREDIT_BUREAU
• DEBT_RECOVERY_ASSISTANCE

payment - Filtra negativações vinculadas a uma cobrança específica.

requestStartDate - Filtra a partir da data inicial de solicitação.

requestEndDate - Filtra até a data final de solicitação.

Casos de uso mais comuns

Esse endpoint costuma ser utilizado para:

• localizar negativações de uma cobrança específica
• consultar negativações por status
• acompanhar solicitações em aberto
• montar telas administrativas e relatórios operacionais
• apoiar fluxos internos de acompanhamento e suporte

Regra importante para requisições GET

Chamadas GET devem ser enviadas com o body vazio.

Caso a integração envie conteúdo no corpo da requisição, a API poderá retornar erro 403 Forbidden.