Create a merchant recurrence

In merchant recurrence, the recurrence process and interval will be executed by the store itself. The request follows the structure of a standard credit transaction, but the Payment.Recurrent parameter must be true, otherwise the transaction will be denied.

If Payment.Recurrent is sent as false, the transaction will be denied.

Accepted payment method: credit card.

TLID Mastercard

The Transaction Link Identifier (TLID), sent and returned in the TransactionLinkId field, is a unique identifier generated by the Mastercard card brand during a CIT transaction, used to link the related MIT transactions. The TLID applies to the Zero Auth response (response only) and to credit card, debit card, and merchant recurrence transactions.

For Mastercard, send IssuerTransactionId and TransactionLinkId together in MIT transactions: both parameters are mandatory.

Phase	Description
Phase 1	Current. `TransactionLinkId` available in the responses of card validation by Zero Auth, credit card payment creation, debit card payment creation, and in the query by `PaymentId`.
Phase 2	Mandatory sending of the `TransactionLinkId` in the request (MIT) starting October 23, 2026.

Scheduled recurrence: in subsequent transactions, the IssuerTransactionId and TransactionLinkId fields are sent automatically.

The TransactionLinkId sent in the request must have exactly 22 characters (A-Z, a-z, 0-9, hyphens, and underscores). If the value doesn't match this format, Cielo ignores it and returns no error. When Cielo sends the TLID to the card brand, the response also includes the SentTransactionLinkId with the value sent. The Zero Auth request doesn't accept this field.

See more details in Card Brand Identifiers.

Request

Ambiente	Método	Endpoint
Sandbox	post	`https://apisandbox.cieloecommerce.cielo.com.br/1/sales`
Produção	post	`https://api.cieloecommerce.cielo.com.br/1/sales`

{
  "MerchantOrderId": "2014113245231706",
  "Customer": {
    "Name": "Comprador rec própria"
  },
  "Payment": {
    "Type": "CreditCard",
    "Amount": 1500,
    "Installments": 1,
    "SoftDescriptor": "123456789ABCD",
    "Recurrent": true,
		"IssuerTransactionId": "580027442382078",
    "OriginalRecurrentAmount": 1500,
    "CreditCard": {
      "CardNumber": "1234123412341231",
      "Holder": "Teste Holder",
      "ExpirationDate": "12/2030",
      "SecurityCode": "262",
      "SaveCard": "false",
      "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 própria"
   },
   "Payment":{
     "Type":"CreditCard",
     "Amount":1500,
     "Installments":1,
     "SoftDescriptor":"123456789ABCD",
     "Recurrent": true,
     "CreditCard":{
         "CardNumber":"1234123412341231",
         "Holder":"Teste Holder",
         "ExpirationDate":"12/2030",
         "SecurityCode":"262",
         "SaveCard":"false",
         "Brand":"Visa"
     }
   }
}
--verbose

{
  "MerchantOrderId": "2014113245231706",
  "Customer": {
    "Name": "Comprador rec propria"
  },
  "Payment": {
    "Type": "CreditCard",
    "Amount": 1500,
    "Installments": 1,
    "SoftDescriptor": "123456789ABCD",
    "Recurrent": true,
    "IssuerTransactionId": "580027442382078",
    "TransactionLinkId": "mK8vT2qA-9LpX7dWc3Rf_H",
    "OriginalRecurrentAmount": 1500,
    "CreditCard": {
      "CardNumber": "5123450000000000",
      "Holder": "Teste Holder",
      "ExpirationDate": "12/2030",
      "SecurityCode": "262",
      "SaveCard": "false",
      "Brand": "Master"
    }
  }
}

Parameters in header

Ambiente	Método	Endpoint
Sandbox	post	`https://apisandbox.cieloecommerce.cielo.com.br/1/sales`
Produção	post	`https://api.cieloecommerce.cielo.com.br/1/sales`

Parameters in body

Parameter	Description	Type	Syze	Required
`MerchantOrderId`	Order identification number. Warning: Allowed characters are a-z, A-Z, 0-9. Special characters and blank spaces are not allowed.	Text	50	Yes
`Customer.Name`	Customer's name. Warning: Only a-z, A-Z characters are allowed. Special characters and numbers are not allowed.	Text	255	Yes
`Payment.Type`	Type of the payment method.	Text	100	Yes
`Payment.Amount`	Order Amount (to be sent in cents).	Number	15	Yes
`Payment.Installments`	Number of installments. If the transaction is a recurrence, the number of installments will be 1.	Number	2	Yes
`Payment.SoftDescriptor`	The store's name that will be on the shopper's bank invoice. Does not allow special characters.	Text	13	No
`Payment.SolutionType`	Payment origin. Required for Elo card transactions originating from a payment link. Send as "ExternalLinkPay".	Text	15	No
`Payment.Recurrent`	Indicates an unscheduled recurrence transaction.	boolean	5	Yes*
`Payment.CreditCard.CardNumber`	Shopper's card number.	Text	19	Yes
`Payment.CreditCard.Holder`	Name of the shopper that's printed on the card	Text	25	Yes
`Payment.CreditCard.ExpirationDate`	Expiration date printed on the card. Example: MM/AAAA.	Text	7	Yes
`Payment.CreditCard.SecurityCode`	Security code printed on the back of the card.	Text	4	No
`Payment.CreditCard.Brand`	credit card brand.	Text	10	Yes
`Payment.IssuerTransactionId`	Transaction identifier generated by the card brand, returned in the CIT transaction or Zero Auth. Send it in recurring, incremental, and reauthorized MIT transactions: sending is mandatory for the Visa, Mastercard, Elo, and American Express card brands.	Text	30	Yes
`Payment.TransactionLinkId`	Unique identifier (TLID) generated by Mastercard. For Mastercard, send the original value returned in the CIT transaction or Zero Auth, together with the `IssuerTransactionId`: both are mandatory. Sending the `TransactionLinkId` is mandatory starting October 23, 2026. Format: 22 alphanumeric characters, hyphen (-), and underscore (_).	Text	22	Yes, for Mastercard
`Payment.OriginalRecurrentAmount`	Amount of the original transaction (first of the cycle), in cents. Send it together with the `IssuerTransactionId` and, for Mastercard, the `TransactionLinkId`.	Number	15	Yes

*In this case, the Payment.Recurrent field is mandatory, as this is a recurring transaction.

See more details about when to send each field in Card Brand Identifiers.

Response

{
    "MerchantOrderId": "2014113245231706",
    "Customer": {
        "Name": "Comprador rec própria"
    },
    "Payment": {
        "ServiceTaxAmount": 0,
        "Installments": 1,
        "Interest": "ByMerchant",
        "Capture": false,
        "Authenticate": false,
        "Recurrent": true,
        "CreditCard": {
            "CardNumber": "123412******1231",
            "Holder": "Teste Holder",
            "ExpirationDate": "12/2030",
            "SaveCard": false,
            "Brand": "Visa"
        },
        "ProofOfSale": "3827556",
        "Tid": "0504043827555",
        "AuthorizationCode": "149867",
        "SoftDescriptor":"123456789ABCD",
      	"PaymentId": "737a8d9a-88fe-4f74-931f-acf81149f4a0",
				"IssuerTransactionId": "580027442382078",
        "Type": "CreditCard",
        "Amount": 1500,
        "Currency": "BRL",
        "Country": "BRA",
        "Provider": "Simulado",
        "ExtraDataCollection": [],
        "Status": 1,
        "ReturnCode": "4",
        "ReturnMessage": "Operation Successful",
        "Link": {
                "Method": "GET",
                "Rel": "recurrentPayment",
                "Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/RecurrentPayment/{RecurrentPaymentId}"
            },
            "AuthorizeNow": true
        },
        "Links": [
            {
                "Method": "GET",
                "Rel": "self",
                "Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/sales/{PaymentId}"
            },
            {
                "Method": "PUT",
                "Rel": "capture",
                "Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/sales/{PaymentId}/capture"
            },
            {
                "Method": "PUT",
                "Rel": "void",
                "Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/sales/{PaymentId}/void"
            }
        ]
    }
}

--header "Content-Type: application/json"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
{
    "MerchantOrderId": "2014113245231706",
    "Customer": {
        "Name": "Comprador rec própria"
    },
    "Payment": {
        "ServiceTaxAmount": 0,
        "Installments": 1,
        "Interest": "ByMerchant",
        "Capture": false,
        "Authenticate": false,
        "Recurrent": true,
        "CreditCard": {
            "CardNumber": "123412******1231",
            "Holder": "Teste Holder",
            "ExpirationDate": "12/2030",
            "SaveCard": false,
            "Brand": "Visa"
        },
        "ProofOfSale": "3827556",
        "Tid": "0504043827555",
        "AuthorizationCode": "149867",
        "SoftDescriptor":"123456789ABCD",
        "PaymentId": "737a8d9a-88fe-4f74-931f-acf81149f4a0",
        "Type": "CreditCard",
        "Amount": 1500,
        "Currency": "BRL",
        "Country": "BRA",
        "ExtraDataCollection": [],
        "Status": 1,
        "ReturnCode": "4",
        "ReturnMessage": "Operation Successful",
        "Link": {
                "Method": "GET",
                "Rel": "recurrentPayment",
                "Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/RecurrentPayment/{RecurrentPaymentId}"
            },
            "AuthorizeNow": true
        },
        "Links": [
            {
                "Method": "GET",
                "Rel": "self",
                "Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/sales/{PaymentId}"
            },
            {
                "Method": "PUT",
                "Rel": "capture",
                "Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/sales/{PaymentId}/capture"
            },
            {
                "Method": "PUT",
                "Rel": "void",
                "Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/sales/{PaymentId}/void"
            }
        ]
    }
}

{
    "MerchantOrderId": "2014113245231706",
    "Customer": {
        "Name": "Comprador rec propria"
    },
    "Payment": {
        "ServiceTaxAmount": 0,
        "Installments": 1,
        "Interest": "ByMerchant",
        "Capture": false,
        "SolutionType": "ExternalLinkPay",
        "Authenticate": false,
        "Recurrent": true,
        "IssuerTransactionId": "580027442382078",
        "TransactionLinkId": "Xk7pQ2mR-9wLz_4TbN8vCd",
        "CreditCard": {
            "CardNumber": "123412******1231",
            "Holder": "Teste Holder",
            "ExpirationDate": "12/2030",
            "SaveCard": false,
            "Brand": "Master"
        },
        "ProofOfSale": "3827556",
        "Tid": "0504043827555",
        "AuthorizationCode": "149867",
        "SoftDescriptor":"123456789ABCD",
        "PaymentId": "737a8d9a-88fe-4f74-931f-acf81149f4a0",
        "Type": "CreditCard",
        "Amount": 1500,
        "Currency": "BRL",
        "Country": "BRA",
        "Provider": "Simulado",
        "ExtraDataCollection": [],
        "Status": 1,
        "ReturnCode": "4",
        "ReturnMessage": "Operation Successful",
        "Link": {
                "Method": "GET",
                "Rel": "recurrentPayment",
                "Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/RecurrentPayment/{RecurrentPaymentId}"
            },
            "AuthorizeNow": true
        },
        "Links": [
            {
                "Method": "GET",
                "Rel": "self",
                "Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/sales/{PaymentId}"
            },
            {
                "Method": "PUT",
                "Rel": "capture",
                "Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/sales/{PaymentId}/capture"
            },
            {
                "Method": "PUT",
                "Rel": "void",
                "Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/sales/{PaymentId}/void"
            }
        ]
    }
}

Parameter	Descripition	Type
`Status`	Transaction Status. See the full table of Transactional status.	Text
`ReturnCode`	Return code. See the full table of ReturnCode.	Text
`ReturnMessage`	Return message. See the full table of ReturnMessage.	Text

*In this case, the Payment.Recurrent field is required, as this is a recurring transaction.