Cobrança - Consultar lista de cobranças

get

https://example.com/pix/direto/forintegration/v1/cob

Query Params

Inicio

date-time

required

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

Fim

date-time

required

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

CPF

string | null

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

CNPJ

string | null

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

Status

string

enum

Filtro pelo status da cobrança.

Allowed:

Paginacao.PaginaAtual

int32

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

Paginacao.ItensPorPagina

int32

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

Responses

204

Consulta realizada com sucesso, porém sem resultados.

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Consulta realizada com sucesso.