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 (Request)
Requisição HTTP
POST https://api-mtls.sandbox.bankly.com.br/cards/{proxy}/pci
--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:
Scope | Descrição |
---|---|
card.pci.read | Concede acesso para consultar os dados PCI de um cartão. |
Cabeçalhos (Headers)
Nome | Descrição |
---|---|
api-version | Obrigatório. Versão da API. Atualmente estamos na versão 1.0. |
Authorization | Obrigatório. Token de autorização do tipo Bearer. |
Parâmetros da rota (Path)
No path desta requisição envie os seguintes campos:
Nome | Tipo | Descrição |
---|---|---|
proxy | path | Obrigatório. Código identificador do cartão. |
Corpo da requisição (Body)
No body, envie o seguinte campo em formato JSON:
Nome | Tipo | Descrição | Especificação |
---|---|---|---|
password | string | Obrigató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:
Nome | Tipo | Descrição |
---|---|---|
cardNumber | string | Numeração do cartão. |
cvv | string | Código de segurança do cartão. |
expirationDate | string | Data 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 Code | Código | Mensagem | Descrição |
---|---|---|---|
400 | WRONG_PASSWORD_ATTEMPT_LOCKED | Wrong Password Attempt Locked | Tentativa de senha errada bloqueada. |
404 | 002 | Card Not Found | Cartão não encontrado. |
404 | 100 | Program not found | Programa não encontrado. |
406 | 011 | Invalid password | Senha inválida. |
409 | 029 | The card is in the process of being created | Cartão em construção. |
503 | 300 | Bad Request client | Erro 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.
Updated 3 days ago