Criar transação com cartão de crédito tokenizado

Split de Pagamento com a solução de captura API E-commerce Cielo

O CardToken é o cartão tokenizado retornado ao salvar o cartão durante a autorização .

Este é um exemplo de como usar o CardToken já existente para criar uma transação.

  • Por questões de segurança, um CardToken não armazena o Código de Segurança (CVV). Desta forma, é preciso solicitar esta informação ao portador para cada nova transação.
  • Para criar transações recorrentes (que permitem transacionar sem utilizar o CVV), entre em contato com o nosso suporte

O nó CreditCard dentro do nó Payment será alterado conforme exemplo a seguir:

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.

Requisição

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

--header "Authorization: Bearer {access_token}"

{
  "MerchantOrderId": "2017051001",
  "Customer": {
    "Name": "Nome do Comprador",
    "Identity": "12345678909",
    "IdentityType": "CPF",
    "Email": "[email protected]",
    "Birthdate": "1991-01-02",
    "IpAddress": "127.0.0.1",
    "Address": {
      "Street": "Alameda Xingu",
      "Number": "512",
      "Complement": "27 andar",
      "ZipCode": "12345987",
      "City": "São Paulo",
      "State": "SP",
      "Country": "BRA",
      "District": "Alphaville"
    },
    "DeliveryAddress": {
      "Street": "Alameda Xingu",
      "Number": "512",
      "Complement": "27 andar",
      "ZipCode": "12345987",
      "City": "São Paulo",
      "State": "SP",
      "Country": "BRA",
      "District": "Alphaville"
    }
  },
  "Payment": {
    "Type": "CreditCard",
    "DoSplit": true,
    "Amount": 10000,
    "Currency": "BRL",
    "Country": "BRA",
    "Installments": 1,
    "Capture": true,
    "Authenticate": false,
    "Recurrent": false,
    "SoftDescriptor": "Mensagem",
    "CreditCard": {
      "CardToken": "250e7c7c-5501-4a7c-aa42-a33d7ad61167",
      "SecurityCode": "123",
      "Brand": "Master"
    }
  },
  "InitiatedTransactionIndicator": {
    "Category": "C1",
    "Subcategory": "Standingorder"
  },
  "SplitPayments": [
    {
      "SubordinateMerchantId": "f2d6eb34-2c6b-4948-8fff-51facdd2a28f",
      "Amount": 5000,
      "Fares": {
        "Mdr": 5,
        "Fee": 30
      }
    },
    {
      "SubordinateMerchantId": "9140ca78-39667-44a5-bd44-793370afef94",
      "Amount": 5000,
      "Fares": {
        "Mdr": 4,
        "Fee": 15
      }
    }
  ]
}

Parâmetros no header

PropriedadeTipoTamanhoObrigatórioDescrição
Authorization
Bearer:access_token
String--SimToken de acesso.

Informe o access_token obtido para a autenticação OAuth2

Parâmetros no body

PropriedadeDescriçãoTipoTamanhoObrigatório?
Payment.ProviderNome do provedor do meio de pagamento.Texto15Sim
Payment.TypeTipo do meio de pagamento.Texto100Sim
Payment.AmountValor do pedido, em centavos.Número15Sim
Payment.InstallmentsNúmero de parcelas.Número2Sim
CreditCard.CardTokenToken no Cartão Protegido que representa os dados do cartão.GUID36xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
CreditCard.SecurityCodeCódigo de segurança impresso no verso do cartão. Para processar vendas sem o CVV, é necessário solicitar liberação na adquirente.Texto4Não
CreditCard.BrandBandeira do cartão de crédito. Valores aceitos: Visa, Master, Elo e Amex.Texto10Sim
InitiatedTransactionIndicator.CategoryObrigatório para bandeira Mastercard. Categoria do indicador de início da transação. Válido apenas para bandeira Mastercard.
Valores possíveis:
- “C1”: transação inciada pelo portador do cartão;
- “M1”: transação recorrente ou parcelada iniciada pela loja;
- “M2”: transação iniciada pela loja.
Texto2Não
InitiatedTransactionIndicator.SubcategoryObrigatório para bandeira Mastercard. Subcategoria do indicador. Válido apenas para bandeira Mastercard.
Valores possíveis:
Se InitiatedTransactionIndicator.Category = "C1" ou "M1"
CredentialsOnFile
StandingOrder
Subscription
Installment
Se InitiatedTransactionIndicator.Category = "M2"
PartialShipment
RelatedOrDelayedCharge
NoShow
Resubmission
Consulte a tabela com a descrição das subcategorias em Indicador de Início da Transação.
Texto--Não

Resposta

{  
   [...]
   },
   "Payment": {
      "Provider": "Simulado",
      "Type": "CreditCard",
      "Amount": 10000,
      "Currency": "BRL",
      "Country": "BRA",
      "Installments": 1,
      "Capture": true,
      "Authenticate": false,
      "Recurrent": false,
      "IssuerTransactionId": "580027442382078",
      "SoftDescriptor": "Mensagem",
      "CreditCard": {
         "CardToken":"250e7c7c-5501-4a7c-aa42-a33d7ad61167",
         "SecurityCode":"123",
         "Brand":"Visa"
      },
      "ProofOfSale": "124305",
      "AcquirerTransactionId": "0511030124305",
      "AuthorizationCode": "065964",
      "PaymentId": "23cd8bf5-2251-4991-9042-533ff5608788",
      "Type": "CreditCard",
      "Amount": 10000,
      "ReceivedDate": "2017-05-11 15:01:24",
      "Currency": "BRL",
      "Country": "BRA",
      "Provider": "Simulado",
      "ReasonCode": 0,
      "ReasonMessage": "Successful",
      "Status": 1,
      "ProviderReturnCode": "4",
      "ProviderReturnMessage": "Operation Successful"
   [...]
   }
}
PropriedadeDescriçãoTipoTamanhoFormato
AcquirerTransactionIdId da transação no provedor de meio de pagamento.Texto40Texto alfanumérico
ProofOfSaleNúmero do comprovante de venda.Texto20Texto alfanumérico
AuthorizationCodeCódigo de autorização.Texto300Texto alfanumérico
PaymentIdCampo identificador do pedido.GUID36xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
ReceivedDateData em que a transação foi recebida pelo Split.Texto19AAAA-MM-DD HH:mm:SS
ReasonCodeCódigo de retorno da operação.Texto32Texto alfanumérico
ReasonMessageMensagem de retorno da operação.Texto512Texto alfanumérico
StatusStatus da transação.Byte2Ex.: 1
ProviderReturnCodeCódigo retornado pelo provedor do meio de pagamento (adquirente ou emissor).Texto3257
ProviderReturnMessageMensagem retornada pelo provedor do meio de pagamento (adquirente ou emissor).Texto512Transação Aprovada
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.Texto30--
Payment.TransactionLinkIdIdentificador ú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 (_).
Texto22--
Payment.SentTransactionLinkIdTLID que o estabelecimento enviou no request e que a Cielo repassou à bandeira. O campo só aparece quando a Cielo enviou o TLID. Consulte mais informações em Identificadores de bandeira.Texto22--