Por documento (CPF ou CNPJ)

Este endpoint possibilita que o cliente do parceiro Hiperbanco consulte os cartões vinculados ao seu número de documento (CPF ou CNPJ).

Pré-requisito

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

O cliente do parceiro Hiperbanco tenha um proxy de cartão emitido.

Requisição (Request)

Requisição HTTP

GET https://sandbox.hiperbanco.com.br/Cards/document

--request GET 'https://sandbox.hiperbanco.com.br/Cards/document' \
--header 'version: cutting-edge' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer

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)

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

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 solicitação foi aceita com sucesso e trará uma lista de cartões e suas informações.

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

Campo	Tipo	Descrição
`created`	`string`	Data e hora de criação do cartão.
`companyKey`	`string`	Identificador da empresa emissora.
`documentNumber`	`string`	Número do documento do titular.
`activateCode`	`string`	Código de ativação do cartão.
`trackingCode`	`string`	Código de rastreamento do cartão físico.
`holder`	`object`	Objeto com informações do titular do cartão.
`holder.name`	`string`	Nome completo do titular.
`holder.document`	`object`	Documento de identificação do titular.
`holder.document.value`	`string`	Número do documento.
`holder.document.type`	`string`	Tipo do documento (ex: CNPJ).
`bankAgency`	`string`	Número da agência bancária.
`bankAccount`	`string`	Número da conta bancária.
`bank`	`object`	Informações sobre o banco emissor.
`bank.ispb`	`string`	Código ISPB do banco.
`bank.code`	`string`	Código do banco.
`bank.name`	`string`	Nome completo do banco.
`lastFourDigits`	`string`	Últimos quatro dígitos do cartão (presente em cartões virtuais).
`proxy`	`string`	Código identificador do cartão (proxy).
`name`	`string`	Nome impresso no cartão.
`alias`	`string`	Nome de identificação do cartão.
`cardType`	`string`	Tipo do cartão (`Physical` ou `Virtual`).
`status`	`string`	Status atual do cartão.
`physicalBinds`	`array`	Lista de vínculos com cartões físicos.
`allowContactless`	`boolean`	Indica se o cartão permite pagamento por aproximação.
`address`	`object`	Objeto com informações de endereço.
`address.zipCode`	`string`	Código postal (CEP).
`address.address`	`string`	Logradouro.
`address.number`	`string`	Número do endereço.
`address.neighborhood`	`string`	Bairro.
`address.complement`	`string`	Complemento do endereço.
`address.city`	`string`	Cidade.
`address.state`	`string`	Estado.
`address.country`	`string`	País.
`historyStatus`	`array`	Lista de históricos de status do cartão.
`historyStatus.modified`	`string`	Data e hora da alteração de status.
`historyStatus.value`	`string`	Valor do status alterado.
`activatedAt`	`string`	Data e hora da ativação do cartão (presente em cartões ativos).
`lastUpdatedAt`	`string`	Data e hora da última atualização.
`isActivated`	`boolean`	Indica se o cartão está ativado.
`isAdditional`	`boolean`	Indica se o cartão é adicional.
`isLocked`	`boolean`	Indica se o cartão está bloqueado.
`isCanceled`	`boolean`	Indica se o cartão foi cancelado.
`isBuilding`	`boolean`	Indica se o cartão está em processo de criação.
`isFirtual`	`boolean`	Indica se o cartão é virtual (possível erro de digitação: “isVirtual”).
`isPre`	`boolean`	Indica se o cartão é pré-pago.
`isPos`	`boolean`	Indica se o cartão é pós-pago.
`isDebit`	`boolean`	Indica se o cartão é de débito.
`paymentDay`	`number`	Dia do vencimento do pagamento.
`functionalities`	`array`	Lista de funcionalidades do cartão.
`functionalities.type`	`string`	Tipo de funcionalidade (ex: Pre, Pos).
`functionalities.program`	`object`	Programa associado à funcionalidade.
`functionalities.program.programId`	`number`	Identificador do programa.
`functionalities.status`	`string`	Status da funcionalidade.
`wallets`	`array`	Lista de carteiras digitais vinculadas.
`expirationDate`	`string`	Data de expiração do cartão (presente em cartões virtuais).

[
  {
    "created": "2024-09-19T14:42:03.485+00:00",
    "companyKey": "SDB2_HIPERBANCO",
    "documentNumber": "60216418000162",
    "activateCode": "7653DFC4AAD2",
    "trackingCode": "10839KJAFSBM",
    "holder": {
      "name": "Pescarias SA",
      "document": {
        "value": "60216418000162",
        "type": "CNPJ"
      }
    },
    "bankAgency": "0001",
    "bankAccount": "1101263307",
    "bank": {
      "ispb": "13140088",
      "code": "332",
      "name": "ACESSO SOLUÇÕES DE PAGAMENTO S.A. - INSTITUIÇÃO DE PAGAMENTO"
    },
    "proxy": "5125911000000131809",
    "name": "Icaro P SA",
    "alias": "alias",
    "cardType": "Physical",
    "status": "Building",
    "physicalBinds": [],
    "allowContactless": true,
    "address": {
      "zipCode": "04547000",
      "address": "Avenida das Nações Unidas",
      "number": "12901",
      "neighborhood": "Brooklin Paulista",
      "complement": "Torre Norte, 10º andar",
      "city": "São Paulo",
      "state": "SP",
      "country": "BR"
    },
    "historyStatus": [
      {
        "modified": "2024-09-19T14:42:03.485+00:00",
        "value": "Building"
      }
    ],
    "lastUpdatedAt": "2024-09-19T14:42:14.851+00:00",
    "isActivated": false,
    "isAdditional": false,
    "isLocked": false,
    "isCanceled": false,
    "isBuilding": true,
    "isFirtual": false,
    "isPre": true,
    "isPos": false,
    "isDebit": false,
    "paymentDay": 1,
    "functionalities": [
      {
        "type": "Pre",
        "program": {
          "programId": 881
        },
        "status": "Enabled"
      }
    ],
    "wallets": []
  },
  {
    "created": "2025-04-30T13:11:29.568+00:00",
    "companyKey": "SDB2_HIPERBANCO",
    "documentNumber": "60216418000162",
    "activateCode": "AF1A6824F405",
    "trackingCode": "AF1A6824F405",
    "holder": {
      "name": "Pescarias SA",
      "document": {
        "value": "60216418000162",
        "type": "CNPJ"
      }
    },
    "bankAgency": "0001",
    "bankAccount": "1101263307",
    "bank": {
      "ispb": "13140088",
      "code": "332",
      "name": "ACESSO SOLUÇÕES DE PAGAMENTO S.A. - INSTITUIÇÃO DE PAGAMENTO"
    },
    "lastFourDigits": "3884",
    "proxy": "7912821000000948787",
    "name": "Testando CardS ",
    "alias": "testando",
    "cardType": "Virtual",
    "status": "Active",
    "physicalBinds": [],
    "allowContactless": true,
    "address": {
      "zipCode": "30140071",
      "address": "Rua dos Timbiras",
      "number": "1200",
      "neighborhood": "Funcionários",
      "complement": "Sala 305",
      "city": "Belo Horizonte",
      "state": "MG",
      "country": "BR"
    },
    "historyStatus": [
      {
        "modified": "2025-04-30T13:11:29.568+00:00",
        "value": "Building"
      },
      {
        "modified": "2025-04-30T13:11:39.162+00:00",
        "value": "Active"
      }
    ],
    "activatedAt": "2025-04-30T13:11:39.162+00:00",
    "lastUpdatedAt": "2025-04-30T13:11:39.162+00:00",
    "isActivated": true,
    "isAdditional": false,
    "isLocked": false,
    "isCanceled": false,
    "isBuilding": false,
    "isFirtual": false,
    "isPre": true,
    "isPos": false,
    "isDebit": false,
    "paymentDay": 1,
    "functionalities": [
      {
        "type": "Pre",
        "program": {
          "programId": 880
        },
        "status": "Enabled"
      }
    ],
    "wallets": [],
    "expirationDate": "2030-04-30T00:00:00"
  }
]

Erros

Este endpoint pode retornar erros específicos, conforme a tabela a seguir:

Status Code	Código	Mensagem	Descrição
`404`	`CARD_NOT_FOUND`	`Card Not Found`	Cartão não encontrado.

Recordamos que esta API também poderá retornar erros comuns entre todos os endpoints que acompanham os erros 400 (se houver).

Eventos

Este endpoint não possui eventos relacionados a ele.