Skip to main content
GET
List recurrences (Pix Automático)

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Query Parameters

inicio
string<date-time>
required

Início do filtro de criação (RFC 3339).

fim
string<date-time>
required

Fim do filtro de criação (RFC 3339).

cpf
string

Filtro pelo CPF do devedor. Mutuamente exclusivo com cnpj.

Pattern: ^\d{11}$
cnpj
string

Filtro pelo CNPJ do devedor. Mutuamente exclusivo com cpf.

Pattern: ^[0-9A-Z]{14}$
convenio
string

Filtro pelo convênio associado.

Maximum string length: 60
status
string

Filtro pelo status da recorrência.

paginacao.paginaAtual
integer<int64>

Página a ser retornada (0-based).

Required range: x >= 0
paginacao.itensPorPagina
integer<int64>

Itens por página (1..1000).

Required range: 1 <= x <= 1000

Response

OK

parametros
object
required
recs
object[]
required