Listar transferências

Use este endpoint para consultar transferências num período específico, através de seus identificadores, status, ou outras informações.

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

{ "totalItems": 207, "previousPage": 1, "last": false, "nextPage": 2, "maxItemsPerPage": 20, "totalItemsPage": 20, "totalPages": 11, "currentPage": 1, "items": [ { "idAccount": 12, "amount": 0.01, "tariffAmount": 0, "transactionStatus": "EXECUTED", "transactionCode": "6e5d8275-94e3-4710-8ac8-85f0650141a0", "transactionDate": "2023-03-29T15:19:52.754Z", "idTx": "DOCK202001030000000000001", "transactionType": "TRANSFER_CREDIT", "pixType": "TRANSFER", "idEndToEnd": "000000001320230329T1219469887051", "idAdjustment": 1283, "finalAmount": 0.01, "name": "Mascarado", "transferType": 2 }, { "idAccount": 13, "amount": 0.01, "tariffAmount": 0, "transactionStatus": "EXECUTED", "transactionCode": "52fff216-bd5f-4e14-af9e-8edb751a98b4", "transactionDate": "2023-03-29T15:19:50.283Z", "idTx": "DOCK202001030000000000001", "transactionType": "TRANSFER_DEBIT", "pixType": "TRANSFER", "idEndToEnd": "000000001320230329T1219469887051", "idAdjustment": 1282, "finalAmount": 0.01, "name": "Mascarado", "transferType": 2 }, { "idAccount": 12, "amount": 0.01, "tariffAmount": 0, "transactionStatus": "EXECUTED", "transactionCode": "7041945f-f68a-4563-a6d3-6fd1480d19af", "transactionDate": "2023-03-29T15:14:54.615Z", "idTx": "DOCK202001030000000000001", "transactionType": "TRANSFER_CREDIT", "pixType": "TRANSFER", "idEndToEnd": "000000001320230329T1214484273185", "idAdjustment": 1281, "finalAmount": 0.01, "name": "Mascarado", "transferType": 2 } ] }

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

data

string <date>

opcional

Resultados para transferências ocorridas numa data específica, no formato YYYY-MM-DD.

Exemplo:

2025-02-29

from

string <date>

opcional

Data inicial da pesquisa, no formato YYYY-MM-DD.

Exemplo:

20205-03-01

string <date>

opcional

Data final da pesquisa, no formato YYYY-MM-DD.

Exemplo:

20205-03-04

page

integer <int32>

opcional

Número da página de pesquisa.

Padrão:

Exemplo:

sort

enum<string>

opcional

Ordenação do resultado da pesquisa.

Valores permitidos:

ASCDESC

Padrão:

DESC

limit

integer <int32>

opcional

Quantidade máxima de resultados por página.

<= 100

Padrão:

Exemplo:

idAccount

string

opcional

Identificador da conta.

Exemplo:

2001

idEndToEnd

string

opcional

Identificador da transferência em questão.

<= 3 Caracteres

Exemplo:

345

idTx

string

opcional

Identificador para conciliação bancária.

<= 35 Caracteres

Exemplo:

DOCK202001030000000000003

transactionType

enum<string>

opcional

Tipo da transação.

TRANSFER_DEBIT = transferência de débito

TRANSFER_CREDIT = transferência de crédito

Valores permitidos:

TRANSFER_DEBITTRANSFER_CREDIT

Exemplo:

TRANSFER_DEBIT

transactionUUID

string

opcional

UUID da transação.

Exemplo:

123e4567-e89b-12d3-a456-426655440000

transferType

enum<string>

opcional

Tipo da transferência.

MANUAL = manual

KEY= chave

STATIC_CODE = QR code estático

DYNAMIC_QR_CODE = QR code dinâmico

Valores permitidos:

MANUALKEYSTATIC_CODEDYNAMIC_QR_CODE

Exemplo:

MANUAL

transactionCode

string

opcional

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

<= 36 Caracteres

Exemplo:

ff19bC93-01f4-4550-93f1-d1d42f8146ce

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 <int32>

opcional

Número total de itens.

Exemplo:

207

integer <int32>

opcional

Página anterior.

Exemplo:

last

boolean

opcional

Indica se é a última página.

Padrão:

false

integer <int32>

opcional

Próxima página.

Exemplo:

maxItemsPerPage

integer <int32>

opcional

Quantidade máxima de itens por página.

Padrão:

Exemplo:

totalItemsPage

integer <int32>

opcional

Total de itens por página.

Exemplo:

currentPage

integer <int32>

opcional

Página atual.

Exemplo:

items

array [object {8}]

opcional

Informações sobre os itens da pesquisa.

key

string

opcional

Chave usada na transferência.

Exemplo:

teste@teste.com

keyType

enum<string>

opcional

Tipo da chave.

Valores permitidos:

nationalRegistrationphoneNumberemailevp

Exemplo:

evp

dateKeyCreated

string <date-time>

opcional

Data de criação da chave.

Exemplo:

2022-12-14T12:05:39.502Z

dateKeyOwnership

string <date-time>

opcional

Data de associação da chave à uma conta.

Exemplo:

2022-12-14T12:05:39.502Z

description

string

opcional

Descrição da chave.

Exemplo:

keyStatus

enum<string>

opcional

Status da chave.

OPEN = aberto

WAITING_RESOLUTION = aguardando reinvidicação

Valores permitidos:

OPENWAITING_RESOLUTION

Exemplo:

OPEN

keyAccount

object

opcional

Informações sobre a conta associada à chave.

claim

object

opcional

Informações da solicitação.

totalPages

integer

opcional

Número total de páginas.

Exemplo:

🟠400Pedido inválido

🟠401Não autorizado

🟠403Proibido

🟠404Registro não encontrado

🔴500Erro do servidor