Manual de Integração - VerifyCard

Redirecionando para https://docs.cielo.com.br/gateway/docs/verifycard ...

As documentações do VerifyCard estão em um novo portal

Acesse o novo portal de desenvolvedores E-commerce docs.cielo.com.br.

Atenção: O conteúdo desta página está sendo descontinuado e não receberá atualizações a partir de 14/08/2024. Visite a nova documentação em docs.cielo.br.

VerifyCard

O VerifyCard é composto por dois serviços: Zero Auth e Consulta BIN.

O Zero Auth é um serviço que identifica se um cartão é válido ou não, através de uma operação semelhante a uma autorização, porém com valor R$ 0,00.

O Zero Auth simula uma autorização sem afetar o limite de crédito ou alertar o portador do cartão sobre o teste.

Atenção: As transações Zero Auth também estão sujeitas às regras definidas nos programas de retentativas das bandeiras. O excesso de tentativas pode implicar em tarifas. Leia mais em Programa de Retentativa das Bandeiras.

Já o Consulta BIN é um serviço disponível exclusivamente para clientes Cielo que retorna informações do cartão a partir do BIN (seis primeiros dígitos do cartão):

• Bandeira do cartão: nome da bandeira;
• Tipo de cartão: crédito, débito ou múltiplo (crédito e débito);
• Nacionalidade do cartão: internacional ou nacional;
• Cartão corporativo: se o cartão é corporativo ou não;
• Banco emissor: código e nome do emissor;
• Cartão pré-pago: se o cartão é pré-pago ou não.

Benefícios do VerifyCard

Os retornos do VerifyCard sobre a validade e informações do cartão permitem que a sua loja crie personalizações na sua aplicação e/ou checkout. Veja exemplos de uso:

• Solicitar autorização apenas se o cartão estiver válido: você pode criar uma condição em sua aplicação para apenas enviar a solicitação de autorização se houver retorno de sucesso no ZeroAuth;

• Solicitar a tokenização apenas se o cartão estiver válido: você pode criar uma condição em sua aplicação para apenas solicitar a tokenização de um cartão se ele estiver válido. Saiba mais no tópico Usando o VerifyCard com Cartão Protegido;
• Evitar erros relacionados ao tipo do cartão ou bandeira: se o seu checkout exige a seleção manual da bandeira ou tipo do cartão, você desenvolver uma mensagem de alerta para quando, por exemplo, a pessoa está usando um cartão de débito quando na verdade deveria usar um de crédito;
• Oferecer a recuperação do carrinho: você pode desenvolver um fluxo no seu checkout para que, caso o cartão informado o seja múltiplo (crédito e débito), a sua loja pode reter os dados do cartão e, caso a transação de crédito falhe, oferecer automaticamente ao consumidor uma transação de débito com o mesmo cartão;
• Alertar sobre cartões internacionais ou pré-pagos: se a sua loja não deseja receber pagamentos internacionais ou de cartões pré-pagos, por exemplo, você pode configurar o seu checkout para informar ao consumidor que a loja não aceita o cartão informado.

Usando o VerifyCard com o Cartão Protegido

O VerifyCard pode ser utilizada em conjunto com o serviço de tokenização do cartão (Cartão Protegido).

Neste caso, a API do VerifyCard primeiro recebe a requisição do serviço Zero Auth e faz a validação com a adquirente, que responde se o cartão é válido ou não. A API do VerifyCard envia então este retorno à loja, que poderá escolher fazer ou não a requisição de tokenização do cartão para a API do Cartão Protegido.

Abaixo veja a representação desse fluxo transacional, usando o VerifyCard em conjunto com o Cartão Protegido:

VerifyCard em sandbox

Respostas programadas Zero Auth

É possível testar os retornos do VerifyCard (Zero Auth) em ambiente sandbox usando o provider “Simulado”. Para isso, você pode usar os cartões de teste da tabela a seguir para simular os cenários de consulta autorizada, não autorizada e falha na operação.

Respostas Programadas Consulta BIN

Na simulação da Consulta BIN em ambiente sandbox, cada um dos seis primeiros dígitos vai reger um resultado simulado. É possível montar uma numeração de cartão para teste e observar o retorno esperado de acordo com diferentes cenários.

Ambientes

Integração

Para consultar um cartão, envie uma requisição utilizando o verbo HTTP POST para o serviço VerifyCard, de acordo com os exemplos deste manual. A consulta do VerifyCard pode ser feita pelo número ou pelo token do cartão.

Na requisição ao VerifyCard, você enviará o Provider junto com os dados do cartão (número ou cartão tokenizado).

Nas transações em ambiente sandbox, use o provider Simulado.

Na resposta, a verificação do ZeroAuth será exibida nas propriedades Status, ProviderReturnCode e ProviderReturnMessage. O retorno da Consulta BIN estará nas propriedades do nó BinData.

VerifyCard pelo número do cartão

{
   "Provider":"Cielo30",
   "Card":
   {
       "CardNumber": "999999******9999",
       "Holder": "Joao da Silva",
       "ExpirationDate": "03/2026",
       "SecurityCode": "***",
       "Brand": "Visa",
       "Type": "CreditCard"
   }
}

--request POST "https://apisandbox.braspag.com.br/v2/verifycard"
--header "Content-Type: application/json"
--header "MerchantId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--header "MerchantKey: 0123456789012345678901234567890123456789"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
--verbose
{
   "Provider": "Cielo30",
   "Card" :
   {
       "CardNumber": "999999******9999",
       "Holder": "Joao da Silva",
       "ExpirationDate": "03/2026",
       "SecurityCode": "***",
       "Brand": "Visa",
       "Type": "CreditCard"
   }
}

Resposta

{
    "Status": 1,
    "ProviderReturnCode": "00",
    "ProviderReturnMessage": "Transacao autorizada",
    "BinData": {
        "Provider": "Master",
        "CardType": "Crédito",
        "ForeignCard": false,
        "Code": "00",
        "Message": "Analise autorizada",
        "CorporateCard": false,
        "Issuer": "Banco da Praça",
        "IssuerCode": "001",
        "CardBin": "999999",
        "CardLast4Digits": "9999",
        "Prepaid": false
    }
}

--header "Content-Type: application/json"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
{
    "Status": 1,
    "ProviderReturnCode": "00",
    "ProviderReturnMessage": "Transacao autorizada",
    "BinData": {
        "Provider": "Master",
        "CardType": "Crédito",
        "ForeignCard": false,
        "Code": "00",
        "Message": "Analise autorizada",
        "CorporateCard": false,
        "Issuer": "Banco da Praça",
        "IssuerCode": "001",
        "CardBin": "999999",
        "CardLast4Digits": "9999",
        "Prepaid": false
    }
}

VerifyCard pelo token do cartão

{
    "Provider": "Cielo30",
    "Card": {
        "CardToken": "af1ffa95-e4a6-4ed9-9270-a9cb4c586c4a",
        "SecurityCode": "939",
        "Brand": "Visa",
        "Type": "CreditCard"
    }
}

--request POST "https://apisandbox.braspag.com.br/v2/verifycard"
--header "Content-Type: application/json"
--header "MerchantId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--header "MerchantKey: 0123456789012345678901234567890123456789"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
--verbose
{
   "Provider": "Cielo30",
   "Card" :
   {
       "CardToken": "af1ffa95-e4a6-4ed9-9270-a9cb4c586c4a",
        "SecurityCode": "939",
        "Brand": "Visa",
        "Type": "CreditCard"
   }
}

Resposta

{
    "Status": 1,
    "ProviderReturnCode": "00",
    "ProviderReturnMessage": "Transacao autorizada",
    "BinData": {
        "Provider": "Master",
        "CardType": "Crédito",
        "ForeignCard": false,
        "Code": "00",
        "Message": "Analise autorizada",
        "CorporateCard": false,
        "Issuer": "Banco da Praça",
        "IssuerCode": "001",
        "CardBin": "999999",
        "CardLast4Digits": "9999",
        "Prepaid": false
    }
}

--header "Content-Type: application/json"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
{
    "Status": 1,
    "ProviderReturnCode": "00",
    "ProviderReturnMessage": "Transacao autorizada",
    "BinData": {
        "Provider": "Master",
        "CardType": "Crédito",
        "ForeignCard": false,
        "Code": "00",
        "Message": "Analise autorizada",
        "CorporateCard": false,
        "Issuer": "Banco da Praça",
        "IssuerCode": "001",
        "CardBin": "999999",
        "CardLast4Digits": "9999",
        "Prepaid": false
    }
}