Alteração do status do cartão

stable pré pós

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:

ScopeDescrição
card.updateConcede acesso para alterar o status de um 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.

Corpo da requisição (Body)

No body, envie os seguintes campos em formato JSON:

NomeTipoDescrição
statusstringObrigatório. Status para o qual o cartão será modificado. Confira a tabela com os possíveis status reversíveis e irreversíveis na página Possíveis status do cartão. Importante: Apenas informe os status contidos na tabela "Status alterados pelo parceiro".
passwordstringSenha de uso do cartão. A senha deve possuir 04 dígitos.
Importante: Este campo somente é obrigatório caso seja informado o status "CanceledByEmitter" ou "DeathCanceled".
updateCardBindedbooleanIndica se o cartão vinculado deverá ser atualizado (TRUE) ou não (FALSE).

📘

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:

Status CodeCódigoMensagemDescrição
400127BindProxy, Card Not Found!O proxy informado possui vínculo com outros cartões. Neste caso, um ou mais cartões atrelados não foram encontrados.
400128ComboProxyBind, Card Not Found!O proxy informado possui vínculo com outros cartões. Neste caso, um ou mais cartões atrelados não foram encontrados.
403020The current status does not allow changes by this user profile!O status atual não permite alterações para o perfil de usuário usado na requisição.
404002Card not found!O cartão informado não foi encontrado.
406009The current status does not allow a change to the chosen status!O status atual do cartão não pode transacionar para o status informado.
406018Current status does not allow changes by this method!O status atual não pode ser alterado por este método.
406021Card is already in the status!O cartão já encontra-se no status de destino informado.

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:

Nome do eventoDescrição
CARD_STATUS_WAS_MODIFIEDO status do cartão foi alterado.