Alteração do status do cartão

Este endpoint possibilita que o cliente do parceiro Hiperbanco altere o status do seu cartão. O parceiro também poderá solicitar a mudança do status do cartão de seus clientes se necessário, como no caso de fraude ou inadimplência.

O cartão poderá ser alterado para um status temporário ou definitivo.

⚠️
Importante
É possível cancelar um cartão por meio da alteração do seu status.

Pré-requisito

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

O cliente do parceiro Hiperbanco tenha um cartão e que o seu status seja diferente de "Building"

Requisição (Request)

Requisição HTTP

POST https://sandbox.hiperbanco.com.br/Cards/status/{proxy}

--request POST 'https://sandbox.hiperbanco.com.br/Cards/status/{proxy}' \
--header 'version: cutting-edge' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{token}}' \
--data-raw '{
  "status": "CanceledByCustomer",
  "password": "string",
  "updateCardBinded": true
}'

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
`proxy`	`path`	Obrigatório. 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 / Exemplo
`status`	`string`	Obrigatório. Status que o cartão passará a ter. Confira a tabela com os possíveis status reversíveis e irreversíveis na página Possíveis status do cartão.	Informe os status contidos na tabela "Status alterados pelo parceiro".
`password`	`string`	Senha de uso do cartão. Importante: este campo somente é obrigatório caso seja informado o status "CanceledByEmitter" ou "DeathCanceled".	A senha deve possuir 04 dígitos.
`updateCardBinded`	`boolean`	Indica se o cartão vinculado deverá ser atualizado.	—

📘
Nota
Os seguintes status podem ser alterados sem a necessidade de informar a senha: "Active", "TemporarilyUserLocked", "CanceledByCustomer", "LostOrTheftCanceled", "CardDamagedCanceled", "CardBrokenCanceled", "CardWithDefectCanceled" e "RobbedCanceled".

{
     "status": "TemporarilyUserLocked",
     "password": "8457",
     "updateCardBinded": false
}

Resposta (Response)

O status code 200 indicará que a solicitação foi aceita e que o status do cartão foi alterado com sucesso.

Erros

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

Status Code	Código	Mensagem	Descrição
400	`BIND_PROXY_CARD_NOT_FOUND`	BindProxy, Card Not Found!	O proxy informado possui vínculo com outros cartões. Neste caso, um ou mais cartões atrelados não foram encontrados.
403	`USER_PROFILE_CANNOT_CHANGE_STATUS`	The current status does not allow changes by this user profile!	O status atual não permite alterações para o perfil de usuário usado na requisição.
404	`CARD_NOT_FOUND`	Card not found!	O cartão informado não foi encontrado.
406	`STATUS_CHANGE_NOT_ALLOWED`	The current status does not allow a change to the chosen status!	O status atual do cartão não pode transacionar para o status informado.
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	`CARD_ALREADY_IN_STATUS`	Card is already in the status!	O cartão já encontra-se no status de destino informado.
409	`CARD_CANCELED`	The card has already been permanently cancelled!	O cartão informado já se encontra cancelado permanentemente!

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

Eventos

Caso o parceiro deseje receber mensagens referentes aos eventos relacionados a esse endpoint, é preciso configurar o webhook. Os eventos são:

Nome do evento	Descrição
`CARD_STATUS_WAS_MODIFIED`	O status do cartão foi alterado.