Consultar Pix recebidos.

GET

/pix

Pix

Endpoint para consultar Pix recebidos

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://infopago.apidog.io//pix?inicio&fim'

Response Example

200 - Exemplo de retorno da consulta de Pix 1

{
    "parametros": {
        "inicio": "2020-04-01T00:00:00Z",
        "fim": "2020-04-01T23:59:59Z",
        "paginacao": {
            "paginaAtual": 0,
            "itensPorPagina": 100,
            "quantidadeDePaginas": 1,
            "quantidadeTotalDeItens": 2
        }
    },
    "pix": {
        "endToEndId": "E12345678202009091221abcdef12345",
        "txid": "cd1fe328c875481285a6f233ae41b662",
        "valor": "100.00",
        "horario": "2020-09-10T13:03:33.902Z",
        "infoPagador": "Reforma da casa",
        "devolucoes": [
            {
                "id": "000AAA111",
                "rtrId": "D12345678202009091000abcde123456",
                "valor": "11.00",
                "horario": {
                    "solicitacao": "2020-09-10T13:03:33.902Z"
                },
                "status": "EM_PROCESSAMENTO"
            }
        ]
    }
}

Requisição

Parâmetros Query

inicio

string <date-time>

requerido

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

fim

string <date-time>

requerido

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

txid

string

opcional

The "txId" field is a unique identifier generated by the Pix system to uniquely identify and monitor transactions.

Padrão de combinação:

[a-zA-Z0-9]{1,35}

txIdPresente

boolean

opcional

devolucaoPresente

boolean

opcional

cpf

string

CPF

opcional

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

Padrão de combinação:

/^\d{11}$/

cnpj

string

CNPJ

opcional

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

Padrão de combinação:

/^\d{14}$/

paginacao.paginaAtual

integer <int32>

Página atual

opcional

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

>= 0

Padrão:

paginacao.itensPorPagina

integer <int32>

Itens por Página

opcional

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

>= 1<= 1000

Padrão:

100

Respostas

🟢200OK

application/json

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

Body

parametros

object (Parâmetros de Consulta Pix)

requerido

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

inicio

string <date-time>

Data de Início

requerido

Data inicial utilizada na consulta. Respeita RFC 3339.

Exemplo:

2020-01-01T00:00:00Z

fim

string <date-time>

Data de Fim

requerido

Data de fim utilizada na consulta. Respeita RFC 3339.

Exemplo:

2020-12-01T17:00:00Z

txid

string

opcional

The "txId" field is a unique identifier generated by the Pix system to uniquely identify and monitor transactions.

Padrão de combinação:

[a-zA-Z0-9]{1,35}

txIdPresente

boolean

opcional

Filtro pela existência de txid.

devolucaoPresente

boolean

opcional

Filtro pela existência de devolução.

cpf

string

opcional

CPF

Padrão de combinação:

/^\d{11}$/

cnpj

string

opcional

CNPJ

Padrão de combinação:

/^\d{14}$/

paginacao

object (Paginação)

requerido

pix

array[object (Pix) {8}]

Lista de Pix recebidos

opcional

endToEndId

string

EndToEndId

requerido

The "endToEndId" field refers to a unique identifier that can be used to track and associate a specific transaction throughout the lifecycle of the operation. The term "end-to-end" pertains to the ability to trace the transaction from beginning to end, ensuring data integrity along the way.

txid

string

opcional

The "txId" field is a unique identifier generated by the Pix system to uniquely identify and monitor transactions.

Padrão de combinação:

[a-zA-Z0-9]{1,35}

valor

string

Valor do Pix.

requerido

Valor do Pix.

Padrão de combinação:

\d{1,10}\.\d{2}

componentesValor

Informações sobre o valor do Pix

opcional

O objetivo dessa estrutura é explicar os elementos de composição do valor do Pix, incluindo informações sobre as multas, juros, descontos e abatimentos quando o Pix for relativo a cobranças com vencimento.

Regras da estrutura:

O valor do Pix é igual a:

(original.valor + saque.valor + troco.valor) + multa.valor + juros.valor – abatimento.valor – desconto.valor
considerando-se apenas os campos que estiverem presentes para cada tipo de cobrança pago.

As estruturas saque e troco só serão retornadas quando o Pix for relativo a um Pix Saque ou Pix Troco, respectivamente, e
as demais estruturas (juros, multa, abatimento e desconto) só serão pertinentes aos Pix de pagamentos das cobranças com vencimento.

Não pode haver simultaneamente uma subsestrutura do tipo saque e outra do tipo troco;

Não há restrição na ordem das subestruturas.

Para o caso de um Pix Saque pode-se retornar original com valor=0.00 (zero) uma vez que a soma será respeitada, ou pode-se omitir a
subestrutura original. No caso de um Pix Troco ou de um pagamento de cobrança com vencimento a subsestrutura original vai sempre estar
presente.

Exemplos válidos:

Exemplo de preenchimentos válidos.

Pix para pagamento de cobrança imediata (sem saque ou troco).

...
"componentesValor": {
  "original": {
    "valor": "100.00"
  } 
}
...

Pix Saque.

...
"componentesValor": {
  "saque": {
    "valor": "100.00",
    "modalidadeAgente": "AGPSS",
    "prestadorDeServicoDeSaque": "12345678"
  } 
}
...

Pix para pagamento de cobrança imediata com saque (pode vir original.valor=0.00).

...
"componentesValor": {
  "original": {
    "valor": "0.00"
  },
  "saque": {
    "valor": "100.00",
    "modalidadeAgente": "AGPSS",
    "prestadorDeServicoDeSaque": "12345678"
  } 
}
...

Pix Troco.

...
"componentesValor": {
  "original": {
    "valor": "80.00"
  },
  "troco": {
    "valor": "20.00",
    "modalidadeAgente": "AGTEC",
    "prestadorDeServicoDeSaque": "12345678"
  } 
}
...

Pix para pagamento de cobrança imediata com troco (ordem não importa).

...
"componentesValor": {
  "troco": {
    "valor": "20.00",
    "modalidadeAgente": "AGTEC",
    "prestadorDeServicoDeSaque": "12345678"
  },
  "original": {
    "valor": "80.00"
  }
}
...

Pix para pagamento de cobrança com vencimento de R $100, 00 co n s i d er an d o - se u ma t r a so d e 2 d ia s a u mam u lt a d e 3$ 105,00.

...
"componentesValor": {
  "original": {
    "valor": "100.00"
  },
  "multa": {
    "valor": "3.00"
  },
  "juros": {
    "valor": "2.00"
  }
}
...

Exemplos inválidos:

Exemplos, não exaustivos, de preenchimentos inválidos.

original.valor maior que 0.00 (zero) e saque juntos

...
"componentesValor": {
  "original": {
    "valor": "80.00"
  },
  "saque": {
    "valor": "20.00",
    "modalidadeAgente": "AGPSS",
    "prestadorDeServicoDeSaque": "12345678"
  } 
}
...

dois elementos de saque

...
"componentesValor": [
  "saque": {
    "valor": "20.00",
    "modalidadeAgente": "AGPSS",
    "prestadorDeServicoDeSaque": "12345678"
  },
  "saque": {
    "valor": "10.00",
    "modalidadeAgente": "AGPSS",
    "prestadorDeServicoDeSaque": "12345678"
  } 
]
...

saque e troco simultaneamente

...
"componentesValor": {
  "original": {
    "valor": "60.00"
  },
  "saque": {
    "valor": "20.00",
    "modalidadeAgente": "AGPSS",
    "prestadorDeServicoDeSaque": "12345678"
  },
  "troco": {
    "valor": "20.00",
    "modalidadeAgente": "AGTEC",
    "prestadorDeServicoDeSaque": "12345678"
  } 
}
...

chave

string

Chave DICT do recebedor

opcional

Formato do campo chave

Campo chave do recebedor conforme atribuído na respectiva PACS008.

Os tipos de chave podem ser: telefone, e-mail, cpf/cnpj ou EVP.

O formato das chaves pode ser encontrado na seção "Formatação das chaves do DICT no BR Code" do Manual de Padrões para iniciação do Pix.

<= 77 Caracteres

horario

string <date-time>

Horário

requerido

Horário em que o Pix foi processado no PSP.

infoPagador

string

Informação livre do pagador

opcional

<= 140 Caracteres

devolucoes

array[object (Devolução) {8}]

Devoluções

opcional

🟠403Forbidden

🔴503Service Unavailable