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.

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`

--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":"CreditCard",
      "Amount": 10000,
      "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

Propriedade	Tipo	Tamanho	Obrigatório	Descrição
Authorization Bearer:`access_token`	String	--	Sim	Token de acesso. Informe o `access_token` obtido para a autenticação OAuth2

Parâmetros do body

Propriedade	Tipo	Tamanho	Obrigatório?	Descrição
`Payment.Provider`	Texto	15	Sim	Nome do provedor do meio de pagamento.
`Payment.Type`	Texto	100	Sim	Tipo do meio de pagamento.
`Payment.Amount`	Número	15	Sim	Valor do pedido, em centavos.
`Payment.Installments`	Número	2	Sim	Número de parcelas. A recorrência só permite uma parcela. Valores possíveis: 01 ou 1.
`Payment.RecurrentPayment.EndDate`	Texto	10	Não	Data para término da recorrência.
`Payment.RecurrentPayment.Interval`	Texto	10	Não*	Intervalo da recorrência. Não utilizar em conjunto com `DailyInterval`. Monthly (default) / Bimonthly / Quarterly / SemiAnnual / Annual
`Payment.RecurrentPayment.DailyInterval`	Número	2	Não*	Padrão da recorrência em dias. Não utilizar em conjunto com `Interval`.
`Payment.RecurrentPayment.AuthorizeNow`	Booleano		Sim	"true" - autoriza no momento da requisição. "false" - para agendamento futuro.
`Payment.DoSplit`	Booleano	--	Sim	Indica se a transação será dividida entre vários participantes . Possíveis valores: true / false
`Payment.SplitPayments.SubordinateMerchantId`	GUID	36	Não	`MerchantId` (identificador) do seller.
`Payment.SplitPayments.Amount`	Número	--	Não	Valor líquido da participação do seller na transação, em centavos. O desconto da taxa será calculado pelo Split.
`Payment.SplitPayments.Fares.Mdr`	Texto	--	Não	MDR(%) do master a ser descontado do valor referente a participação do seller
`Payment.SplitPayments.Fares.Fee`	Número	--	Não	Tarifa Fixa(R$) a ser descontada do valor referente a participação do seller, em centavos.
`CreditCard.CardNumber`	Texto	16	Sim	Número do cartão do comprador.
`CreditCard.Holder`	Texto	25	Sim	Nome do comprador impresso no cartão. Obs.: Regras de tamanho do campo podem variar de acordo com a adquirente.
`CreditCard.ExpirationDate`	Texto	7	Sim	Data de validade impresso no cartão, no formato MM/AAAA.
`CreditCard.SecurityCode`	Texto	4	Sim	Código de segurança impresso no verso do cartão.
`CreditCard.Brand`	Texto	10	Sim	Bandeira do cartão.

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": false,
        "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": "CreditCard",
        "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"
            }
        ]
    }
}

Propriedade	Descrição	Tipo	Tamanho	Formato
`RecurrentPaymentId`	ID que representa a recorrência, utilizada para consultas e alterações futuras.	GUID	36	xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
`NextRecurrency`	Data de quando acontecerá a próxima recorrência.	Texto	10	2019-12-11 (YYYY-MM-DD)
`EndDate`	Data do fim da recorrência.	Texto	10	2019-12-31 (YYYY-MM-DD)
`Interval`	Intervalo entre as recorrências.	Texto	10	Monthly / Bimonthly / Quarterly / SemiAnnual / Annual
`AuthorizeNow`	Define se a primeira recorrência já irá ser autorizada ou não.	Booleano	***	"true" ou "false"