Criar recorrência própria

Na recorrência própria o processo de recorrência e intervalo serão executados pela própria loja. A requisição segue a estrutura de uma transação de crédito padrão, mas o parâmetro Payment.Recurrent deve ser true; caso contrário, a transação será negada.

Se Payment.Recurrent for enviado como false, a transação será negada.

Meio de pagamento aceito: cartão de crédito.

TLID Mastercard

O Transaction Link Identifier (TLID) é um identificador único gerado pela bandeira Mastercard durante uma transação, utilizado para estabelecer a continuidade entre transações relacionadas.

Fase	Descrição
Fase 1	Em breve disponibilizaremos o campo `TransactionLinkId` 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 2	Envio obrigatório do `TransactionLinkId` no request a partir de 23/10/2026 (MIT).

Saiba mais em Identificadores de bandeira.

Requisição

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 propria"
  },
  "Payment": {
    "Type": "CreditCard",
    "Amount": 1500,
    "Installments": 1,
    "SoftDescriptor": "123456789ABCD",
    "Recurrent": true,
    "SolutionType": "ExternalLinkPay",
		"IssuerTransactionId": "580027442382078",
    "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 propria"
   },
   "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

Parâmetros no header

Parâmetros no body

Parâmetro	Descrição	Tipo	Tamanho	Obrigatório
`MerchantOrderId`	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.	Texto	50	Sim
`Customer.Name`	Nome do comprador. Atenção: Os caracteres permitidos são apenas a-z, A-Z. Não são permitidos caracteres especiais e números.	Texto	255	Sim
`Payment.Type`	Tipo do meio de pagamento.	Texto	100	Sim
`Payment.Amount`	Valor do pedido (ser enviado em centavos).	Número	15	Sim
`Payment.Installments`	Número de parcelas. Como se trata de uma recorrência, o número de parcelas será 1.	Número	2	Sim
`Payment.SoftDescriptor`	Texto que será impresso na fatura bancária do portador.\ Disponível apenas para Visa e Mastercard - não permite caracteres especiais.	Texto	13	Não
`Payment.Recurrent`	Indica que uma transação é de recorrência própria.	boolean	5	Sim*
`Payment.SolutionType`	Origem do pagamento. Obrigatório para transação de cartão da bandeira Elo oriunda de link de pagamento. Enviar como "ExternalLinkPay".	string	15	Não
`CreditCard.CardNumber`	Número do cartão do comprador.	Texto	19	Sim
`CreditCard.Holder`	Nome do comprador impresso no cartão.	Texto	25	Sim
`CreditCard.ExpirationDate`	Data de validade impressa no cartão.	Texto	7	Sim
`CreditCard.SecurityCode`	Código de segurança impresso no verso do cartão.	Texto	4	Não
`CreditCard.Brand`	Bandeira do cartão.	Texto	10	Sim
`IssuerTransactionId`	Identificador da transação gerado pela bandeira. Deve ser enviado para referenciar a transação original/anterior em operações relacionadas, como em recorrências.	Texto	30	Não**

*Neste caso, o campo Payment.Recurrent é obrigatório, já que se trata de uma transação recorrente.

** No campo IssuerTransactionId embora a API aceite transações sem o preenchimento do campo, é altamente recomendado seu envio em transações recorrentes. Para mais detalhes consulte Indicadores de bandeira.

Resposta

{
    "MerchantOrderId": "2014113245231706",
    "Customer": {
        "Name": "Comprador rec propria"
    },
    "Payment": {
        "ServiceTaxAmount": 0,
        "Installments": 1,
        "Interest": "ByMerchant",
        "Capture": false,
        "SolutionType": "ExternalLinkPay",
        "Authenticate": false,
     		"Recurrent": true,
				"IssuerTransactionId": "580027442382078",
        "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",
        "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 propria"
    },
    "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": "mK8vT2qA-9LpX7dWc3Rf_HsD1Z",
        "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"
        }
    ]
}
}

Propriedade	Descrição	Tipo
`Status`	Status da Transação. Veja a tabela completa de Status transacional.	Texto
`ReturnCode`	Código de retorno. Veja a tabela completa de ReturnCode.	Texto
`ReturnMessage`	Mensagem de retorno. Veja a tabela completa de ReturnMessage.	Texto

*Neste caso, o campo Payment.Recurrent é obrigatório, já que se trata de uma transação recorrente.