Criar pagamento recorrente com cartão tokenizado

É possível criar uma transação recorrente com um cartão que já está armazenado (tokenizado).

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": "Loja123456",
  "Customer": {
    "Name": "Aline de Souza"
  },
  "Payment": {
    "Type": "CreditCard",
    "Amount": 1500,
    "Installments": 1,
    "Capture": true,
    "RecurrentPayment": {
      "AuthorizeNow": "true",
      "EndDate": "2030-10-01",
      "Interval": "Monthly"
    },
    "CreditCard": {
      "CardToken": "4086baad-a31c-48b9-830d-8596bfe9c33c",
      "Brand": "Visa",
      "SecurityCode": "123",
    }
  }
}

Parâmetros no header

Propriedade	Descrição	Tipo	Tamanho	Obrigatório
`MerchantId`	Identificador da loja na API E-commerce Cielo.	GUID	36	Sim
`MerchantKey`	Chave pública para autenticação dupla na API E-commerce Cielo	string	40	Sim
`RequestId`	Identificador da requisição, usado quando a loja usa diferentes servidores para cada GET/POST/PUT	GUID	36	Não

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.	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.Capture`	Booleano que identifica que a autorização deve ser com captura automática (“true”) ou captura posterior (“false”).	Boolean	-	Não (default: false)
`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.RecurrentPayment`	Indica que uma transação é de recorrência própria.	Boolean	5	Sim* \|
`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

Resposta

{
  "MerchantOrderId": "Loja123456",
  "Customer": {
    "Name": "Aline de Souza"
  },
  "Payment": {
    "Installments": 1,
    "Capture": true,
    "CreditCard": {
      "CardToken": "4086baad-a31c-48b9-830d-8596bfe9c33c",
      "Brand": "Visa",
      "SecurityCode": "123",
    },
    "ProofOfSale": "3827556",
    "Tid": "0504043827555",
    "AuthorizationCode": "149867",
    "PaymentId": "737a8d9a-88fe-4f74-931f-acf81149f4a0",
    "Type": "CreditCard",
    "Amount": 1500,
    "Currency": "BRL",
    "Country": "BRA",
    "Provider": "Simulado",
    "ExtraDataCollection": [],
    "Status": 1,
    "ReturnCode": "4",
    "ReturnMessage": "Operation Successful",
    "RecurrentPayment": {
      "RecurrentPaymentId": "61e5bd30-ec11-44b3-ba0a-56fbbc8274c5",
      "NextRecurrency": "2025-03-04",
      "EndDate": "2030-12-01",
      "Interval": "Monthly",
      "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": "void",
        "Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/sales/{PaymentId}/void"
      }
    ]
  }
}