Configuração do contactless

Este endpoint possibilita que o cliente do parceiro Hiperbanco ative ou desative a função contactless do cartão.

Para cartões virtuais, caso o contactless fique desativado, não será possível realizar transações com o uso de carteiras digitais.

Pré-requisito

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

O cliente do parceiro Hiperbanco possua um cartão físico ativo.

Requisição (Request)

Requisição HTTP

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

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

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)

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)

No body, envie os seguintes campos em formato JSON:

Nome	Tipo	Descrição
`allowContactless`	`boolean`	Obrigatório. Indica se é permitido pagamento por aproximação (true) ou não (false).

Resposta (Response)

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

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!	O cartão informado não foi encontrado.
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.