Alteração de status de modalidade

Este endpoint permite realizar o bloqueio temporário de uma das modalidade do cartão do tipo combo (débito ou crédito) e também possibilita habilitar uma modalidade bloqueada.

Com isso, nosso parceiro pode oferecer a seu cliente a comodidade de habilitar a modalidade de crédito, por exemplo, para uso em uma compra específica. Do mesmo modo, o cliente poderá bloquear a modalidade quando desejar.

O bloqueio temporário poderá ser aplicado a uma modalidade por vez. Desse modo, o cartão permanecerá ativo e a modalidade que está habilitada poderá continuar sendo utilizada normalmente.

📘

Nota

Para realizar o bloqueio total cartão, utilize o endpoint de Alteração do status do cartão.

Pré-requisitos

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

• O cartão seja do tipo combo;
• O status da modalidade do cartão seja diferente de "Disabled" ou "BlockedByContract";
• O status atual da modalidade do cartão seja diferente daquele para o qual se deseja mudar. Exemplo: se uma modalidade já está ativa, não é possível requisitar que seu status passe para “Enabled”.

Requisição (Request)

Requisição HTTP

PATCH 'https://api-mtls.sandbox.bankly.com.br/cards/{proxy}/functionalityStatus' 

--request PATCH 
--url 'https://api-mtls.sandbox.bankly.com.br/cards/{proxy}/functionalityStatus' \ 
--header 'api-version: 1.0' \ 
--header 'Authorization: Bearer {{Token}}' \ 
--header 'Content-Type: application/json' \ 
--header 'accept: application/json' \
--data-raw ' 
{ 
  "enable": true,
  "functionalityType": "Pos",
  "password": "1234",
  "documentNumber": "38327396889"
}

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:

Cabeçalhos (Headers)

Parâmetros da rota (Path)

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

Corpo da requisição (Body)

No body, envie os seguintes campos em formato JSON:

{
   enable: true,
   functionalityType: "Pos",
   password: "1234",
   documentNumber: "47742663023"
}

Resposta (Response)

O status code 200 indicará sucesso na requisição.

📘

Nota

Após o bloqueio, a modalidade bloqueada apresentará o status “Blocked” nos endpoints de consultas de cartão.

Erros

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

Válido lembrar que a API também poderá retornar erros comuns entre todos os endpoints.

👍

Dica

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

Eventos

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