Ativação do cartão

Após o recebimento do cartão, o cliente deverá realizar sua ativação.

Este endpoint possibilita que o cliente do parceiro Hiperbanco ative seu cartão pela primeira vez.

Pré-requisito

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

O cliente do parceiro Hiperbanco possua um cartão que precise ser ativado, cujo status seja diferente de "Building".

Requisição (Request)

Requisição HTTP

PATCH https://sandbox.hiperbanco.com.br/Cards/active?proxy={proxy}

--request PATCH 'https://sandbox.hiperbanco.com.br/Cards/active?proxy={proxy}' \
--header 'version: cutting-edge' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{token}}' \
--data-raw '{
  "password": "string",
  "activateCode": "string"
}'

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	Especificação
`proxy`	`query`	Código identificador do cartão.	Insira somente números, sem caracteres especiais.

Corpo da requisição (Body)

No body, envie os seguintes campos em formato JSON:

Nome	Tipo	Descrição	Especificação
`activateCode`	`string`	Código de ativação do cartão.	Máximo de 12 caracteres.
`password`	`string`	Senha de uso do cartão.	A senha deve possuir 4 dígitos.

❗️
Atenção
Para maior segurança, recomendamos que o cliente do parceiro não utilize a senha atual e nem uma data de aniversário. A senha não deve conter números sequenciais (Ex. 1234 ou 8765) ou repetidos (Ex. 1111)

{
     "activateCode": "string",
     "password": "8475"
}

Resposta (Response)

O status code 200 indicará que a solicitação foi aceita e que a ativação foi realizada.

Erros

Status Code	Código	Mensagem	Descrição
`400`	`CARD_NOT_HAVE_BIND`	Card Not have bind!	O cartão informado não tem vínculo com nenhum outro cartão. Ocorre ao tentar ativar um cartão virtual, porque ele já nasce ativo.
`400`	`VIRTUAL_CARD_BINDING_ERROR`	Virtual card with problem in your bond!	Ocorre ao tentar ativar um cartão físico vinculado a um virtual. Para cartões panless o proxy do cartão virtual deverá ser enviado.
`400`	`UNDEFINED_SERVER_ERROR`	One or more undefined errors happened!	Ocorreu um ou mais erros indefinidos.
`404`	`CARD_NOT_FOUND`	Card not found!	O cartão informado não foi encontrado.
`406`	`INVALID_STATUS_FOR_METHOD`	Current status does not allow changes by this method!	O status atual não pode ser alterado por este método.
`406`	`DOCUMENT_NOT_FOUND_IN_COMPANY`	The document could not found in company!	Documento do cliente não foi identificado ou o mesmo está indisponível.
`500`	`CARD_EVENT_SAVE_ERROR`	Error has save events card!	Ocorrência de erro ao tentar armazenar os dados do cartão.

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.