Docs
Getting Started
API
get https://api.pix.iugu.com/api/v2/pix

Consultar Pix recebidos.

Endpoint para consultar Pix recebidos

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

  • fim

    Obrigatório

    String

  • txid

  • cpf
    String /^\d{11}$/

  • cnpj
    String /^\d{14}$/

  • paginacao.paginaAtual
    Integer >= 0
    Default: `0`

  • paginacao.itensPorPagina
    Integer [1..1000]
    Default: `100`

Respostas
200
lista dos Pix recebidos de acordo com o critério de busca.
parametros

Obrigatório

Object

Parâmetros utilizados para a realização de uma consulta de Pix.
inicio

Obrigatório

String

Data inicial utilizada na consulta. Respeita RFC 3339.

Ex: 2020-01-01T00:00:00Z
fim

Obrigatório

String

Data de fim utilizada na consulta. Respeita RFC 3339.

Ex: 2020-12-01T17:00:00Z
txid

txIdPresente
Boolean

Filtro pela existência de txid.
devolucaoPresente
Boolean

Filtro pela existência de devolução.
cpf
String /^\d{11}$/

CPF
cnpj
String /^\d{14}$/

CNPJ
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
pix
Array

Voltar

Consultar Pix

Avançar

Criar location do payload.