Criar pagamento recorrente

post https://apisandbox.cieloecommerce.cielo.com.br/1/sales/

Cria um pagamento recorrente de cartão de crédito na modalidade Recorrência Programada.

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/`

ℹ️
Saiba mais sobre essa funcionalidade na documentação.
Para recorrência programada, envie AuthorizeNow como true.

Orientações para criar transação recorrente em sandbox:

O cartão precisa ser final 0, 1 ou 4;
O cartão precisa ser válido no mod10 (Algoritmo de Luhn), uma vez que a transação recorrente armazena o cartão de forma tokenizada.

⚠️
Identificação de transações oriundas de link de pagamento para cartões da bandeira Elo
A partir de 17 de outubro de 2025 será obrigatório identificar transações oriundas de link de pagamento para cartões da bandeira Elo. Envie o parâmetro Payment.SolutionType = "ExternalLinkPay".

Resposta da transação de cartão de crédito recorrente

A tabela a seguir apresenta os principais parâmetros que podem ser retornados pela API na criação de um pagamento com cartão de crédito com recorrência. A resposta também irá conter os dados informados na criação do pagamento recorrente.

Propriedade	Descrição	Tipo	Tamanho
`ProofOfSale`	Número da autorização, idêntico ao NSU.	string	6
`Tid`	Identificador da transação na adquirente.	string	20
`AuthorizationCode`	Código de autorização.	string	6
`PaymentId`	Número de identificação do pagamento. O `PaymentId` será usado em futuras operações como consulta, captura e cancelamento.	GUID	36
`Status`	Status da Transação. Veja a tabela completa de Status transacional	byte
`ReturnCode`	Código de retorno.	string	32
`ReturnMessage`	Mensagem de retorno.	string	512
`Payment.MerchantAdviceCode`	Código de retorno da bandeira que define período para retentativa. Válido somente para bandeira Mastercard. Saiba mais Programa de retentativa das bandeiras para Mastercard	string	2
`Payment.CreditCard.PaymentAccountReference`	O PAR (Payment Account Reference) é o número que associa diferentes tokens a um mesmo cartão. Será retornado pelas bandeiras Master e Visa e repassado para os clientes do e-commerce Cielo. Caso a bandeira não envie a informação, o campo não será retornado.	string	29
`RecurrentPaymentId`	Campo Identificador da próxima recorrência.	GUID	36
`NextRecurrency`	Data da próxima recorrência.	string	7
`EndDate`	Data de término da recorrência.	string	7
`Interval`	Intervalo entre as recorrências.	integer	10
`AuthorizeNow`	Define se a primeira recorrência já irá ser autorizada ou não. Caso deseje autorizar uma recorrência posteriormente, veja como Agendar uma recorrência.	boolean
`CardBrandStatus`	Retorno de status da conta Mastercard VALID: Cartão Valido ou sem atualizações na base; UNKNOWN: Cartão não está disponível na ABU; NON_PARTICIPATING: Cartão não está disponível na ABU; ACCOUNT_CLOSED: Cartão está encerrado; UPDATE: Atualização de plástico ou validade; EXPIRY: Atualização da validade; ERROR: Houve algum erro na atualização (ex: timeout). Saiba mais na documentação	string

Campos retornados pelo Renova Fácil

Caso a loja tenha o Renova Fácil ou o ABU habilitado, e exista um novo cartão disponível, os dados atualizados serão retornados no nó NewCard da resposta.

Propriedade	Descrição	Tipo	Tamanho
`NewCard.CardNumber`	Novo número do cartão do comprador.	string	16
`NewCard.ExpirationDate`	Nova data de validade do cartão.	string	7
`NewCard.Brand`	Bandeira do cartão.	string	10
`NewCard.SaveCard`	Identifica se o cartão gerou `Cardtoken` durante a transação. Saiba mais sobre Tokenização	booleano

Language

Click Try It! to start a request and see the response here!