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 (Request)
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:
| Scope | Descrição |
|---|---|
card.update | Concede acesso para realizar atualizações no cartão. |
Cabeçalhos (Headers)
| Nome | Descrição |
|---|---|
api-version | Obrigatório. Versão da API. Atualmente estamos na versão 1.0. |
Authorization | 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. |
allowContactless | query | Obrigatório. Indica se é permitido pagamento por aproximação (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 Code | Código | Mensagem | Descrição |
|---|---|---|---|
| 404 | 002 | Card not found! | O cartão informado não foi encontrado. |
| 500 | 014 | 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. 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.
Updated 3 months ago