Validar cartão de e-wallet

Ambiente	Método	Endpoint
Sandbox	post	`https://apisandbox.cieloecommerce.cielo.com.br/2/zeroauth/`
Produção	post	`https://api.cieloecommerce.cielo.com.br/2/zeroauth/`

A resposta sempre retorna se o cartão pode ser autorizado no momento. Essa informação apenas significa que o cartão está válido para transacionar, mas não indica que um determinado valor será autorizado.

Os campos retornados na resposta dependem do resultado da validação. A tabela a seguir apresenta todos os campos possíveis.

ℹ️
Se a API retornar o código de erro 323, entre em contato com o Atendimento para habilitar a funcionalidade.

❗
Se a resposta for negativa, não submeta o cartão para autorização.
Envie o cartão para autorização apenas se o código de resposta da verificação Zero Auth for positivo.

Requisição

{
    "Card": {
       "CardType": "CreditCard",
       "CardNumber": "4532154371691902",
       "Holder": "Joao da Silva",
       "ExpirationDate": "MM/YYYY",
       "SecurityCode": "333",
       "Brand": "Visa",
       "CardOnFile": {
           "Usage": "First",
           "Reason": "Recurring"
       }
    },
    "Wallet": {
       "Type": "ApplePay",
       "Cavv": "AM1mbqehL24XAAa0J04CAoABFA==",
       "Eci": 7
    }
}

Parâmetros do header

Parâmetro	Descrição	Tipo	Tamanho	Obrigatório
`MerchantId`	Identificador da loja na API.	Texto	36	Sim
`MerchantKey`	Chave pública para autenticação dupla na API.	Texto	40	Sim
`Content-type`	application/json	Texto	--	Não

Parâmetros do body

Parâmetro	Descrição	Tipo	Tamanho	Obrigatório
`Card.CardType`	Tipo do cartão. Valores possíveis: Creditcard ou DebitCard.	Texto	255	Sim
`Card.CardNumber`	Número do Cartão do Comprador	Texto	16	Sim
`Card.Holder`	Nome do Comprador impresso no cartão.	Texto	25	Sim
`Card.ExpirationDate`	Data de validade impresso no cartão.	Texto	7	Sim
`Card.SecurityCode`	Código de segurança impresso no verso do cartão.	Texto	4	Sim
`Card.Brand`	Bandeira do cartão: Visa Master Elo	Texto	10	Sim
`Card.CardOnFile.Usage`	Firstse o cartão foi armazenado e é seu primeiro uso. Used* se o cartão foi armazenado e ele já foi utilizado anteriormente em outra transação.	Texto		Não
`Card.CardOnFileReason`	Indica o propósito de armazenamento de cartões, caso o parâmetro `CardOnFile.Usage` seja “Used”. Recurring: compra recorrente programada (ex. assinaturas). Se for transação recorrente, usar `Payment.Recurrent` = true (recorrência própria) ou `Recurrent.Payment` = true (recorrência programada). Unscheduled: compra recorrente sem agendamento (ex. aplicativos de serviços). Installments: parcelamento através da recorrência. Veja Mais .	Texto		Condicional
`Wallet.Type`	Tipo da e-wallet: “ApplePay” / “SamsungPay” / “GooglePay”.	Texto	15	Sim
`Wallet.Cavv`	Campo de validação retornado pela e-wallet como base de autorização.	Texto	255	Sim
`Wallet.Eci`	Electronic Commerce Indicator. Representa o quão segura é uma transação.A loja deve considerar o ECI na tomada de decisão de enviar ou não uma transação para autorização/captura.	Texto	2	Sim

Resposta

{
  "Valid": true,
  "ReturnCode": "00",
  "ReturnMessage": "Transacao autorizada",
  "IssuerTransactionId": "580027442382078"
}

{
  "Valid": false,
  "ReturnCode": "57",
  "ReturnMessage": "Autorizacao negada",
  "IssuerTransactionId": "580027442382078"
}

{
  "Code": 57,
  "Message": "Bandeira inválida"
}

{
  "Code": 389,
  "Message": "Restrição Cadastral"
}

Bad Request

Internal Server Error

[
    {
       "ReturnCode": 322,
       "ReturnMessage": "Zero Dollar Auth is not enabled"
    }
  ]

Os campos retornados na resposta dependem do resultado da validação. A tabela a seguir apresenta todos os campos possíveis; depois da tabela, confira os exemplos de cada tipo de resposta.

Se a resposta for negativa, não submeter para autorização, submeter apenas se o código da resposta for positivo.

Parâmetro	Descrição	Tipo	Tamanho
`Valid`	Situação do cartão: True – Cartão válido False – Cartão Inválido	Boolean
`ReturnCode`	Código de retorno	Texto	2
`ReturnMessage`	Mensagem de retorno	Texto	255
`IssuerTransactionId`	Identificador de autenticação do emissor para transações de crédito e débito recorrentes. Este campo deve ser enviado nas transações subsequentes da primeira transação no modelo de recorrência própria. Já no modelo de recorrência programada, a Cielo será a responsável por enviar o campo nas transações subsequentes.	Texto	15