API Reference

Consultar lista de cobranças com vencimento

get
https://api.pix.voluti.com.br/cobv

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
date-time
required

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

date-time
required

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

string

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

string

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

boolean

Filtra pela presença de uma localização associada.

string

Filtro pelo status da cobrança.

int32

Id do lote de cobrança com vencimento.

int32
≥ 0
Defaults to 0

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

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

Updated almost 2 years ago

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

Updated almost 2 years ago