Por conta

Este endpoint possibilita que o cliente do parceiro Hiperbanco consulte os cartões vinculados à sua conta.

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/account/{accountNumber}

--request GET 'https://sandbox.hiperbanco.com.br/Cards/account/{accountNumber}' \
--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	Especificação
`account`	`path`	Obrigatório. Número da conta do cliente.	—

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:

Nome	Tipo	Descrição
`created`	`string`	Data de criação do cartão, no formato ISO 8601 - UTC.
`companyKey`	`string`	Chave que identifica o parceiro dentro do Banco Liquidante.
`holder`	`object`	Objeto que contém informações sobre o titular do cartão.
`holder.name`	`string`	Nome do titular do cartão.
`holder.document`	`object`	Objeto que contém informações sobre o documento do titular do cartão.
`holder.document.value`	`string`	Número do documento do cliente (11 ou 14 dígitos).
`holder.document.type`	`string`	Tipo do documento do cliente (CPF ou CNPJ).
`documentNumber`	`string`	Obsoleto. Utilize o campo `holder.document.value`.
`activateCode`	`string`	Código de ativação do cartão.
`trackingCode`	`string`	Código de rastreio do cartão. Campo retornado apenas para cartões físicos.
`bankAgency`	`string`	Número da agência do cliente.
`bankAccount`	`string`	Número da conta do cliente.
`lastFourDigits`	`string`	Quatro últimos dígitos do cartão.
`proxy`	`string`	Código identificador do cartão.
`name`	`string`	Nome impresso no cartão.
`alias`	`string`	Apelido dado ao cartão.
`cardType`	`string`	Tipo do cartão, que pode ser "Physical" ou "Virtual".
`status`	`string`	Status do cartão. Confira a tabela com os possíveis status reversíveis e irreversíveis na página Possíveis status do cartão.
`physicalBinds[]`	`array of objects`	Lista de objetos contendo informações sobre os cartões físicos vinculados ao cartão virtual consultado. Retornado apenas se `cardType` for "Virtual".
`physicalBinds[].proxy`	`string`	Código identificador do cartão físico.
`physicalBinds[].created`	`string`	Data de criação do cartão físico, no formato ISO 8601 - UTC.
`virtualBind`	`object`	Objeto que contém informações sobre o cartão virtual vinculado ao cartão físico consultado. Retornado apenas se `cardType` for "Physical".
`virtualBind.proxy`	`string`	Código identificador do cartão virtual.
`virtualBind.created`	`string`	Data de criação do cartão virtual, no formato ISO 8601 - UTC.
`allowContactless`	`boolean`	Indica se é permitido pagamento por aproximação (`true` ou `false`).
`address`	`object`	Objeto que contém informações sobre o endereço do titular do cartão.
`address.zipCode`	`string`	Código postal do endereço.
`address.address`	`string`	Logradouro (nome da rua, avenida etc.).
`address.number`	`string`	Número do imóvel.
`address.neighborhood`	`string`	Nome do bairro.
`address.complement`	`string`	Complemento do endereço.
`address.city`	`string`	Nome da cidade.
`address.state`	`string`	Nome do estado.
`address.country`	`string`	Nome do país.
`historyStatus[]`	`array of objects`	Lista de objetos contendo o histórico de status do cartão desde sua criação.
`historyStatus[].modified`	`string`	Data em que o status foi aplicado, no formato ISO 8601 - UTC.
`historyStatus[].value`	`string`	Nome do status aplicado. Confira a tabela com os possíveis status reversíveis e irreversíveis.
`wallets[]`	`array of objects`	Lista de objetos contendo informações sobre as carteiras digitais às quais o cartão está vinculado. Retornado apenas se o cartão estiver em uma carteira digital.
`wallets[].status`	`string`	Status do cartão na carteira, que pode ser "Approved" ou "Denied".
`wallets[].walletType`	`string`	Identificador da carteira à qual o cartão está vinculado.
`wallets[].walletFlowAdd`	`string`	Classificação do fluxo que o cartão recebeu ao entrar na carteira: "Undefined", "GreenPatch" ou "YellowPatch".
`creditPos`	`object`	Objeto que contém informações sobre o limite de crédito do cartão pós-pago. Retornado apenas se o cartão for pós-pago.
`creditPos.contractNumber`	`string`	Número do contrato de crédito do cliente.
`creditPos.limit`	`number`	Limite de crédito do cliente.
`creditPos.limitActive`	`number`	Limite de crédito ativo do cliente.
`functionalities[]`	`array of objects`	Lista de objetos contendo informações sobre as modalidades do cartão.
`functionalities[].type`	`string`	Tipo de modalidade associada ao cartão, que pode ser “Debit", "Pos" ou "Pre".
`functionalities[].program`	`object`	Objeto que contém informações sobre o programa ao qual a modalidade está vinculada.
`functionalities[].program.id`	`number`	Identificador único do programa.
`functionalities[].program.bin`	`string`	O BIN (Bank Identification Number), utilizado para identificar a instituição bancária emissora.
`functionalities[].program.type`	`string`	Tipo do programa que define a modalidade do cartão.
`functionalities[].program.brand`	`string`	Bandeira do cartão.
`functionalities[].status`	`string`	Status da modalidade, que pode ser “Enabled", "Disabled", "Blocked" ou “BlockedByContract".
`activatedAt`	`string`	Data da ativação do cartão, no formato ISO 8601 - UTC.
`lastUpdatedAt`	`string`	Data da última atualização do cartão, no formato ISO 8601 - UTC.
`isActivated`	`boolean`	Indica se o cartão está ativo.
`isLocked`	`boolean`	Indica se o cartão está bloqueado.
`isCanceled`	`boolean`	Indica se o cartão está cancelado.
`isBuilding`	`boolean`	Indica se o cartão está em construção.
`isFirtual`	`boolean`	Indica se o cartão é Virtual.
`isPre`	`boolean`	Indica se o cartão é pré-pago.
`isPos`	`boolean`	Indica se o cartão é pós-pago.
`isCombo`	`boolean`	Indica se o cartão é combo.

{
   "created": "2020-07-20T22:53:12",
   "companyKey": "HIPERBANCO_SANDBOX",
   "holder": {
      "name": "Nísia Floresta da Silva",
      "document": {
         "value": "47742663023",
         "type": "CPF"
      }
   },
   "documentNumber": "47742663023",
   "activateCode": "A9991B2E491D",
   "trackingCode": "4717AEWATCTQ",
   "bankAgency": "0001",
   "bankAccount": "0001",
   "lastFourDigits": "4321",
   "proxy": "22999903520114195",
   "name": "Nísia Floresta",
   "alias": "Meu Cartão",
   "cardType": "Physical",
   "status": "InTransitLocked",
   "allowContactless": true,
   "address": {
      "zipCode": "05402100",
      "address": "Rua 6 de Março",
      "number": "2500",
      "neighborhood": "Alter do Chão",
      "complement": "",
      "city": "Santarém ",
      "state": "PA",
      "country": "Brasil"
   },
   "historyStatus": [
      {
         "modified": "2020-07-20T22:53:12",
         "value": "Building"
      },
      {
         "modified": "2020-07-20T22:55:12",
         "value": "InTransitLocked"
      }
   ],
   "functionalities": [
      {
         "type": "Pre",
         "program": {
            "id": 53,
            "bin": "234028",
            "type": "Pre",
            "brand": "Mastercard"
         },
         "status": "Enabled"
      }
   ],
   "activatedAt": null,
   "lastUpdatedAt": "2020-07-20T22:55:12",
   "isActivated": false,
   "isLocked": true,
   "isCanceled": false,
   "isBuilding": false,
   "isFirtual": false,
   "isPre": true,
   "isPos": false,
   "isCombo": false
}

{
   "created": "2020-07-20T22:53:12",
   "companyKey": "HIPERBANCO_SANDBOX",
   "holder": {
      "name": "Nísia Floresta da Silva",
      "document": {
         "value": "47742663023",
         "type": "CPF"
      }
   },
   "documentNumber": "47742663023",
   "activateCode": "A9991B2E491D",
   "bankAgency": "0001",
   "bankAccount": "0001",
   "lastFourDigits": "4321",
   "proxy": "22999903520114195",
   "name": "Nísia Floresta",
   "alias": "Meu Cartão",
   "cardType": "Virtual",
   "status": "Active",
   "allowContactless": false,
   "address": {
      "zipCode": "05402100",
      "address": "Rua 6 de Março",
      "number": "2500",
      "neighborhood": "Alter do Chão",
      "complement": "",
      "city": "Santarém ",
      "state": "PA",
      "country": "Brasil"
   },
   "historyStatus": [
      {
         "modified": "2020-07-20T22:53:12",
         "value": "WithoutMovementLocked"
      },
      {
         "modified": "2020-07-20T22:55:12",
         "value": "Active"
      }
   ],
   "functionalities": [
      {
         "type": "Pre",
         "program": {
            "id": 53,
            "bin": "234028",
            "type": "Pre",
            "brand": "Mastercard"
         },
         "status": "Enabled"
      }
   ],
   "activatedAt": null,
   "lastUpdatedAt": "2020-07-20T22:55:12",
   "isActivated": true,
   "isLocked": true,
   "isCanceled": false,
   "isBuilding": false,
   "isFirtual": false,
   "isPre": true,
   "isPos": false,
   "isCombo": false
}

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.