Configuração do contactless

stable pré pós

Este endpoint possibilita que o cliente do parceiro Bankly 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 Bankly possua um cartão físico ativo.

Requisição

Requisição HTTP

PATCH https://api-mtls.sandbox.bankly.com.br/cards/{proxy}/contactless
     --request PATCH \
     --url 'https://api-mtls.sandbox.bankly.com.br/cards/{proxy}/contactless?allowContactless=true' \
     --header 'Authorization: Bearer {{Token}}' \
     --header 'accept: application/json' \
     --header 'api-version: 1.0' \

Autorização

Para garantir a segurança nas requisições, todos os endpoints do Bankly utilizam scopes como parte do seu fluxo de autorização.
Esta requisição requer o scope descrito a seguir:

ScopeDescrição
card.updateConcede acesso para ativar ou desativar a função contactless do cartão.

Cabeçalhos (Headers)

NomeDescrição
api-versionObrigatório. Versão da API. Atualmente estamos na versão 1.0.
AuthorizationObrigatório. Token de autorização do tipo Bearer.

Parâmetros da rota (Path)

No path desta requisição envie os seguintes campos:

NomeTipoDescrição
proxypathObrigatório. Código identificador do cartão.
allowContactlessqueryObrigatório. Indica se a função contactless deverá ser ativada (TRUE) ou não (FALSE).

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 alteração foi realizada com sucesso.

👍

Dica

Para simular uma requisição nesse endpoint, acesse o API Reference.

Erros

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

Status CodeCódigoMensagemDescrição
404002Card not found!O cartão informado não foi encontrado.
500014Error 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. Portanto, recomendamos a consulta da documentação de erros, onde é possível encontrar as mensagens comuns em inglês que acompanham os erros 400 (se houver).

Eventos

Este endpoint não possui eventos relacionados a ele.