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)
| Nome | Propriedade | Descrição |
|---|---|---|
version | cutting-edge | Obrigatório. 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)
No path desta requisição envie os seguintes campos:
| Nome | Tipo | Descrição |
|---|---|---|
accountBranch | path | Obrigatorio. Numero da agencia |
accountNumber | path | Obrigatorio. Numero da conta |
page | query | Obrigatorio. Página do resultado da busca |
itemsPerPage | query | Obrigatorio. 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:
| Campo | Tipo | Descrição |
|---|---|---|
day | string | Data do dia das transações. |
transactions | array | Lista de transações do dia. |
transactions.id | string | Identificador único da transação. |
transactions.authenticationCode | string | Código de autenticação, se houver. |
transactions.time | string | Horário da transação. |
transactions.amount | number | Valor da transação. |
transactions.status | string | Status da transação. |
transactions.description | string | Descrição da transação. |
transactions.balanceAfterThisTransaction | number | Saldo após a transação. |
transactions.transactionType | object | Objeto com informações do tipo da transação. |
transactions.transactionType.description | string | Descrição do tipo de transação. |
transactions.transactionType.code | string | Código do tipo de transação. |
transactions.card | object | Objeto com informações do cartão. |
transactions.card.id | string | Identificador do cartão. |
transactions.card.cardName | string | Nome do cartão. |
transactions.card.alias | string | Apelido do cartão. |
transactions.card.cardType | string | Tipo do cartão (ex: Virtual). |
transactions.card.trackingCode | string | Código de rastreio, se houver. |
transactions.card.proxy | string | Proxy do cartão. |
transactions.card.activateCode | string | Código de ativação do cartão. |
transactions.card.lastFourDigits | string | Últimos quatro dígitos do cartão. |
transactions.card.status | string | Status atual do cartão. |
transactions.card.allowContactless | string | Indica se o cartão permite pagamento por aproximação. |
transactions.card.isActivated | boolean | Indica se o cartão está ativado. |
transactions.card.isLocked | boolean | Indica se o cartão está bloqueado. |
transactions.card.isCanceled | boolean | Indica se o cartão foi cancelado. |
transactions.card.isBuilding | boolean | Indica se o cartão está em processo de criação. |
transactions.card.isFirtual | boolean | Indica se o cartão é virtual (possível erro de digitação no campo). |
transactions.card.isPre | boolean | Indica se o cartão é pré-pago. |
transactions.card.isPos | boolean | Indica se o cartão é pós-pago. |
transactions.card.isDebit | boolean | Indica se o cartão é de débito. |
transactions.card.paymentDay | number | Dia de pagamento. |
transactions.card.createdAt | string | Data de criação do cartão. |
transactions.card.updatedAt | string | Data de atualização do cartão. |
transactions.card.deletedAt | string | Data de exclusão do cartão, se houver. |
transactions.card.batchId | string | Identificador do lote, se houver. |
transactions.card.category | string | Categoria do cartão. |
transactions.card.blockedByEscrowActivation | boolean | Indica se o cartão está bloqueado por ativação de escrow. |
transactions.entryModeCode | string | Modo de entrada da transação. |
endOfDayBalance | number | Saldo 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.
Updated 18 days ago