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

Consultar Pix recebidos.

Endpoint para consultar Pix recebidos

Sem ações implementadas definidas

Request

Query params

inicio

Required

Type: string

fim

Required

Type: string

txid

Type:

cpf

Type: string

cnpj

Type: string

paginacao.paginaAtual

Type: integer

paginacao.itensPorPagina

Type: integer

Response

200

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

parametros
Object

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

inicio
String

Data inicial utilizada na consulta. Respeita RFC 3339.

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

fim
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
Object

paginaAtual
Integer >= 0

Número da página recuperada.

itensPorPagina
Integer >= 1

Quantidade de registros retornado na página.

Ex: 100

quantidadeDePaginas
Integer >= 1

Quantidade de páginas disponí­veis para consulta.

Ex: 5

quantidadeTotalDeItens
Integer >= 0

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

Ex: 503

pix
Array

Example
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
  "parametros": {
    "inicio": "2020-01-01T00:00:00Z",
    "fim": "2020-12-01T17:00:00Z",
    "txid": "<TXID>",
    "txIdPresente": "<TXIDPRESENTE>",
    "devolucaoPresente": "<DEVOLUCAOPRESENTE>",
    "cpf": "<CPF>",
    "cnpj": "<CNPJ>",
    "paginacao": {
      "paginaAtual": "<PAGINAATUAL>",
      "itensPorPagina": 100,
      "quantidadeDePaginas": 5,
      "quantidadeTotalDeItens": 503
    }
  },
  "pix": [
    "<PIX>"
  ]
}