Retorna uma lista de solicitações de opt-ins

Este serviço retorna a lista paginada de solicitações de opt-ins do Agente Financiador de acordo com o filtro desejado.

Através dessa rota também é possível consultar o processamento da solicitação de opt-in ou opt-out.

Query Params
integer
1 to 100
Defaults to 100

Quantidade de registros por página.

integer
≥ 0
Defaults to 0

Quantidade de registros a pular.

uuid

Identificador de processamento gerado a partir da solicitação do Financiador, seja opt-in ou do opt-out.

string

Identificadores de opt-in separados por vírgula.

string

Status do opt-in separados por vírgula. Aceita pending, created, approved, refused, expired.

string
enum

Frequência de atualização da agenda.

ValorDescrição
dailyDiária.
weeklySemanal.
biweeklyQuinzenal.
monthlyMensal.
no_recurrenceSem recorrência (consulta única).
Allowed:
string
enum

Abrangência da agenda autorizada pelo opt-in.

ValorDescrição
allTraz a consolidação completa da base sem filtro de status de ciclo de vida (combina tanto os registros ativos em open quanto o acervo historical).
openRetorna apenas as duplicatas ou registros ativos que possuem saldo/devedor pendente.
historicalRetorna o registro de eventos passados, títulos totalmente liquidados, baixados, cancelados ou invalidados, cujo ciclo de vida operacional já foi concluído.
Allowed:
string

Documento do Sacador, sem máscara.

date

Início de vigência a partir desta data.

date

Início de vigência até esta data.

date

Fim de vigência a partir desta data.

date

Fim de vigência até esta data.

date-time

Data inicial de solicitação de opt-in/opt-out. Busca por intervalo, incluindo a data informada.

date-time

Data fim de solicitação de opt-in/opt-out. Busca por intervalo, incluindo a data informada. Caso não seja informada, o valor padrão é de 30 dias a partir da data inicial. O intervalo entre as datas é limitado a 6 (seis) meses.

date-time

Data inicial do intervalo de atualização. A busca inclui a data informada.

date-time

Data final do intervalo de atualização. A busca inclui a data informada. Caso não seja informada, o valor padrão é de 30 dias a partir da data inicial. O intervalo entre as datas é limitado a 6 (seis) meses.

string
Defaults to requested_at_desc

Ordenação da listagem. Valores aceitos: requested_at_asc, requested_at_desc, updated_at_asc, updated_at_desc, calendar_valid_from_asc, calendar_valid_from_desc, calendar_valid_until_asc, calendar_valid_until_desc.

Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json