Listar transferências Pix

Use este endpoint para listar as transferências pix.

curl --location --request GET 'https://horizon-api-sb.app.rpe.tech/api/v1/banking/pix/transferencias/listar?date&from&to&page&sort&limit&idAccount&idEndToEnd&idTx&transactionCode&transactionType&transactionUUID&transferType&transactionStatus' \ --header 'Accept: */*' \ --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwZDI1NmI2MS03Y2RhLTQ5MzItYjVmNS1hZGIxOGUyNzc3MDQifQ.eyJleHAiOjE3NDI1ODE3NTMsImlhdCI6MTc0MjU2Mzc1MywianRpIjoiMDljMmMwMWUtNmMyNS00NTg5LWIyODUtZGZlMzIxZjUzZDhlIiwiaXNzIjoiaHR0cDovL3ZwYy1saW5rLXNiLmFwcC5ycGUudGVjaC9yZWFsbXMvcnBlIiwic3ViIjoiNGY2YmM0ZTgtMTRjYi00YmU4LWI4M2MtOWNiMTNhM2NiOWQwIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoicnBlY2xpZW50Iiwic2Vzc2lvbl9zdGF0ZSI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsInNjb3BlIjoicHJvZmlsZSIsInNpZCI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsImlzc3VlcmlkIjoxLCJyb2xlcyI6WyJST0xFX1NJU1RFTUEiLCJST0xFX1BBQ09URV9TTVNfQ09OU1VMVEFfTElTVEEiLCJST0xFX0NPTlNVTFRBUl9QT1JUQURPUiIsIlJPTEVfQ0FSVE9FU19BRE1JTiIsIlJPTEVfdGVzdGUtcm9sZSIsIlJPTEVfUEFDT1RFX1NNU19DT05TVUxUQV9QQUNPVEVTX0RJU1BPTklWRUlTIiwiUk9MRV9QQUNPVEVfU01TX0FMVEVSQUNBT19SRUNFQkVfQk9OVVNfQ0VMVUxBUiIsIlJPTEVfdW1hX3Byb3RlY3Rpb24iLCJST0xFX1BBQ09URV9TTVNfQ0FEQVNUUk9fQ09OVFJBVEFDQU9fUEFDT1RFIiwiUk9MRV9QQUNPVEVfU01TX0NBREFTVFJPX0NFTFVMQVJfU01TIiwiUk9MRV9QQUNPVEVfU01TX0NPTlNVTFRBX1BBQ09URVNfQ09OVFJBVEFET1MiLCJST0xFX0FETUlOIiwiUk9MRV9QQUNPVEVfU01TX1JFTU9DQU9fUEFDT1RFIl0sInVzZXJuYW1lIjoicnBlLXNhbmRib3gifQ.DtxNXDEFD4R7hP8XusdDNqGNvI2_NtwR5tZAjbYYEb2SWSANiPx8kRLMzVcqkvCWf57PqEAIEO6uQN9mbcYBwQ' \ --header 'Content-Type: application/json'

{ "totalItems": 207, "previousPage": 1, "last": false, "nextPage": 2, "maxItemsPerPage": 50, "totalItemsPage": 20, "totalPages": 11, "currentPage": 1, "items": [ { "idTransacao": 234, "idContaEmissor": 345, "idAccount": 12, "idEndToEnd": "000000001320230329T1219469887051", "transactionDate": "2023-03-29T15:19:52.754Z", "transactionType": "TRANSFER_DEBIT", "transactionStatus": "EXECUTED", "transferType": 0, "amount": 0.01, "tariffAmount": 0, "finalAmount": 0.01, "idAdjustment": 1283, "transactionCode": "6e5d8275-94e3-4710-8ac8-85f0650141a0", "tariffTransactionCode": "0", "idTx": "DOCK202001030000000000001", "pixType": "TRANSFER", "name": "Mascarado", "purchaseAmount": 20, "changeAmount": 0, "agentWithdrawalIspb": "3456", "agentMode": "AGPSS", "taxIdPaymentInitiator": 0 } ] }

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

date

string <date>

opcional

Data para pesquisa da transferência, no formato YYYY-MM-DD.

Exemplo:

2024-06-09

from

string <date-time>

opcional

Data de início da pesquisa das transferências.

Exemplo:

2025-01-01T08:07:27.874Z

string <date-time>

opcional

Data de fim da pesquisa das transferências.

Exemplo:

2024-12-01T08:07:27.874Z

page

integer <int32>

opcional

Páginas para pesquisa.

Padrão:

Exemplo:

sort

enum<string>

opcional

Ordenação da pesquisa.

Valores permitidos:

ASCDESC

Padrão:

DESC

Exemplo:

ASC

limit

integer <int32>

opcional

Limite da pesquisa.

<= 100

Padrão:

Exemplo:

idAccount

integer <int32>

opcional

Identificador da conta bancária.

>= 1<= 14

Exemplo:

2001

idEndToEnd

string

opcional

Identificador end-to-end.

<= 3 Caracteres

Exemplo:

123

idTx

string

opcional

Identificador do recipiente.

>= 25 Caracteres<= 35 Caracteres

Exemplo:

ef02e3e027114aeeb76efa19a5f121d2

transactionCode

string

opcional

Código da transação.

<= 36 Caracteres

Exemplo:

ff19b593-01f4-4550-9af1-d1d42f8146cb

transactionType

enum<string>

opcional

Tipo da transação.

Valores permitidos:

TRANSFER_DEBITTRANSFER_CREDIT

Exemplo:

TRANSFER_DEBIT

transactionUUID

string

opcional

Identificador externo, dado de lançamento único.

Exemplo:

ff93824jf9834k9

transferType

enum<string>

opcional

Tipo da transferência.

Valores permitidos:

MANUALKEYSTATIC_CODEDYNAMIC_QR_CODE

Exemplo:

MANUAL

transactionStatus

enum<string>

opcional

Status da transferência.

Valores permitidos:

EXECUTEDNOT_EXECUTEDPENDINGREVERSAL_EXECUTED

Exemplo:

EXECUTED

Parâmetros Header

string

requerido

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

Body

totalItems

integer

opcional

Total de itens na pesquisa.

Exemplo:

207

integer

opcional

Página anterior.

Exemplo:

last

boolean

opcional

Identifica se é a última.

Exemplo:

false

integer

opcional

Próxima página.

Exemplo:

maxItemsPerPage

integer

opcional

Quantidade máxima de itens por página.

Padrão:

Exemplo:

totalItemsPage

integer

opcional

Total de itens por página.

Exemplo:

totalPages

integer

opcional

Total de páginas.

Exemplo:

currentPage

integer

opcional

Página atual.

Exemplo:

items

array [object {22}]

opcional

Informações da pesquisa.

idTransacao

integer <int64>

opcional

Identificador da transação.

Exemplo:

234

idContaEmissor

integer <int32>

opcional

Identificador da conta do emissor.

Exemplo:

345

idAccount

integer

opcional

Identificador da conta.

>= 1<= 14

Exemplo:

idEndToEnd

string

opcional

Identificador end-to-end.

<= 32 Caracteres

Exemplo:

000000001320230329T1219469887051

transactionDate

string

opcional

Data da transação.

Exemplo:

2023-03-29T15:19:52.754Z

transactionType

enum<string>

opcional

Tipo da transação bancária.

Valores permitidos:

TRANSFER_DEBITTRANSFER_CREDIT

Exemplo:

TRANSFER_DEBIT

transactionStatus

enum<string>

opcional

Status da transação.

EXECUTED = Executada

NOT_EXECUTED = Não executada

PENDING = Pendente

REVERSAL_EXECUTED = Devolução

Valores permitidos:

EXECUTEDNOT_EXECUTEDPENDINGREVERSAL_EXECUTED

Exemplo:

EXECUTED

transferType

enum<integer>

opcional

Status da transação.

0 = Manual

1 = Chave pix

2 = QR Code estático

3 = QR Code dinâmico Dynamic QR Code

Valores permitidos:

0123

Exemplo:

amount

number <double>

opcional

Valor da transferência.

<= 10

Exemplo:

0.01

tariffAmount

number <double>

opcional

Valor das taxas.

<= 10

Exemplo:

finalAmount

number <double>

opcional

Valor final da transferência.

<= 10

Exemplo:

0.01

idAdjustment

integer

opcional

Identificador do ajuste.

>= 0

Exemplo:

1283

transactionCode

string

opcional

Código da transação. Gerado mesmo se o pagamento não for efetuado.

<= 36 Caracteres

Exemplo:

6e5d8275-94e3-4710-8ac8-85f0650141a0

tariffTransactionCode

string

opcional

Código de transação tarifária

Exemplo:

idTx

string

opcional

Identificador para conciliação do recebedor.

>= 25 Caracteres<= 35 Caracteres

Exemplo:

DOCK202001030000000000001

pixType

enum<string>

opcional

Tipo da transferência pix.

TRANSFER = Transferência

CHANGE = Troco

WITHDRAWAL = Resgate

Valores permitidos:

TRANSFERCHANGEWITHDRAWAL

Padrão:

TRANSFER

Exemplo:

TRANSFER

name

string

opcional

Se transactionType = TRANSFER_DEBIT o campo retorna o nome do beneficiário.

Se transactionType = TRANSFER_CREDIT, o campo retorna o nome do pagador.

<= 250 Caracteres

Exemplo:

Mascarado

purchaseAmount

number <double>

opcional

Valor de compra. Exclui descontos, taxas e juros.

Exemplo:

changeAmount

number <double>

opcional

Valor disponível para compra.

Exemplo:

agentWithdrawalIspb

string

opcional

Número do Identificador de Sistema de Pagamentos Brasileiro do agente de retirada.

Exemplo:

3456

agentMode

opcional

Tipo da agência de retirada.

AGPSS = facilitador de serviço de saque, também chamado de AGPSS

AGTEC = agente de saque estabelecimento comercial

AGTOT = caixas eletrônicos compartilhados ou correspondentes no país

Valores permitidos:

AGPSSAGTECAGTOT

Exemplo:

AGPSS

taxIdPaymentInitiator

number <double>

opcional

Identificador da taxa inicial de pagamento.

Exemplo:

🟠400Pedido inválido

🟠401Não autorizado

🟠403Proibido

🟠404Registro não encontrado

🔴500Erro do servidor