Documentação - Documentação

get https://api.pix.iugu.com/api/v2/cob

Consultar lista de cobranças imediatas.

Permissão necessária:

Esta permissão deve constar como uma das ações permitidas para o app que faz a chamada. Isto pode ser feito através do GIA, ou então na edição do aplicativo. Em caso de dúvidas, clique aqui.

Parâmetros de Query

inicio
Obrigatório

String

Ex: 2023-07-03T00:35:00Z
fim
Obrigatório

String

Ex: 2023-08-29T23:22:31Z
cpf

String

Ex: 24649507006
cnpj

String

Ex: 89321417000160
status

String
[ ATIVA, CONCLUIDA, REMOVIDO_PELO_USUARIO_RECEBEDOR, REMOVIDO_PELO_PSP ]

Ex: ATIVA
paginacao.paginaAtual

Integer
Valor padrão: 0

Ex: 3
paginacao.itensPorPagina

Integer
Valor padrão: 100

Ex: 10

Parâmetros no Cabeçalho

workspace_id
Obrigatório

String
Identificador do workspace

Ex: 4fHECmQtLdROI4fDLWMiLd

Respostas

200

Lista de cobranças imediatas.

parametros

Obrigatório

Object

Parâmetros utilizados para a realização de uma consulta de cobranças.

inicio

Obrigatório

String

Data inicial utilizada na consulta. Respeita RFC 3339.

Ex: 2023-08-01T03:00:00Z

fim

Obrigatório

String

Data de fim utilizada na consulta. Respeita RFC 3339.

Ex: 2023-08-01T3:00:00Z

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 das cobrançaas.

Ex: ATIVA

paginacao

Obrigatório

Object

paginaAtual

Obrigatório

Integer >= 0

Número da página recuperada.

itensPorPagina

Obrigatório

Integer >= 1

Quantidade de registros retornado na página.

Ex: 100

quantidadeDePaginas

Obrigatório

Integer >= 1

Quantidade de páginas disponíveis para consulta.

Ex: 5

quantidadeTotalDeItens

Obrigatório

Integer >= 0

Quantidade total de itens disponíveis de acordo com os paâmetros informados.

Ex: 503

cobs Array

Voltar

Sumário de Implementação

Avançar

Criar cobrança imediata