Listagem de cartões

Este endpoint permite listar todos os cartões emitidos e as solicitações de emissão de cartão feitas pelos clientes.

Pré Requisitos

Para utilizar este endpoint, é necessário que o usuário possua uma conta de acesso ao backoffice, fornecida previamente pelo time de integrações.

Requisição (Request)

Requisição HTTP

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

--request GET 'https://sandbox.hiperbanco.com.br/dashboard/cards' \
--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)

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 - É possível pesquisar pelo `accountNumber`
`orderColumn`	`query`	Coluna para ordenação - Valores possíveis: `createdAt`, `status`
`orderDirection`	`query`	Sentido da ordenação, pode ser `ASC` (ascendente) ou `DESC` (descendente). Funciona apenas se orderColumn tiver sido especificado
`type`	`query`	Tipo do cartão, podendo ser `Virtual`(Cartão Virtual) ou `Physical`(Cartão Físico)

Corpo da requisição (Body)

Não é necessário enviar parâmetros 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 da requisição.

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

Campo	Tipo	Descrição
`data[]`	`array`	Lista de cartões retornados.
`data[].id`	`string`	Identificador único do cartão.
`data[].cardType`	`string`	Tipo do cartão (ex: Physical, Virtual).
`data[].lastFourDigits`	`string`	Últimos quatro dígitos do cartão.
`data[].status`	`string`	Status atual do cartão.
`data[].createdAt`	`string`	Data de criação do cartão.
`data[].accounts`	`object`	Objeto com informações da conta vinculada.
`data[].accounts.number`	`string`	Número da conta associada.
`data[].accounts.onboarding`	`object`	Objeto com informações do titular da conta.
`data[].accounts.onboarding.socialName`	`string`	Nome do titular da conta.
`total`	`number`	Total de registros retornados.
`totalPages`	`number`	Total de páginas de resultados.

{
   "data": [
      {
         "id": "8a704dd3-5b36-46c1-830a-0d32e287112c",
         "cardType": "Physical",
         "lastFourDigits": "8915",
         "status": "Novo",
         "createdAt": "2024-05-23T09:43:26.864Z",
         "accounts": {
            "number": "1101958127",
            "onboarding": {
               "socialName": "Fernando Pereira"
            }
         }
      }
   ],
   "total": 1,
   "totalPages": 1
}

Possíveis status do cartão

Status	Descrição
`Ativo`	Cartão está ativo e pronto para uso.
`Bloqueado`	Cartão está temporariamente indisponível por motivo de segurança ou uso.
`Cancelado`	Cartão foi encerrado e não pode mais ser utilizado.
`Processando`	Cartão está em fase de emissão ou movimentação.
`Devolvido`	Cartão foi devolvido ao emissor ou à instituição.
`Disponível`	Cartão está disponível, mas ainda não foi ativado.
`Inativo`	Cartão está desativado e não pode ser utilizado.
`Aguardando`	Cartão está aguardando alguma ação ou confirmação.
`Pendente`	Cartão está com pendência, como pagamento ou verificação.
`Negado`	Solicitação de cartão foi recusada.
`Novo`	Cartão recém-criado, ainda não ativado.
`Deletado`	Cartão foi excluído do sistema.
`Rejeitado`	Cartão ou solicitação foi rejeitada por algum motivo.
`Não Identificado`	Status do cartão não pôde ser determinado.
`Erro`	Ocorreu uma falha no processamento do cartão.

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.