Sobre a Recorrência
O que é a recorrência?
A recorrência é um modelo de cobrança periódica, geralmente mensal, e usada para serviços ou produtos programados/contínuos, como serviços de streaming, assinaturas e mensalidades para cobrar seus clientes de forma mais prática.
Qual é o impacto do uso no meu negócio?
Ao usar a recorrência, a loja tem a facilidade de gerar cobranças periódicas sem a necessidade do portador do cartão participar do processo mais do que uma vez. Com isso, a recorrência pode aumentar a conversão.
Como usar a recorrência?
Existem dois tipos de recorrência:
- Recorrência própria: o controle de envio da recorrência é responsabilidade da loja, que deve enviar a transação recorrente nas datas acordadas com o comprador. As transações enviadas pela loja precisam ter a marcação de recorrência.
- Recorrência programada Cielo: a loja envia os detalhes de cobrança, período (mensal, semestral, anual etc) e a data de final de recorrência. Com estas informações, a Cielo cria a recorrência e o valor da transação será cobrado na periodicidade escolhida até a data final;
Saiba mais sobre Recorrência Própria e Recorrência Programada.
Solicite a habilitação da funcionalidade para Suporte E-commerce.
O que não fazer?
- Não envie a primeira transação da recorrência sem o CVV ou o
CardOnFile
: a primeira transação da recorrência deve obrigatoriamente informar o CVV ou oCardOnFile
; - Não envie a transação com a função parcelada (mais de uma parcela) e recorrente ao mesmo tempo;
- Não envie pedidos recorrentes sem a marcação de recorrência (
Payment.Recurrent
para recorrência própria eRecurrentPayment
para recorrência programada); - Não envie uma transação recorrente usando cartão inválido: sempre valide o cartão no Zero Auth antes de criar a recorrência.
Importante
O motor de recorrência Cielo possui configurações de retentativas, podendo reprocessar transações negadas (exceto as irreversíveis) já considerando as regras do Programa de Retentativa das Bandeiras.
Tipos de recorrências
A API E-commerce Cielo funciona com dois tipos de recorrências que possuem comportamentos diferentes:
- Recorrência Própria: quando a loja cria a própria inteligência de repetição de compra e armazena os dados do cartão;
- Recorrência Programada: quando a Cielo é responsável pela inteligência da repetição e armazenamento dos dados do cartão.
Recorrência Própria
Nesse modelo, a loja é responsável por criar a inteligência necessária para:
Inteligência | Descrição |
---|---|
Salvar os dados da transação | A loja precisará armazenar a transação e dados do pagamento. |
Criar repetição transacional | A loja deverá enviar uma nova transação sempre que necessitar de uma autorização. |
Comportamento para transação negada | Caso uma das transações seja negada, caberá a loja a decisão de retentar uma nova autorização. |
A recorrência própria é uma transação padrão para a Cielo; a única diferença é a necessidade de enviar um parâmetro adicional que a define como Recorrência Própria:
Parâmetro:
Payment.Recurrent
= "true".
Caso de uso
Este é um exemplo de como a API E-commerce Cielo permite a utilização de sistemas externos de recorrência em suas transações.
A recorrência própria é uma configuração da API E-commerce Cielo que permite que uma loja use um sistema de recorrência interno específico às suas necessidades de negócio.
Nesse modelo, o sistema da loja é encarregado por definir o período, os dados transacionais e, quando necessário, nos enviar a transação de recorrência.
Recorrência Própria + Cartão Tokenizado
A academia CleverFit possui um sistema de cobrança diferenciado onde a matrícula é cobrada quinzenalmente, mas nunca nos fins de semana.
Por ser um modelo altamente customizado, a CleverFit possui um sistema de recorrência própria, utilizando a API E-commerce Cielo via dois mecanismos:
- Recorrência Própria: a CleverFit envia os dados da transação como uma venda normal, mas a API identifica que é uma recorrência e aplica regras de autorização diferenciada ao pedido;
- Cartão Tokenizado: a CleverFit mantém os cartões salvos de forma tokenizada na Cielo, de acordo com as regras de segurança, evitando armazenar dados de cartões em seu sistema.
A CleverFit envia a transação quinzenalmente para a API E-commerce Cielo, usando os tokens salvos na própria API e optando pela Recorrência Própria, que altera a regra de autorização para se adequar ao seu modelo de cobrança.
Recorrência Programada
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 uma transação base que, ao ser enviada para a API E-commerce Cielo, será salva e executada seguindo as regras definidas pela loja.
Para saber mais sobre a configuração de uma recorrência programada, acesse o manual Configurando a Recorrência.
Nesse modelo, a API realiza e permite:
Vantagens | Descrição |
---|---|
Salvar dados transacionais | Salva dados da transação, criando assim 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 da loja. |
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). |
A Recorrência Programada possui dois fluxos de requisição; a diferença está no parâmetro AuthorizeNow
.
Quando a primeira transação deve ser autorizada no momento do agendamento, envie AuthorizeNow
como "true".
*Se o Post de Notificação estiver configurado pela loja.
Quando a primeira transação deve ser autorizada em momento posterior ao agendamento, envie AuthorizeNow
como "false"; nesse caso, envie também o parâmetro StartDate
.
*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.
Veja o exemplo do trecho com o nó RecurrentPayment
, que deve ser inserido numa transação de crédito.
"RecurrentPayment":
{
"AuthorizeNow":"False",
"StartDate":"2019-06-01"
"EndDate":"2019-12-01",
"Interval":"SemiAnnual"
}
Podemos definir os dados como:
Paramêtros | Descrição |
---|---|
AuthorizeNow | Define qual o momento que uma recorrência será criada. Se for enviado como "true", ela é criada no momento da autorização; se "false", a recorrência ficará suspensa até a data escolhida para ser iniciada (StartDate ). |
StartDate | Define a data que transação da Recorrência Programada será autorizada. |
EndDate | Define a data que a Recorrência Programada será encerrada. Se não for enviada, a recorrência será executada até ser cancelada pela loja. |
Interval | Intervalo da recorrência. Monthly - Mensal; Bimonthly - Bimestral; Quarterly - Trimestral; SemiAnnual - Semestral; Annual - Anual. |
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.
Características importantes da Recorrência Programada:
Informação | Descrição |
---|---|
Criação | A primeira transação é chamada de "Transação de agendamento". Todas as transações posteriores serão cópias dessa primeira transação. Ela não precisa ser capturada para que a recorrência seja criada, basta ser AUTORIZADA. |
Captura | Transações de Recorrência Programada não precisam ser capturadas. Após a primeira transação, todas as transações de recorrência são capturadas automaticamente pela API. |
Identificação | Transações de Recorrência Programada geram dois tipos de identificação:PaymentId : identifica uma transação. É o mesmo identificador das outras transações na API.RecurrentPaymentId : identifica pedido de recorrência. Um RecurrentPaymentId possui inúmeros PaymentId s vinculados a ele. Essa é a variável usada para cancelar uma Recorrência Programada. |
Consulta | Para consultar, basta usar um dos dois tipos de identificação:PaymentId : Utilizada para consultar UMA TRANSAÇÃO DENTRO DA RECORRÊNCIA.RecurrentPaymentId : Utilizado para consultar A RECORRÊNCIA. |
Cancelamento | Uma Recorrência Programada pode ser cancelada de duas maneiras: Lojista: Solicita o cancelamento da recorrência. Não cancela transações já finalizadas antes da ordem de cancelamento da recorrência. Por cartão invalido: Caso a API identifique que um cartão salvo está inválido (ex.: expirado) a recorrência será cancelada e não se repetirá, até que a loja atualize o meio de pagamento. OBS: Cancelamento de transações dentro da recorrência não encerra o agendamento de transações futuras. Somente o Cancelamento usando o RecurrentPaymentId encerra agendamentos futuros. |
Estrutura de um RecurrentPaymentId
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.
A Recorrência Programada Cielo tem as seguintes características:
- Intervalos programados: mensal, bimestral, trimestral, semestral e anual;
- Data de validade: permite definir se a recorrência tem data para acabar;
- Retentativa: se uma transação for negada, vamos retentar a transação até quatro vezes;
- Atualização: permite alterar dados da recorrência, como valor e intervalo.
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?
- Facilidade: a cobrança de mensalidade é automática, logo o MusicFy não precisa se preocupar em construir um sistema de cobrança;
- 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;
- Segurança: a MusicFy não precisa armazenar dados sensíveis do cartão e do comprador;
- 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.
Updated 2 months ago