Consultar lista de cobranças com vencimento.

get

https://pix.example.com/api/cobv

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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.

cpf

string

/^\d{11}$/

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

cnpj

string

^[0-9A-Z]{14}$

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

locationPresente

boolean

status

string

Filtro pelo status da cobrança.

loteCobVId

int32

Id do lote de cobrança com vencimento.

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.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200Lista de cobranças com vencimento.

403Requisição de participante autenticado que viola alguma regra de autorização.

503Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento.