Consulta de transações por cartão

Este endpoint possibilita realizar a consulta das transações realizadas no cartão de acordo a conta que está autenticada.

Pré-requisito

Para que seja possível utilizar este endpoint, é necessário que:

  • O cliente do parceiro Hiperbanco possua um cartão emitido.

Requisição (Request)

Requisição HTTP

GET https://sandbox.hiperbanco.com.br/transactions/card/{accountBranch}/{accountNumber}?page=1&itemsPerPage=5
--request GET 'https://sandbox.hiperbanco.com.br/transactions/card/{accountBranch}/{accountNumber}?page=1&itemsPerPage=5' \
--header 'version: cutting-edge' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{token}}' 

Cabeçalhos (Headers)

NomePropriedadeDescrição
versioncutting-edgeObrigatório. Essa propriedade garante que o response da API seja retornado no formato JSON
AuthorizationBearer tokenObrigatório. Token de autorização do tipo Bearer.

Parâmetros da rota (Path)

No path desta requisição envie os seguintes campos:

NomeTipoDescrição
accountBranchpathObrigatorio. Numero da agencia
accountNumberpathObrigatorio. Numero da conta
pagequeryObrigatorio. Página do resultado da busca
itemsPerPagequeryObrigatorio. Quantidade de dias em cada página.

Corpo da requisição (Body)

Não é necessário enviar campos no body desta requisição.

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ções de cartão.

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

CampoTipoDescrição
daystringData do dia das transações.
transactionsarrayLista de transações do dia.
transactions.idstringIdentificador único da transação.
transactions.authenticationCodestringCódigo de autenticação, se houver.
transactions.timestringHorário da transação.
transactions.amountnumberValor da transação.
transactions.statusstringStatus da transação.
transactions.descriptionstringDescrição da transação.
transactions.balanceAfterThisTransactionnumberSaldo após a transação.
transactions.transactionTypeobjectObjeto com informações do tipo da transação.
transactions.transactionType.descriptionstringDescrição do tipo de transação.
transactions.transactionType.codestringCódigo do tipo de transação.
transactions.cardobjectObjeto com informações do cartão.
transactions.card.idstringIdentificador do cartão.
transactions.card.cardNamestringNome do cartão.
transactions.card.aliasstringApelido do cartão.
transactions.card.cardTypestringTipo do cartão (ex: Virtual).
transactions.card.trackingCodestringCódigo de rastreio, se houver.
transactions.card.proxystringProxy do cartão.
transactions.card.activateCodestringCódigo de ativação do cartão.
transactions.card.lastFourDigitsstringÚltimos quatro dígitos do cartão.
transactions.card.statusstringStatus atual do cartão.
transactions.card.allowContactlessstringIndica se o cartão permite pagamento por aproximação.
transactions.card.isActivatedbooleanIndica se o cartão está ativado.
transactions.card.isLockedbooleanIndica se o cartão está bloqueado.
transactions.card.isCanceledbooleanIndica se o cartão foi cancelado.
transactions.card.isBuildingbooleanIndica se o cartão está em processo de criação.
transactions.card.isFirtualbooleanIndica se o cartão é virtual (possível erro de digitação no campo).
transactions.card.isPrebooleanIndica se o cartão é pré-pago.
transactions.card.isPosbooleanIndica se o cartão é pós-pago.
transactions.card.isDebitbooleanIndica se o cartão é de débito.
transactions.card.paymentDaynumberDia de pagamento.
transactions.card.createdAtstringData de criação do cartão.
transactions.card.updatedAtstringData de atualização do cartão.
transactions.card.deletedAtstringData de exclusão do cartão, se houver.
transactions.card.batchIdstringIdentificador do lote, se houver.
transactions.card.categorystringCategoria do cartão.
transactions.card.blockedByEscrowActivationbooleanIndica se o cartão está bloqueado por ativação de escrow.
transactions.entryModeCodestringModo de entrada da transação.
endOfDayBalancenumberSaldo final do dia.
[
    {
        "day": "14/08/2025",
        "transactions": [
            {
                "id": "f10a8870-000e-4dc2-8394-1d351c90846a",
                "authenticationCode": null,
                "time": "10:50",
                "amount": -2,
                "status": "DONE",
                "description": "TESTE",
                "balanceAfterThisTransaction": 376855.78,
                "transactionType": {
                    "description": "Cartao",
                    "code": "cartao"
                },
                "card": {
                    "id": "ba22e3d7-228c-46be-9ff8-a142ece3764b",
                    "cardName": "Testando CardS ",
                    "alias": "testando",
                    "cardType": "Virtual",
                    "trackingCode": null,
                    "proxy": "7912821000000218690",
                    "activateCode": "F20BE435231A",
                    "lastFourDigits": "5571",
                    "status": "Active",
                    "allowContactless": "1",
                    "isActivated": true,
                    "isLocked": false,
                    "isCanceled": false,
                    "isBuilding": false,
                    "isFirtual": false,
                    "isPre": true,
                    "isPos": false,
                    "isDebit": false,
                    "paymentDay": 1,
                    "createdAt": "2025-07-10T17:54:17.264Z",
                    "updatedAt": "2025-08-21T15:43:52.000Z",
                    "deletedAt": null,
                    "batchId": null,
                    "category": "PREPAID_CREDIT",
                    "blockedByEscrowActivation": false
                },
                "entryModeCode": "E-commerce"
            }
        ],
        "endOfDayBalance": 376855.78
    }
]

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.