Criar pagamento com cartão tokenizado

Cria uma transação usando um cartão tokenizado anteriormente

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

ℹ️

Saiba mais sobre essa funcionalidade na documentação.

Essa é uma transação de cartão de crédito, mas no lugar de enviar os dados do cartão aberto, é possível criar a transação informando um CardToken criado previamente.

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 transação de cartão de crédito usando cartão tokenizado

A tabela a seguir apresenta os principais parâmetros que podem ser retornados pela API na criação de um pagamento com cartão de crédito tokenizado.

PropriedadeDescriçãoTipoTamanho
ProofOfSaleNúmero da autorização, idêntico ao NSU.string6
TidIdentificador da transação na adquirente.string20
AuthorizationCodeCódigo de autorização.string6
PaymentIdNúmero de identificação do pagamento.
O PaymentId será usado em futuras operações como consulta, captura e cancelamento.
GUID36
StatusStatus da Transação. Veja a tabela completa de Status transacionalbyte
ReturnCodeCódigo de retorno.string32
ReturnMessageMensagem de retorno.string512
Payment.MerchantAdviceCodeCódigo de retorno da bandeira que define período para retentativa. Válido somente para bandeira Mastercard. Saiba mais Programa de retentativa das bandeiras para Mastercardstring2
TryAutomaticCancellationRetorna como "true" se a Garantia de Cancelamento estiver habilitada e ocorrer algum erro durante a autorização (status Não Finalizada - "0").boolean
Payment.CreditCard.PaymentAccountReferenceO PAR (Payment Account Reference) é o número que associa diferentes tokens a um mesmo cartão. Será retornado pelas bandeiras Master e Visa e repassado para os clientes do e-commerce Cielo. Caso a bandeira não envie a informação o campo não será retornado.string29
Payment.IssuerTransactionIdIdentificador da transação gerado pela bandeira e retornado na resposta da transação CIT. Armazene o valor para enviá-lo nas transações MIT seguintes: o envio é obrigatório, para todas as bandeiras, em transações recorrentes, incrementais e reautorizadas. Consulte mais informações em Identificadores de bandeira.string30
Payment.TransactionLinkId

Identificador único (TLID) gerado pela Mastercard e retornado na resposta, usado para vincular a transação CIT às transações MIT seguintes. Na Mastercard, envie o TransactionLinkId original junto com o IssuerTransactionId: os dois são obrigatórios, e o envio do TransactionLinkId é obrigatório a partir de 23/10/2026. 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

Número de identificação do pedido. Atenção: Os caracteres permitidos são apenas a-z, A-Z, 0-9. Não são permitidos caracteres especiais e espaços em branco. Tamanho: 20.

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

Identificador da loja na Cielo. 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 Cielo. 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.

string

Identificador da requisição, usado quando a loja usa diferentes servidores para cada GET/POST/PUT. Tamanho: 36.

Response

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