Autorizar recorrência com cartão de crédito

⚠️

Atenção:

  • Adicione o nó RecurrentPayment ao nó Payment para agendar as recorrências futuras ao autorizar uma transação pela primeira vez na série de recorrências;
  • Os parâmetros Payment.RecurrentPayment.Interval e Payment.RecurrentPayment.DailyInterval, marcados com um "*" na coluna "OBRIGATÓRIO", não devem ser utilizados em conjunto;
  • Informe o nó Payment.SplitPayments para definir a divisão de uma transação Split entre diferentes participantes. É possível informar vários sellers. O envio é obrigatório.

Identificadores de bandeira: na recorrência programada, os campos IssuerTransactionId e TransactionLinkId são enviados automaticamente nas transações seguintes. Em sandbox, esses campos só são retornados com o provider Simulado e cenário de transação autorizada. 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": {
      "Provider":"Simulado",
      "Type":"splittedcreditcard",
      "Amount": 10000,
      "Recurrent": true,
      "Installments": 1,
      "CreditCard": {
         "CardNumber":"4091688625337641",
         "Holder":"Nome do Portador",
         "ExpirationDate":"12/2035",
         "SecurityCode":"123",
         "Brand":"Visa",
         "DoSplit": true
      },
      "RecurrentPayment": {
         "AuthorizeNow":"true",
         "EndDate":"2030-12-31",
         "Interval":"Monthly"
      }
   },
    "SplitPayments": [
      {
        "SubordinateMerchantId": "f2d6eb34-2c6b-4948-8fff-51facdd2a28f",
        "Amount": 5000,
        "Fares": {
          "Mdr": 5,
          "Fee": 30
        }
      },
      {
        "SubordinateMerchantId": "9140ca78-3955-44a5-bd44-793370afef94",
        "Amount": 5000,
        "Fares": {
          "Mdr": 4,
          "Fee": 15
        }
      }
    ]
  }

Parâmetros do header

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

Informe o access_token obtido para a autenticação OAuth2

Parâmetros do body

PropriedadeTipoTamanhoObrigatório?Descrição
Payment.ProviderTexto15SimNome do provedor do meio de pagamento.
Payment.TypeTexto100SimTipo do meio de pagamento. Para transação de cartão de crédito, use splittedcreditcard.
Payment.AmountNúmero15SimValor do pedido, em centavos.
Payment.InstallmentsNúmero2SimNúmero de parcelas. A recorrência só permite uma parcela.
Valores possíveis: 01 ou 1.
Payment.RecurrentBooleano--SimIndica que é uma transação recorrente.
Payment.RecurrentPayment.EndDateTexto10NãoData para término da recorrência.
Payment.RecurrentPayment.IntervalTexto10Não*Intervalo da recorrência. Não utilizar em conjunto com DailyInterval.

Monthly (default) / Bimonthly / Quarterly / SemiAnnual / Annual
Payment.RecurrentPayment.DailyIntervalNúmero2Não*Padrão da recorrência em dias. Não utilizar em conjunto com Interval.
Payment.RecurrentPayment.AuthorizeNowBooleano
Sim"true" - autoriza no momento da requisição. "false" - para agendamento futuro.
Payment.DoSplitBooleano--SimIndica se a transação será dividida entre vários participantes
. Possíveis valores: true / false
Payment.SplitPayments.SubordinateMerchantIdGUID36NãoMerchantId (identificador) do seller.
Payment.SplitPayments.AmountNúmero--NãoValor líquido da participação do seller na transação, em centavos. O desconto da taxa será calculado pelo Split.
Payment.SplitPayments.Fares.MdrTexto--NãoMDR(%) do master a ser descontado do valor referente a participação do seller
Payment.SplitPayments.Fares.FeeNúmero--NãoTarifa Fixa(R$) a ser descontada do valor referente a participação do seller, em centavos.
CreditCard.CardNumberTexto16SimNúmero do cartão do comprador.
CreditCard.HolderTexto25SimNome do comprador impresso no cartão. Obs.: Regras de tamanho do campo podem variar de acordo com a adquirente.
CreditCard.ExpirationDateTexto7SimData de validade impresso no cartão, no formato MM/AAAA.
CreditCard.SecurityCodeTexto4SimCódigo de segurança impresso no verso do cartão.
CreditCard.BrandTexto10SimBandeira do cartão de crédito. Valores aceitos: Visa, Master, Elo e Amex.

Resposta

{
    "MerchantOrderId": "2017051001",
    "Customer": {
        "Name": "Nome do Comprador",
        "Identity": "12345678909",
        "IdentityType": "CPF",
        "Email": "[email protected]",
        "Birthdate": "1991-01-02",
        "Address": {
            "Street": "Alameda Xingu",
            "Number": "512",
            "Complement": "27 andar",
            "ZipCode": "12345987",
            "City": "São Paulo",
            "State": "SP",
            "Country": "BRA",
            "District": "Alphaville",
            "AddressType": 0
        },
        "DeliveryAddress": {
            "Street": "Alameda Xingu",
            "Number": "512",
            "Complement": "27 andar",
            "ZipCode": "12345987",
            "City": "São Paulo",
            "State": "SP",
            "Country": "BRA",
            "District": "Alphaville",
            "AddressType": 0
        },
        "IpAddress": "127.0.0.1"
    },
    "Payment": {
        "ServiceTaxAmount": 0,
        "Installments": 1,
        "Interest": 0,
        "Capture": false,
        "Authenticate": false,
        "Recurrent": true,
        "CreditCard": {
            "CardNumber": "409168******7641",
            "Holder": "Nome do Portador",
            "ExpirationDate": "12/2035",
            "SaveCard": false,
            "Brand": "Visa",
            "PaymentAccountReference": "IR5LNWLBCJZYTTSU35GGMKK2RANBN"
        },
        "Tid": "0521115025335",
        "ProofOfSale": "967925",
        "AuthorizationCode": "432884",
        "Provider": "Simulado",
        "IsQrCode": false,
        "RecurrentPayment": {
            "RecurrentPaymentId": "32201ba0-a669-4530-b1dd-96f11234b24ca",
            "ReasonCode": 0,
            "ReasonMessage": "Successful",
            "NextRecurrency": "2026-06-21",
            "EndDate": "2030-12-31",
            "Interval": 1,
            "Link": {
                "Method": "GET",
                "Rel": "recurrentPayment",
                "Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/RecurrentPayment/32201ba0-a669-4530-b1dd-96f11234b24ca"
            },
            "AuthorizeNow": true
        },
        "SentOrderId": "20260521115025F77CDA",
        "Amount": 10000,
        "ReceivedDate": "2026-05-21 11:50:25",
        "Status": 1,
        "IsSplitted": true,
        "ReturnMessage": "Operation Successful",
        "ReturnCode": "4",
        "PaymentId": "85b6c25c-1329-49c6-a97b-21aa112340480",
        "Type": "SplittedCreditCard",
        "Currency": "BRL",
        "Country": "BRA",
        "Links": [
            {
                "Method": "GET",
                "Rel": "self",
                "Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/sales/85b6c25c-1329-49c6-a97b-21aa112340480"
            },
            {
                "Method": "PUT",
                "Rel": "capture",
                "Href": "https://apisandbox.cieloecommerce.cielo.com.br/1/sales/85b6c25c-1329-49c6-a97b-21aa112340480/capture"
            },
            {
                "Method": "PUT",
                "Rel": "void",
                "Href": "https://apisandbox.cieloecommerce.cielo.com.br/1/sales/85b6c25c-1329-49c6-a97b-21aa112340480/void"
            }
        ]
    }
}
PropriedadeDescriçãoTipoTamanhoFormato
RecurrentPaymentIdID que representa a recorrência, utilizada para consultas e alterações futuras.GUID36xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
NextRecurrencyData de quando acontecerá a próxima recorrência.Texto102019-12-11 (YYYY-MM-DD)
EndDateData do fim da recorrência.Texto102019-12-31 (YYYY-MM-DD)
IntervalIntervalo entre as recorrências.Texto10Monthly / Bimonthly / Quarterly / SemiAnnual / Annual
AuthorizeNowDefine se a primeira recorrência já irá ser autorizada ou não.Booleano***"true" ou "false"
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--