Recorrência Programada Cielo

Nesse modelo, a Cielo é a responsável por executar uma recorrência de maneira automática.

A Recorrência Programada permite que a loja crie a primeira transação, e ao mesmo tempo informe as regras de recorrência (repetição) para as próximas transações, como data final e intervalo da cobrança.

É possível autorizar a primeira transação no momento da criação da recorrência ou agendar uma série de recorrências.

Na Recorrência Programada, a API E-commerce Cielo será responsável por:

• Salvar dados transacionais: salva dados da transação, criando um modelo de como serão as próximas recorrências;
• Automatizar a recorrência: sem atuação da loja, a API cria as transações futuras de acordo com as definições informadas;
• Atualizar dados : caso necessário, a API permite modificações das informações da transação (como dados do comprador) ou do ciclo de recorrência (como data e intervalo).

ℹ️

Veja como habilitar e configurar a Recorrência Programada Cielo.

Características da Recorrência Programada

• Intervalos programados: mensal, bimestral, trimestral, semestral e anual;
• Data final da recorrência: permite definir se a recorrência tem data para acabar;
• Retentativa: se uma transação for negada, a API pode retentar a aprovação da transação até quatro vezes (conforme a configuração feita no site Cielo);
• Atualização: permite alterar dados da recorrência, como dados do comprador, valor, dia, intervalo e outros. Também é possível desativar e reativar um pagamento recorrente.

A Recorrência Programada possui dois fluxos de requisição; a diferença está no parâmetro AuthorizeNow.

Criando a recorrência e aprovando a primeira transação

Quando a primeira transação deve ser autorizada no momento do agendamento, envieAuthorizeNow como "true".

"RecurrentPayment":
{
       "AuthorizeNow":"true",
       "EndDate":"2030-12-01",
       "Interval":"Monthly"
}

*Se o Post de Notificação estiver configurado pela loja.

Agendando uma recorrência

Quando a primeira transação deve ser autorizada em momento posterior ao agendamento, envieAuthorizeNow como "false"; nesse caso, envie também o parâmetro StartDate, que representa a data de início da recorrência.

"RecurrentPayment":
{
       "AuthorizeNow":"false",
       "StartDate":"2024-06-01"
       "EndDate":"2030-12-01",
       "Interval":"Monthly"
}

*A transação de agendamento precisa do nó RecurrentPayment, da data da transação e do campo AuthorizeNow = "false".
**Se o Post de Notificação estiver configurado pela loja.

Quando uma transação é enviada à API E-commerce Cielo com o nó de Recorrência Programada (RecurrentPayment), o processo de recorrência passa a ser efetivo quando a transação é considerada autorizada. Desse ponto em diante, a transação passará a ocorrer dentro do intervalo definido pela loja.

Como funciona

Momento do agendamento e captura

Estrutura de um RecurrentPaymentId

Uma série de recorrências é identificada pelo RecurrentPaymentId, e cada transação da recorrência será identificada pelo próprio PaymentId.

Caso de uso

Este é um exemplo de como usar as recorrências da API E-commerce Cielo para elevar suas vendas.

A recorrência é o processo de salvar uma transação e repeti-la em um intervalo de tempo pré-definido. É ideal para modelo de assinaturas.

Recorrência mensal e anual

A empresa Musicfy oferece um serviço de assinatura online no qual seus clientes pagam para poderem acessar uma biblioteca de músicas e ouví-las via streaming.

Para captar o máximo de clientes, eles oferecem duas maneiras de pagamento:

• Mensal, por R$19,90;
• Anual (com desconto); por R$180,00.

Como eles executam a cobrança mensal ou anual de seus clientes?

A MusicFy utiliza a Recorrência Programada da API E-commerce Cielo.

Ao criar uma transação, o Musicfy informa que o pedido em questão deve se repetir mensalmente ou anualmente e que não há data de término para a cobrança.

Quais as vantagens de usar a recorrência programada para o MusicFy?

1. Facilidade: a cobrança de mensalidade é automática, logo o MusicFy não precisa se preocupar em construir um sistema de cobrança;
2. Usabilidade: o valor das assinaturas pode ser atualizado sem a necessidade de refazer a transação. Um mês pode ser cancelado ou a recorrência pode ter um delay (o modelo de 30 dias gratuito) com apenas uma configuração;
3. Segurança: a MusicFy não precisa armazenar dados sensíveis do cartão e do comprador;
4. Conversão: a Recorrência Programada Cielo possui um sistema de retentativa automática. Caso uma das transações seja negada, ela será retentada até quatro vezes, buscando atingir a autorização.

O que acontece se uma transação recorrente for negada?

Na Recorrência Programada, dependendo do motivo de recusa de uma transação recorrente, a API E-commerce irá realizar a retentativa, reenviando a transação para aprovação.

É possível deixar até quatro retentativas habilitadas de forma automática pelo site Cielo.

ℹ️

Saiba mais sobre a configuração de uma recorrência programada em Configurando a Recorrência.