Alteração de senha

stable pré pós

Este endpoint possibilita que o cliente do parceiro Bankly possa alterar a senha do seu cartão.

Pré-requisito

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

  • O cartão do cliente esteja ativo, ou seja, já tenha saído do status Building, e apresente um status que não indique cancelamento (consulte todos os possíveis status do cartão).

Requisição(Request)

Requisição HTTP

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

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.pci.password.updateConcede acesso para alterar a senha 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
proxypathCódigo identificador do cartão.

Corpo da requisição (Body)

No body, envie o seguinte campo em formato JSON:

NomeTipoDescriçãoEspecificação
passwordstringObrigatório. Senha de uso do cartão.A senha deve possuir 04 dígitos.

❗️

Atenção

Para maior segurança, não utilize a senha atual e nem uma data de aniversário. A senha não deve conter números sequenciais (Ex. 1234 ou 8765) ou repetidos (Ex. 1111).

{
	"password": "5819",                 
}

Resposta (Response)

O status code 200 indicará que a solicitação foi aceita e que a senha foi alterada 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
409029The card is in the process of being createdO processo de criação do cartão não foi finalizado.
409CARD_HAS_PINOFFILINEThis card does not allow password change.Não é possível alterar a senha de cartão PIN offline.

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.