Consultar lista de cobranças recorrentes.

get

https://api2.cielo.com.br/sandbox/cielo-pix/v1/cobr

Endpoint para consultar cobranças recorrentes através de parâmetros como início, fim, idRec, cpf, cnpj e status.

Query Params

inicio

date-time

required

Filtra os registros cuja data de criação seja maior ou igual que a data de início. Respeita RFC 3339.

fim

date-time

required

Filtra os registros cuja data de criação seja menor ou igual que a data de fim. Respeita RFC 3339.

idRec

string

length between 29 and 29

[a-zA-Z0-9]{29}

Filtro pelo Identificador da Recorrência.

cpf

string

/^\d{11}$/

Filtro pelo CPF do devedor. Não pode ser utilizado ao mesmo tempo que o CNPJ.

cnpj

string

/^\d{14}$/

Filtro pelo CNPJ do devedor. Não pode ser utilizado ao mesmo tempo que o CPF.

status

string

Filtro pelo status da recorrência.

convenio

string

length ≤ 60

Filtro pelo convênio associado.

paginacao.paginaAtual

int32

≥ 0

Defaults to 0

Página a ser retornada pela consulta. Se não for informada, o PSP assumirá que será 0.

paginacao.itensPorPagina

int32

1 to 1000

Defaults to 100

Quantidade máxima de registros retornados em cada página. Apenas a última página pode conter uma quantidade menor de registros.

Responses

200Lista de cobranças recorrentes.