Dados de segurança do cartão

Este endpoint possibilita que o cliente do parceiro Hiperbanco consulte os dados de PCI (PAN, CVV e data de validade) do seu cartão.

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/data/{proxy}

--request GET 'https://sandbox.hiperbanco.com.br/Cards/data/{proxy}' \
--header 'version: cutting-edge' \
--header 'password: {password}' \
--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.
`password`	`string`	Obrigatório. Senha de uso do cartão.

Parâmetros da rota (Path)

Nome	Tipo	Descrição	Especificação
`proxy`	`path`	Código identificador do cartão.	Insira somente números, sem caracteres especiais.

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 e que a senha foi alterada com sucesso.

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

Nome	Tipo	Descrição	Número máximo de caracteres
`cardNumber`	`string`	Numeração do cartão.	`16`
`cvv`	`string`	Código de segurança do cartão.	`4`
`expirationDate`	`string`	Data de expiração do cartão, no formato `'MM/YY'`.	`—`

{
  "cardNumber": "000000000000000",
  "cvv": "000",
  "expirationDate": "05/09"
}

Erros

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

Status Code	Código	Mensagem	Descrição
`400`	`WRONG_PASSWORD_ATTEMPT_LOCKED`	Wrong Password Attempt Locked	Tentativa de senha errada bloqueada.
`403`	`SESSION_ACCOUNT_MISMATCH`	The requested action is only allowed if the current session belongs to the provided account's holder.	A ação solicitada só será permitida se a sessão atual pertencer ao titular da conta fornecida.
`404`	`CARD_NOT_FOUND`	Card Not Found	Cartão não encontrado.
`404`	`PROGRAM_NOT_FOUND`	Program not found	Programa não encontrado.
`406`	`INVALID_PASSWORD`	Invalid password	Senha inválida.
`409`	`CARD_CREATION_IN_PROGRESS`	The card is in the process of being created	Cartão em construção.
`503`	`CLIENT_BAD_REQUEST`	Bad Request client	Erro ao realizar requisição no parceiro.

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.