Alterar senha do cartão

Este endpoint oferece ao cliente do parceiro Hiperbanco a possibilidade de alterar a senha do seu cartão com segurança, por meio de comunicação criptografada.

Pré-requisitos

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

O cliente do parceiro Hiperbanco possua um cartão ativo/bloqueado.
O parceiro esteja autenticado

Requisição (Request)

Requisição HTTP

PATCH https://sandbox.hiperbanco.com.br/Cards/password/{proxy}

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

❗️
Atenção

A senha deve possuir quatro dígitos e ser transmitida criptografada em formato base64. Exemplo: "TiCEhKL8h7y88y1zhfxs2gnivGlB2Fx/pTlXpv0QtP675..."

Para maior segurança, instrua seu cliente a não utilizar a senha atual, datas de aniversário nem números sequenciais (Ex. 1234 ou 8765) ou repetidos (Ex. 1111).

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.

Erros

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

Status Code	Código	Mensagem	Descrição
`403`	`PROVIDER_ERROR`	The provider returned an unexpected response. Please try again later	Ocorreu um erro inesperado no Banco Liquidante
`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.
`409`	`CARD_CREATION_IN_PROGRESS`	The card is in the process of being created.	O processo de criação do cartão não foi finalizado.

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.