Validar cartão com o Zero Auth

Simula uma autorização para verificar se o cartão está válido no momento.

AmbienteMétodoEndpoint
Sandboxhttps://apisandbox.cieloecommerce.cielo.com.br/1/zeroauth/
Produçãohttps://api.cieloecommerce.cielo.com.br/1/zeroauth/

ℹ️

Saiba mais sobre essa funcionalidade na documentação.

O exemplo desta página é valido para envio do cartão com os dados abertos (não tokenizados).

ℹ️

Importante

  • Habilite o Zero Auth pelo site Cielo ou com o suporte Cielo. Se a API retornar o código de erro 322, entre em contato com o Atendimento para habilitar a funcionalidade;
  • Caso a API retorne o erro 389 – Restrição Cadastral, procure o gestor comercial para validar se o serviço está habilitado corretamente; se estiver, o retorno indica que essa tentativa não pode ser validada por critérios internos da Cielo, recomendamos tentar outro cartão para concluir a validação;
  • Para simular cenários de autorização, confira a documentação Zero Auth em sandbox.

Bandeiras disponíveis no Zero Auth

O Zero Auth está disponível para as bandeiras Visa, Master, Elo e Diners*.

*Disponível a partir de outubro de 2026.

❗

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.

ℹ️

Transações de Zero Auth de cartão Visa tokenizado

A partir de 17/04/2026, será necessário enviar o criptograma em transações de verificação de cartão com tokenização externa na bandeira Visa:

  • Envie o DPAN (token) no campo Card.CardNumber;
  • Envie o criptograma no campo Card.SecurityCode.

TLID Mastercard

O Transaction Link Identifier (TLID), enviado e retornado no campo TransactionLinkId, é um identificador único gerado pela bandeira Mastercard durante uma transação CIT, usado para vincular as transações MIT relacionadas. O TLID vale para a resposta do Zero Auth (apenas resposta) e para as transações de crédito, débito e recorrência própria.

Na Mastercard, envie IssuerTransactionId e TransactionLinkId juntos nas transações MIT: os dois parâmetros são obrigatórios.

FaseDescrição
Fase 1Vigente. O campo TransactionLinkId está disponível na resposta da validação de cartão por Zero Auth, criação de pagamento com cartão de crédito, criação de pagamento com cartão de débito e na consulta por PaymentId.
Fase 2Envio obrigatório do TransactionLinkId no request (MIT) a partir de 23/10/2026.

Recorrência programada: nas transações seguintes, os campos IssuerTransactionId e TransactionLinkId são enviados automaticamente.

O TransactionLinkId enviado no request deve ter exatamente 22 caracteres (A-Z, a-z, 0-9, hífen e sublinhado). Se o valor estiver fora desse formato, a Cielo o ignora, sem retornar erro. Quando a Cielo envia o TLID à bandeira, a resposta traz também o SentTransactionLinkId, com o valor enviado. O request do Zero Auth não aceita o campo.

Saiba mais em Identificadores de bandeira.

Resposta da validação no Zero Auth

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.

ParâmetroDescriçãoTipoTamanho
ValidSituação do cartão:
  • True: cartão válido
  • False: cartão inválido
Boolean
ReturnCodeCódigo de retorno. Consulte os Códigos de retorno Zero Auth.String2
ReturnMessageMensagem de retorno. Consulte os Códigos de retorno Zero Auth.String255
IssuerTransactionIdIdentificador da transação gerado pela bandeira, retornado na resposta do Zero Auth. O Zero Auth não recebe esse campo no request. Armazene o valor para enviá-lo, obrigatoriamente, nas transações recorrentes seguintes de crédito e débito. Na recorrência programada, o campo é enviado automaticamente nas transações seguintes. Consulte mais informações em Identificadores de bandeira.String30
Payment.TransactionLinkId

Identificador único (TLID) gerado pela Mastercard e retornado na resposta do Zero Auth. O Zero Auth não recebe esse campo no request. Armazene o valor original para enviá-lo, junto com o IssuerTransactionId, nas transações MIT seguintes. Consulte mais informações em Identificadores de bandeira.

Formato: 22 caracteres alfanuméricos (A-Z, a-z), com diferenciação entre maiúsculas e minúsculas e podem incluir hífens (-) e sublinhados (_).

string22
Body Params
string
required

Creditcard ou DebitCard. Tamanho: 255.

string
required
Defaults to 5502095822650000

Número do cartão do comprador. Tamanho: 16.
Para verificação de cartões Visa tokenizados, envie o token do cartão.

string
required

Nome do comprador impresso no cartão. Tamanho: 25.

string
required

Data de e validade impresso no cartão. Tamanho: 7.

string
required

Código de segurança impresso no verso do cartão.
Para verificação de cartões Visa tokenizados, envie envie o criptograma no campo Cryptogram. Tamanho: 4.

string
required

Bandeira do cartão: Visa, Master, Elo e Diners**. Tamanho: 10
* *Disponível a partir de outubro de 2026.

string

Obrigatório o envio se estiver informando cartão tokenizado. Token do cartão na API E-commerce Cielo. Tamanho: 36.

CardOnFile
object
string

Criptograma gerado para autenticação de cartões tokenizados. Tamanho: até 28 caracteres.

Headers
string
required
Defaults to 8937bd5b-9796-494d-9fe5-f76b3e4da633

Identificador da loja na API. Tamanho: 36. Formato: GUID.
Esta documentação traz um MerchantId padrão para permitir os testes em sandbox, mas você também pode informar o MerchantId habilitado durante o processo de implantação.

string
required
Defaults to XKGHUBSBKIRXKAVPSKWLVXYCLVJUGTNZLIHPUSYV

Chave pública para autenticação dupla na API. Tamanho: 40. Formato: GUID.
Esta documentação traz um MerchantKey padrão para permitir os testes em sandbox, mas você também pode informar o MerchantKey habilitado durante o processo de implantação.

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json