Alteração do status do cartão

Este endpoint possibilita que o cliente do parceiro Bankly 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 Bankly tenha um cartão e que o seu status seja diferente de "Building".

Requisição

Requisição HTTP

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

     --request PATCH \
     --url 'https://api-mtls.sandbox.bankly.com.br/cards/{proxy}/status' \
     --header 'Authorization: Bearer {{Token}}' \
     --header 'accept: application/json' \
     --header 'api-version: 1.0' \
     --header 'content-type: application/json' \
     --data '
{
     "status": "TemporarilyUserLocked",
     "password": "8457",
     "updateCardBinded": false
}'

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:

📘

Nota

Os seguintes status podem ser alterados sem a necessidade de informar a senha: "Active", "TemporarilyUserLocked", "CanceledByCustomer" e "LostOrTheftCanceled".

{
     "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.

👍

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:

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

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