Listar chaves Pix Imediato

Use este endpoint para listar aachaves PIX de acordo com os parêmetros informados.

curl --location --request GET 'https://horizon-api-sb.app.rpe.tech/api/v1/pix?pageSize&page&pagamentoNotificado&idPortador&status&dataEmissaoFinal &dataEmissaoInicial ' \ --header 'Accept: */*' \ --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwZDI1NmI2MS03Y2RhLTQ5MzItYjVmNS1hZGIxOGUyNzc3MDQifQ.eyJleHAiOjE3NDI1ODE3NTMsImlhdCI6MTc0MjU2Mzc1MywianRpIjoiMDljMmMwMWUtNmMyNS00NTg5LWIyODUtZGZlMzIxZjUzZDhlIiwiaXNzIjoiaHR0cDovL3ZwYy1saW5rLXNiLmFwcC5ycGUudGVjaC9yZWFsbXMvcnBlIiwic3ViIjoiNGY2YmM0ZTgtMTRjYi00YmU4LWI4M2MtOWNiMTNhM2NiOWQwIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoicnBlY2xpZW50Iiwic2Vzc2lvbl9zdGF0ZSI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsInNjb3BlIjoicHJvZmlsZSIsInNpZCI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsImlzc3VlcmlkIjoxLCJyb2xlcyI6WyJST0xFX1NJU1RFTUEiLCJST0xFX1BBQ09URV9TTVNfQ09OU1VMVEFfTElTVEEiLCJST0xFX0NPTlNVTFRBUl9QT1JUQURPUiIsIlJPTEVfQ0FSVE9FU19BRE1JTiIsIlJPTEVfdGVzdGUtcm9sZSIsIlJPTEVfUEFDT1RFX1NNU19DT05TVUxUQV9QQUNPVEVTX0RJU1BPTklWRUlTIiwiUk9MRV9QQUNPVEVfU01TX0FMVEVSQUNBT19SRUNFQkVfQk9OVVNfQ0VMVUxBUiIsIlJPTEVfdW1hX3Byb3RlY3Rpb24iLCJST0xFX1BBQ09URV9TTVNfQ0FEQVNUUk9fQ09OVFJBVEFDQU9fUEFDT1RFIiwiUk9MRV9QQUNPVEVfU01TX0NBREFTVFJPX0NFTFVMQVJfU01TIiwiUk9MRV9QQUNPVEVfU01TX0NPTlNVTFRBX1BBQ09URVNfQ09OVFJBVEFET1MiLCJST0xFX0FETUlOIiwiUk9MRV9QQUNPVEVfU01TX1JFTU9DQU9fUEFDT1RFIl0sInVzZXJuYW1lIjoicnBlLXNhbmRib3gifQ.DtxNXDEFD4R7hP8XusdDNqGNvI2_NtwR5tZAjbYYEb2SWSANiPx8kRLMzVcqkvCWf57PqEAIEO6uQN9mbcYBwQ' \ --header 'Content-Type: application/json'

[ { "id": "string", "banco": "ITAU", "status": "GERADO", "pagamentoNotificado": true, "dataEmissao": "2022-01-20T09:30:00Z", "dataVencimento": "2022-01-21T02:59:00Z", "emv": "string", "base64": "string", "dataPagamento": "2022-01-20T22:00:00Z", "recebimento": { "id": "string", "data": "022-01-20T09:30:00Z", "endToEndId": "string", "valor": 149.9, "pagamentoNotificado": true, "infoPagador": "149-9" }, "valor": 149.9, "idPortador": 12, "txid": "string" } ]

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros Query

pageSize

integer <int32>

opcional

Quantidade de registros por página. Caso este parâmetro não seja informado, o sistema considera 50.

page

integer <int32>

opcional

Primeira página. Caso este parâmetro não seja informado, o sistema considera 1.

pagamentoNotificado

boolean

opcional

Identifica se o pagamento foi notificado ou não à processadora.

idPortador

integer <int64>

opcional

ID do portador a ser consultado.

status

enum<string>

opcional

Status do Pix

Valores permitidos:

GERADOPAGOCANCELADOERRO_AO_GERAR

dataEmissaoFinal

string <date-time>

requerido

Data de emissão final, no formato YYYY-MM-DDTHH:MM:ss.SSSZ (necessário passar o timezone).

dataEmissaoInicial

string <date-time>

requerido

Data de emissão inicial, no formato YYYY-MM-DDTHH:MM:ss.SSSZ (necessário passar o timezone).

Exemplo:

2022-09-27T00:00:00.000-0300

Parâmetros Header

string

opcional

Tipo de conteúdo aceito.

Exemplo:

*/*

Content-Type

string

opcional

Tipo de mídia do corpo da solicitação.

Exemplo:

application/json

Authorization

string

opcional

Header HTTP utilizado para autenticação do cliente. O valor deve ser um token JWT válido precedido do prefixo Bearer

Exemplo:

Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwZDI1NmI2MS03Y2RhLTQ5MzItYjVmNS1hZGIxOGUyNzc3MDQifQ.eyJleHAiOjE3NDI1ODE3NTMsImlhdCI6MTc0MjU2Mzc1MywianRpIjoiMDljMmMwMWUtNmMyNS00NTg5LWIyODUtZGZlMzIxZjUzZDhlIiwiaXNzIjoiaHR0cDovL3ZwYy1saW5rLXNiLmFwcC5ycGUudGVjaC9yZWFsbXMvcnBlIiwic3ViIjoiNGY2YmM0ZTgtMTRjYi00YmU4LWI4M2MtOWNiMTNhM2NiOWQwIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoicnBlY2xpZW50Iiwic2Vzc2lvbl9zdGF0ZSI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsInNjb3BlIjoicHJvZmlsZSIsInNpZCI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsImlzc3VlcmlkIjoxLCJyb2xlcyI6WyJST0xFX1NJU1RFTUEiLCJST0xFX1BBQ09URV9TTVNfQ09OU1VMVEFfTElTVEEiLCJST0xFX0NPTlNVTFRBUl9QT1JUQURPUiIsIlJPTEVfQ0FSVE9FU19BRE1JTiIsIlJPTEVfdGVzdGUtcm9sZSIsIlJPTEVfUEFDT1RFX1NNU19DT05TVUxUQV9QQUNPVEVTX0RJU1BPTklWRUlTIiwiUk9MRV9QQUNPVEVfU01TX0FMVEVSQUNBT19SRUNFQkVfQk9OVVNfQ0VMVUxBUiIsIlJPTEVfdW1hX3Byb3RlY3Rpb24iLCJST0xFX1BBQ09URV9TTVNfQ0FEQVNUUk9fQ09OVFJBVEFDQU9fUEFDT1RFIiwiUk9MRV9QQUNPVEVfU01TX0NBREFTVFJPX0NFTFVMQVJfU01TIiwiUk9MRV9QQUNPVEVfU01TX0NPTlNVTFRBX1BBQ09URVNfQ09OVFJBVEFET1MiLCJST0xFX0FETUlOIiwiUk9MRV9QQUNPVEVfU01TX1JFTU9DQU9fUEFDT1RFIl0sInVzZXJuYW1lIjoicnBlLXNhbmRib3gifQ.DtxNXDEFD4R7hP8XusdDNqGNvI2_NtwR5tZAjbYYEb2SWSANiPx8kRLMzVcqkvCWf57PqEAIEO6uQN9mbcYBwQ

Respostas

🟢200OK

application/json

Retorna sempre uma lista, podendo vir preenchido ou não, de acordo com o filtro usado. Os metadados da paginação ficam no header do response.

Body

array of:

string

opcional

Identificador da transação PIX.

banco

string

opcional

Nome do banco que recebe a transação.

status

string

opcional

Status da transação PIX.

pagamentoNotificado

boolean

opcional

Indica se o pagamento foi notificado.

dataEmissao

string

opcional

Data em que o código Pix foi emItido.

dataVencimento

string

opcional

Data de vencimento do código Pix.

emv

string

opcional

Texto que representa o código Pix.

base64

string

opcional

Código do Pix em base64.

dataPagamento

string

opcional

Data de pagamento do PIX.

recebimento

object

opcional

Informações sobre o recebimento.

string

opcional

Identificador do recebimento.

data

string

opcional

Data do recebimento.

endToEndId

string

opcional

Identificador end-to-end do pagamento.

valor

number

opcional

Valor recebido.

pagamentoNotificado

boolean

opcional

Indica se o pagamento é notificado.

infoPagador

string

opcional

Informações do pagador.

valor

number

opcional

Valor da transação Pix.

idPortador

integer

opcional

Identificador do portador.

txid

string

opcional

TXID do Pix.

🟠400Pedido inválido

🟠401Não autorizado

🟠403Proibido

🟠404Registro não encontrado

🔴500Erro do servidor