Consulta de senha com criptografia

stable

Este endpoint permite que o cliente do parceiro Bankly consulte a senha do seu cartão por meio de comunicação criptografada.

📘

Nota

Para aumentar o nível de segurança da informação, o uso desse serviço é exclusivo para clientes homologados com o time de segurança do Bankly.

Pré-requisitos

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

  • Durante o desenvolvimento do projeto, o parceiro solicite autorização ao time de segurança do Bankly para realizar o processo de homologação técnica;
  • Após homologação e alinhamento prévio com o time de TAM, Cartões e Segurança do Bankly, o parceiro Bankly adquira o certificado de criptografia;
  • O cliente do parceiro Bankly possua um cartão ativo/bloqueado.

🚧

Importante

Esteja atento à data de expiração do certificado de criptografia, para renovações futuras.

Requisição

Requisição HTTP

GET https://api-mtls.sandbox.bankly.com.br/cards-pci/{proxy}/password' 
    --request GET 
    --url 'https://api-mtls.sandbox.bankly.com.br/cards-pci/{proxy}/password' \
    --header 'Authorization: Bearer {Token}' \
    --header 'accept: application/json' \
    --header 'api-version: 1' \
    

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.readConcede acesso para consultar dados PCI 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çãoEspecificação
proxypathObrigatório. Código identificador do cartão.

Corpo da requisição (Body)

Não é necessário enviar campos no body desta requisição.

Resposta (Response)

O status code 200 indicará sucesso na consulta.
Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:

NomeTipoDescriçãoNúmero máximo de caracteres
passwordstringSenha do cartão criptografada em formato base64.
{
   "password": "EeMiB6nb/ITsSvoqp3ymRZmZFzSAlvijsMj8MreVnRS7kTpGAvAYR3w0Urc9+vZfO5pu4xuP3bpHL83lA8ODpMCvBj/OZbguE7O+sqlW2E+S+TkurjKg8wpQzucivCcN/e82/O6JIk0PxjBWpJacvCv+xZzjv4Y+Y1jz0N5by/lm2mklV5xl6TCQAfSr2bdy55YJT5MQ5fcJnlV1nOtjzxHiQIccMXJgzHqYlLP+mawou5un995oszS2tXDGS9kfxqd/4oHBGhQZ6fGR5tAiuY7Bb16mcoKF62YbifpuiqJo7LbyIPjo/tpd/UIC1BQxoNr9peTOk7tKfTC0wQdTdw=="
}

👍

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
403CERTIFICATE_NOTFOUNDCertificate not found for partner.Não foi encontrado um certificado válido configurado para o parceiro.
404002Card Not FoundCartão não encontrado.

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.