v1

latestOpenAPI 3.0.12026-07-26254581767.1 KB
Reivindicacao

Obtém uma lista de reivindicações, ordenada de forma crescente pelo campo ModificadaDepoisDe, de acordo com os filtros passados.

Ao percorrer a lista em intervalos de tempo fechados, recomendável para que não se pule nenhum elemento, alguns elementos retornados poderão se repetir. O comportamento dos filtros isDonor e isClaimer, quando os valores passados são iguais, é disjuntivo: são retornadas reinvidicações em que o participante é doador OU reivindicador. A atualização de informações de reinvindicações para listagens é assíncrona em relação às operações de inclusão e atualização de registros, sendo assim, é possível haver um retardo de 5 segundos até que os dados incluídos ou alterados constem na consulta.

get/pix/indireto/dict/reivindicacao

Query parameters

IncluirParticipantesIndiretosboolean

Inclui adicionalmente as reivindicações de participantes indiretos.

SomenteDoadoresboolean

Restringe a reivindicações em que o participante é doador.

SomenteReivindicadoresboolean

Restringe a reivindicações em que o participante é reivindicador.

SituacaoBs2Core2PixIndiretoDictAppDomainStatusReivindicacao[]

Lista de a Status a serem pesquisados.

Tipo'Posse' | 'Portabilidade'

Tipo de reivindicação

Tipo de reivindicação.

ModificadaAntesDestring date-time

Filtra reivindicações com data-hora de modificação menor ou igual a modifiedBefore.

ModificadaDepoisDestring date-time

Filtra reivindicações com data-hora de modificação maior ou igual a ModificadaDepoisDe.

Limiteinteger

Número limite de reivindicações a retornar

Headers

api-versionstring required
Authorizationstring required

Auth

Response

Sucesso

correlationIdstring nullable

Identificador de correlação para suporte operacional.

existemMaisboolean

Existem mais elementos para iterar.