Listagem de todas as transações

Esse endpoint serve para listar todas as transações criadas no banco

Pré-requisitos

Para que seja possível utilizar este endpoint, é necessario que:

O usuário esteja utilizando a Autenticação Gestão do Banco

Requisição (Request)

Requisição HTTP

GET https://sandbox.hiperbanco.com.br/dashboard/transactions

--request GET 'https://sandbox.hiperbanco.com.br/dashboard/transactions' \
--header 'version: cutting-edge' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{token}}'

Cabeçalhos (Headers)

Nome	Propriedade	Descrição
`version`	`cutting-edge`	Essa propriedade garante que o response da API seja retornado no formato JSON
`Authorization`	`Bearer token`	Obrigatório. Token de autorização do tipo Bearer.

Parâmetros da rota (Path / Query)

É possível enviar os seguintes Query Params nesta requisição:

Nome	Tipo	Descrição
`startDate`	`query`	Data inicial da busca. ISO Date Format (YYYY-MM-DD).
`endDate`	`query`	Data final da busca. ISO Date Format (YYYY-MM-DD).
`page`	`query`	Página do resultado da busca
`perPage`	`query`	Itens por página
`search`	`query`	Query de pesquisa - É possivel pesquisar pelo número da conta.
`orderColumn`	`query`	Coluna para ordenação - Valores possíveis: `createdAt` .
`orderDirection`	`query`	Sentido da ordenação, pode ser `ASC` (ascendente) ou `DESC` (descendente). Funciona apenas se orderColumn tiver sido especificado
`direction`	`query`	Direção do fluxo do dinheiro - Valores possiveis: `IN`. quando for cash-in e `OUT`, quando for cash-out
`transactionTypeCode`	`query`	Tipo da transação: `pix`, `ted`, `p2p`, `payment`, `slc`.
`status`	`query`	Buscar por possíveis status das transações

Corpo da requisição (Body)

Não é necessário enviar parâmetros no body desta requisição.

Possíveis status das transações

Status Gerais

Valor	Descrição
`CREATED`	Criado
`DONE`	Concluído
`UNDONE`	Desfeito
`PENDING`	Pendente
`CANCELED`	Cancelado
`RETURN`	Devolução
`REFUND`	Reembolso

Pix / Ted

Valor	Descrição
`IN_PROCESS`	Em processamento
`APPROVED`	Aprovado
`REPROVED`	Reprovado

Card

Valor	Descrição
`TRANSACTION_HOLD_WAS_REPROVED`	Reserva da transação foi reprovada
`TRANSACTION_HOLD_WAS_APPROVED`	Reserva da transação foi aprovada
`TRANSACTION_WAS_REVERSED`	Transação foi revertida
`TRANSACTION_HOLD_WAS_EXPIRED`	Reserva da transação expirou
`TRANSACTION_WAS_CONFIRMED`	Transação foi confirmada
`TRANSACTION_WAS_REVERSED_IN_SECOND_INSTANCE`	Transação foi revertida em segunda instância
`TRANSACTION_VOUCHER_WAS_CREATED`	Voucher da transação foi criado

Payments

Valor	Descrição
`CONFIRMED`	Confirmado
`COMPLETED`	Completo
`RECEIVED`	Recebido
`FAILED`	Falhou
`REFUSED`	Recusado

Resposta (Response)

O status code 200 indicará que a requisição foi feita com sucesso e trará um objeto contendo as informações das transaçõess.

Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:

Campo	Tipo	Descrição
`data`	`array`	Lista de transações.
`data[].id`	`string`	Identificador da transação.
`data[].description`	`string`	Descrição da transação.
`data[].transactionNotes`	`string`	Observações da transação.
`data[].amount`	`number`	Valor da transação.
`data[].initializationType`	`string`	Tipo de inicialização da transação.
`data[].authenticationCode`	`string`	Código de autenticação.
`data[].recipientAccount`	`string`	Conta do destinatário.
`data[].recipientDocumentNumber`	`string`	Documento do destinatário.
`data[].recepientName`	`string`	Nome do destinatário.
`data[].recepientBankName`	`string`	Nome do banco do destinatário.
`data[].recipientBankIspb`	`string`	ISPB do banco do destinatário.
`data[].senderDocumentNumber`	`string`	Documento do remetente.
`data[].senderName`	`string`	Nome do remetente.
`data[].senderAccountNumber`	`string`	Conta do remetente.
`data[].senderBankIspb`	`string`	ISPB do banco do remetente.
`data[].senderBankName`	`string`	Nome do banco do remetente.
`data[].status`	`string`	Status da transação.
`data[].balanceAfterThisTransaction`	`number`	Saldo após a transação.
`data[].entryModeCode`	`string`	Modo de entrada da transação.
`data[].createdAt`	`string`	Data e hora de criação.
`data[].isPixOpenBanking`	`boolean`	Indica se a transação é Pix via Open Banking.
`data[].account`	`object`	Dados da conta vinculada.
`data[].account.number`	`string`	Número da conta.
`data[].account.onboarding`	`object`	Informações de onboarding do titular.
`data[].account.onboarding.registerName`	`string`	Nome de registro do titular.
`data[].account.onboarding.socialName`	`string`	Nome social do titular.
`data[].account.onboarding.type_account`	`string`	Tipo da conta (PF/PJ).
`data[].transactionType`	`object`	Tipo de transação.
`data[].transactionType.description`	`string`	Descrição do tipo de transação (ex: PIX).
`data[].direction`	`string`	Direção da transação (Crédito/Débito).
`total`	`number`	Quantidade total de registros.
`totalPages`	`number`	Quantidade total de páginas.

{
    "data": [
        {
            "id": "0800baa8-1a87-4987-89a6-f7033169fc64",
            "description": "Teste Devolucao Pagamento",
            "transactionNotes": "Teste Devolucao Pagamento",
            "amount": 0.01,
            "initializationType": null,
            "authenticationCode": "a5d59445-eb7f-4104-b659-411cbb7d3fd2",
            "recipientAccount": "1104714229",
            "recipientDocumentNumber": "73379344915",
            "recepientName": "",
            "recepientBankName": null,
            "recipientBankIspb": "13140088",
            "senderDocumentNumber": "73379344915",
            "senderName": "Sheldon Wunsch",
            "senderAccountNumber": "1104714229",
            "senderBankIspb": null,
            "senderBankName": null,
            "status": "RETURN",
            "balanceAfterThisTransaction": 2206740.4,
            "entryModeCode": null,
            "createdAt": "18/11/2025 14:14",
            "isPixOpenBanking": false,
            "account": {
                "number": "1104714229",
                "onboarding": {
                    "registerName": "Marcos Vinicius Galvão",
                    "socialName": "Marcos Vinicius Galvão",
                    "type_account": "PF"
                }
            },
            "transactionType": {
                "description": "PIX"
            },
            "direction": "Crédito"
        },
        {
            "id": "00017070-3502-4dbf-a39c-814cc3ad8ba9",
            "description": "Testando Pix - Transferencia Key",
            "transactionNotes": null,
            "amount": 35.18,
            "initializationType": "Chave Pix",
            "authenticationCode": "12ff333e-98b7-43c8-8baa-b3bcefea386f",
            "recipientAccount": "1101263307",
            "recipientDocumentNumber": "60216418000162",
            "recepientName": "Icaro Pescarias SA",
            "recepientBankName": null,
            "recipientBankIspb": null,
            "senderDocumentNumber": "85915005551",
            "senderName": "Marcos Vinicius de Jesus Galvão",
            "senderAccountNumber": "1101958127",
            "senderBankIspb": null,
            "senderBankName": "HiperBanco",
            "status": "RETURN",
            "balanceAfterThisTransaction": 217790.98,
            "entryModeCode": null,
            "createdAt": "18/11/2025 14:14",
            "isPixOpenBanking": false,
            "account": {
                "number": "1101958127",
                "onboarding": {
                    "registerName": "Fernando Carlos Pereira Santos",
                    "socialName": "Fernando Pereira",
                    "type_account": "PF"
                }
            },
            "transactionType": {
                "description": "PIX"
            },
            "direction": "Débito"
        }
    ],
    "total": 2,
    "totalPages": 1
}

Erros

Este endpoint não retorna erros específicos. Porém, ele poderá retornar alguns erros comuns entre todos os endpoints.

Eventos

Este endpoint não possui eventos relacionados a ele.