Dados de segurança do cartão

stable pré pós

Este endpoint possibilita que o cliente do parceiro Bankly consulte os dados de PCI (PAN, CVV e data de validade) do seu cartão.

Pré-requisito

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

  • O cliente do parceiro Bankly tenha um proxy de cartão emitido.

Requisição HTTP

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

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 os 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ção
proxypathObrigatório. Có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 informada na criação do cartão.Tamanho: 04 dígitos.

Resposta (Response)

O status code 200 indicará que a solicitação foi aceita com sucesso e trará um objeto contendo os dados PCI do cartão.

Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:

NomeTipoDescrição
cardNumberstringNumeração do cartão.
cvvstringCódigo de segurança do cartão.
expirationDatestringData de expiração do cartão, no formato 'MM/YY'.
{
  "cardNumber": "000000000000000",
  "cvv": "000",
  "expirationDate": "05/09"
}

👍

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
400WRONG_PASSWORD_ATTEMPT_LOCKEDWrong Password Attempt LockedTentativa de senha errada bloqueada.
404002Card Not FoundCartão não encontrado.
404100Program not foundPrograma não encontrado.
406011Invalid passwordSenha inválida.
409029The card is in the process of being createdCartão em construção.
503300Bad Request clientErro ao realizar requisição no parceiro.

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.