Portuguese (BR)
API Reference
API StatusSupport

Create a scheduled recurrence

It is possible to create a scheduled recurrence that does not authorize the transaction immediately but schedules a future transaction instead. This action is called scheduling recurrence and has two characteristics:

  • To not authorize the transaction at the time it is created, send AuthorizeNow as "false";
  • Send the StartDate parameter, which determines the start date of the recurring charge.

ℹ️

When setting up a recurrence with a StartDate earlier than the current date, the system will perform retroactive daily charges, one for each pending payment up to the current date. This process continues until the next charge date is in the future.

ℹ️

Before scheduling a scheduled recurrence, use Zero Auth to validate the card. This way, you ensure that you are scheduling the recurrence with a valid card.

Accepted payment method: credit card.

⚠️

Identification of transactions originating from payment links for Elo cards

Starting October 17, 2025, it will be mandatory to identify transactions originating from payment links for Elo-branded cards. Send the parameter Payment.SolutionType = "ExternalLinkPay".


Request

EnvironmentMethodEndpoint
Sandbox
post
https://apisandbox.cieloecommerce.cielo.com.br/1/sales/
Production
post
https://api.cieloecommerce.cielo.com.br/1/sales/
{
  "MerchantOrderId": "2014113245231706",
  "Customer": {
    "Name": "Comprador rec programada"
  },
  "Payment": {
    "Type": "CreditCard",
    "Amount": 1500,
    "Installments": 1,
    "SoftDescriptor": "123456789ABCD",
    "RecurrentPayment": {
      "AuthorizeNow": "false",
      "EndDate": "2030-12-01",
      "Interval": "SemiAnnual",
      "StartDate": "2025-02-01"
    },
    "CreditCard": {
      "CardNumber": "1234123412341231",
      "Holder": "Teste Holder",
      "ExpirationDate": "12/2030",
      "SecurityCode": "262",
      "Brand": "Visa"
    }
  }
}

curl
--request POST "https://apisandbox.cieloecommerce.cielo.com.br/1/sales/"
--header "Content-Type: application/json"
--header "MerchantId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--header "MerchantKey: 0123456789012345678901234567890123456789"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
{
   "MerchantOrderId":"2014113245231706",
   "Customer":{
      "Name":"Comprador rec programada"
   },
   "Payment":{
     "Type":"CreditCard",
     "Amount":1500,
     "Installments":1,
     "SoftDescriptor":"123456789ABCD",
     "RecurrentPayment":{
       "AuthorizeNow":"false",
       "EndDate":"2019-12-01",
       "Interval":"SemiAnnual",
       "StartDate":"2015-06-01"
     },
     "CreditCard":{
         "CardNumber":"1234123412341231",
         "Holder":"Teste Holder",
         "ExpirationDate":"12/2030",
         "SecurityCode":"262",
         "Brand":"Visa"
     }
   }
}
--verbose

Parameters in header

ParameterTypeSizeRequiredDescription
MerchantIdStore identifier in API E-commerce Cielo.String6Yes
MerchantKeyPublic Key for Double Authentication in API E-commerce Cielo.String40Yes
RequestIdRequest identifier, used when the merchant uses different servers for each GET/POST/PUT.String36No

Parameters in body

ParameterTypeSizeRequiredDescription
MerchantOrderIdOrder identification number. Warning: Allowed characters are a-z, A-Z, 0-9. Special characters and blank spaces are not allowed.String50Sim
Customer.NameCustomer's name..
Warning: Only a-z, A-Z characters are allowed. Special characters and numbers are not allowed.		String255Sim
Payment.TypeType of the Payment Method.String100Sim
Payment.AmountOrder Amount (to be sent in cents).Número15Sim
Payment.InstallmentsNumber of installments. As this is a recurrence, the number of installments will be 1.Número2Sim
Payment.SoftDescriptorText that will be printed on the carrier's bank invoice - Available only for VISA/MASTER - does not allow special charactersString13Não
Payment.RecurrentPayment.AuthorizeNowBoolean to know if the first recurrence is going to be Authorized or not.Boolean-Sim
Payment.RecurrentPayment.StartDateStart date of recurrence.Boolean-Sim
Payment.RecurrentPayment.EndDateEnd date of recurrence.String10Não
Payment.RecurrentPayment.IntervalRecurrence interval.

- Monthly (Default)
- Bimonthly
- Quarterly
- SemiAnnual
- Annual		String10Não
Payment.RecurrentPayment.AuthorizeNowBoolean to know if the first recurrence is going to be Authorized or not.Boolean***Sim
Payment.SolutionTypePayment origin. Required for Elo card transactions originating from a payment link.
Send as "ExternalLinkPay".		String15No
CreditCard.CardNumberShopper's Card Number.String19Sim
CreditCard.HolderShopper's name printed on card.String25Sim
CreditCard.ExpirationDateExpiration date printed on card.String7Sim
CreditCard.SecurityCodeSecurity code printed on back of card.String4Não
CreditCard.BrandCard brand.String10Sim

Response

{
  "MerchantOrderId": "2014113245231706",
  "Customer": {
    "Name": "Comprador rec programada"
  },
  "Payment": {
    "ServiceTaxAmount": 0,
    "Installments": 1,
    "Interest": "ByMerchant",
    "Capture": false,
    "Authenticate": false,
    "Recurrent": false,
    "CreditCard": {
      "CardNumber": "123412******1231",
      "Holder": "Teste Holder",
      "ExpirationDate": "12/2030",
      "SaveCard": false,
      "Brand": "Visa"
    },
    "SoftDescriptor": "123456789ABCD",
    "Type": "CreditCard",
    "Amount": 1500,
    "Currency": "BRL",
    "Country": "BRA",
    "ExtraDataCollection": [],
    "Status": 20,
    "RecurrentPayment": {
      "RecurrentPaymentId": "0d2ff85e-594c-47b9-ad27-bb645a103db4",
      "NextRecurrency": "2015-06-01",
      "StartDate": "2015-06-01",
      "EndDate": "2019-12-01",
      "Interval": "SemiAnnual",
      "Link": {
        "Method": "GET",
        "Rel": "recurrentPayment",
        "Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/RecurrentPayment/{PaymentId}"
      },
      "AuthorizeNow": false
    }
  }
}

--header "Content-Type: application/json"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
{
    "MerchantOrderId": "2014113245231706",
    "Customer": {
        "Name": "Comprador rec programada"
    },
    "Payment": {
        "ServiceTaxAmount": 0,
        "Installments": 1,
        "Interest": "ByMerchant",
        "Capture": false,
        "Authenticate": false,
        "Recurrent": false,
        "CreditCard": {
            "CardNumber": "123412******1231",
            "Holder": "Teste Holder",
            "ExpirationDate": "12/2030",
            "SaveCard": false,
            "Brand": "Visa"
        },
        "SoftDescriptor":"123456789ABCD",
        "Type": "CreditCard",
        "Amount": 1500,
        "Currency": "BRL",
        "Country": "BRA",
        "Provider": "Simulado",
        "ExtraDataCollection": [],
        "Status": 20,
        "RecurrentPayment": {
            "RecurrentPaymentId": "0d2ff85e-594c-47b9-ad27-bb645a103db4",
            "NextRecurrency": "2015-06-01",
            "StartDate": "2015-06-01",
            "EndDate": "2019-12-01",
            "Interval": "SemiAnnual",
            "Link": {
                "Method": "GET",
                "Rel": "recurrentPayment",
                "Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/RecurrentPayment/{PaymentId}"
            },
            "AuthorizeNow": false
        }
    }
}
ParameterTypeSizeRequiredDescription
RecurrentPaymentIdNext recurrence Identifier field.GUID36xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
NextRecurrencyDate of next recurrence.String712/2030 (MM/YYYY)
StartDateStart date of recurrence.String712/2030 (MM/YYYY)
EndDateEnd date of recurrence.String712/2030 (MM/YYYY)
IntervalInterval between recurrences.Number10- Monthly (mensal, é o padrão) - Bimonthly (bimensal) - Quarterly (trimestral) - SemiAnnual (semestral) - Annual (anual)
AuthorizeNowBoolean to know if the first recurrence is about to be Authorized or not.Boolean***false