Recorrência com Pix Automático

O que é o Pix Automático?

O Pix Automático é a nova solução do Banco Central que permite o pagamento de cobranças recorrentes via Pix. O Pix Automático é indicado para pagamentos que se repetem em um determinado período, como:

• Contas de consumo, como água ou luz;
• Assinatura de plataformas de streaming;
• Mensalidades de escolas, academias etc.

Quando a pessoa que está comprando autoriza uma cobrança de Pix Automático, a loja pode fazer cobranças periódicas diretamente na conta da pessoa pagadora, sem a necessidade de apresentar um novo QR Code a cada transação.

Benefícios

O estabelecimento que oferece o Pix Automático como forma de pagamento tem como benefícios:

• Praticidade na autorização e gestão das cobranças;
• Recebimento em segundos;
• Redução no custo com emissão de boletos.

Além disso, não há cobrança de tarifas para a pessoa que está comprando.

Pré-requisitos para o Pix Automático no e-commerce Cielo

Há três condições que precisam ser cumpridas para o estabelecimento usar o Pix Automático pelo Gateway de Pagamento:

1. Usar a nova integração Pix (Payment.Provider = “Cielo2”);
2. Configurar o Post de Notificação (webhook) para receber as notificações de atualização de status da transação e da recorrência;
3. Criar o QR Code Pix e enviar as cobranças recorrentes: a criação das transações subsequentes cobranças recorrentes) é responsabilidade do estabelecimento (recorrência própria)*.

Como funciona?

O processo é dividido em três etapas principais:

1. Criação da recorrência: a loja gera um QR Code com os dados da autorização e, opcionalmente, um pagamento inicial;
2. Autorização do cliente: o comprador lê o QR Code e autoriza a recorrência no aplicativo do banco;
3. Cobranças recorrentes: a loja envia as cobranças conforme o intervalo definido, sem necessidade de nova interação do comprador.

Caso uma das cobranças não seja paga, é possível retentar uma cobrança até três vezes em sete dias.

ℹ️

As regras do Pix Automático seguem as especificações do Banco Central do Brasil.

Jornadas de autorização

O Gateway de Pagamento oferece duas jornadas de autorização possíveis para o Pix Automático. A loja deverá determinar qual jornada irá aplicar para cada venda:

• Criar QR Code para autorização de Pix Automático: nessa opção, o comprador irá ler o QR Code para confirmar a autorização de uma série de cobranças de Pix Automático para o futuro. Não há cobrança nesse momento. Esta é a Jornada 2 indicada pelo Banco Central do Brasil.

ou

• Criar QR Code para autorização e pagamento de Pix Automático: nessa opção, o comprador irá ler o QR Code, realizar o pagamento imediato da primeira cobrança e confirmar a autorização para uma série de cobranças de Pix Automático para o futuro. Esta é a Jornada 3 indicada pelo Banco Central do Brasil.

Criar QR Code para autorização de Pix Automático (jornada 2)

Quando há apenas a autorização do Pix Automático, é necessário indicar que não haverá cobrança no momento da criação do QR Code com Payment.RecurrentPayment.AuthorizeNow = false.

Quando usar:

• Quando a cobrança será iniciada em uma data futura;
• Quando o comprador precisa apenas autorizar a recorrência, sem realizar pagamento imediato da recorrência.

Etapa: criação do QR Code

1. O comprador (usuário pagador) escolhe pagar uma cobrança recorrente com Pix Automático;

2. A loja solicita a criação do QR Code do Pix Automático para o Gateway de Pagamento;

3. O Gateway de Pagamento retorna o QR Code composto para autorização do Pix Automático;

4. A loja exibe o QR Code composto para o comprador;

Etapa: autorização

5. O comprador lê o QR Code no aplicativo do banco (ou Pix copia-e-cola) e autoriza a recorrência por Pix Automático;

6. O banco retorna o status da autorização da recorrência para o Gateway de Pagamento via ecossistema Pix;

7. O Gateway de Pagamento envia a notificação de status da autorização da recorrência pelo webhook;

Etapa: criação da cobrança recorrente

8. A loja envia a requisição de criação da cobrança recorrente para o Gateway de Pagamento;

9. O Gateway de Pagamento retorna resposta da cobrança recorrente;

Etapa: envio da retentativa

10. Se a cobrança tiver sido negada, a loja envia a retentativa para o Gateway de Pagamento (até três retentativas no período de sete dias);

11. O Gateway de Pagamento retorna a resposta da retentativa.

Criar QR Code para autorização de Pix Automático com pagamento imediato (jornada 3)

Para indicar que a primeira cobrança será realizada no momento da criação do QR Code envie Payment.RecurrentPayment.AuthorizeNow = true.

Quando usar

• Quando o uso do serviço ou produto começa imediatamente;
• Quando o primeiro pagamento precisa ocorrer no ato da contratação;
• Quando há uma cobrança inicial, como taxa de matrícula.

Etapa: criação do QR Code

1. O comprador (usuário pagador) escolhe pagar uma cobrança recorrente com Pix Automático;

2. A loja solicita a criação do QR Code do Pix Automático para o Gateway de Pagamento;

3. O Gateway de Pagamento retorna o QR Code composto para autorização do Pix Automático;

4. A loja exibe o QR Code composto para o comprador;

Etapa: autorização

5. O comprador lê o QR Code no aplicativo do banco (ou Pix copia-e-cola) e autoriza a recorrência por Pix Automático;

6. O banco retorna o status da autorização da recorrência para o Gateway de Pagamento via ecossistema Pix;

7. O Gateway de Pagamento envia a notificação de status da autorização da recorrência e a notificação de status da transação* pelo webhook;

Etapa: criação da cobrança recorrente

8. A loja envia a requisição de criação da cobrança recorrente para o Gateway de Pagamento;

9. O Gateway de Pagamento retorna resposta da cobrança recorrente;

Etapa: envio da retentativa

10. Se a cobrança tiver sido negada, a loja envia a retentativa para o Gateway de Pagamento (até três retentativas no período de sete dias);

11. O Gateway de Pagamento retorna a resposta da retentativa.

*A notificação de status da recorrência irá exibir o status da recorrência na própria notificação. A notificação de mudança de status da transação exibe apenas o PaymentId e informa que houve uma mudança de status pelo ChangeType. É necessário fazer uma consulta por PaymentId para verificar todos os detalhes e o novo status da transação.

Papéis da pessoa compradora e do estabelecimento recebedor

A pessoa que está comprando pode:

• Definir o valor máximo da cobrança;
• Usar linha de crédito;
• Receber notificações de agendamento;
• Consultar e cancelar autorizações de cobranças;
• Consultar histórico de cobranças autorizadas;
• Consultar e cancelar cobranças futuras agendadas.

Usando a API do Gateway de Pagamento, o estabelecimento recebedor pode:

• Criar, consultar e cancelar uma cobrança associada à uma recorrência;
• Realizar a retentativa de transações negadas;
• Receber notificações da recorrência.

Status e notificações do Pix Automático

É necessário que o estabelecimento cadastre a URL de notificação para configuração do webhook. Quando houver uma alteração no status da recorrência ou da transação de Pix, a Cielo irá enviar uma notificação.

Status de cada etapa da jornada com Pix Automático

O Pix Automático no e-commerce Cielo pode ter dois tipos de status, o primeiro é referente à transação e o segundo é referente à recorrência.

Confira a seguir os status esperados para a transação e para a recorrência em cada etapa do fluxo de Pix Automático:

Jornada 2

A jornada 2 corresponde à criação de QR Code para autorização de Pix Automático:

Jornada 3

A jornada 3 corresponde à criação de QR Code para autorização de Pix Automático com pagamento imediato:

Status da recorrência por Pix Automático

A atualização do status da recorrência é informado na notificação segundo o modelo:

{
    "RecurrenceId": "310ad23f-af11-4ebd-b8d5-98c12ee5f4gh",
    "ChangeType": 26,
    "Status": 2
}

Onde:

• RecurrenceId é o identificador da recorrência retornado na criação do QR Code das jornadas 2 e 3;
• ChangeType é o tipo da atualização. O ChangeType igual à 26 corresponde à atualização do status da recorrência;
• Status é o valor correspondente ao status da recorrência. Confira a tabela a seguir:

ℹ️

Importante

A notificação de status da transação apenas apresenta o PaymentId e informa o ChangeType. Para saber mais detalhes sobre o status da transação, é necessário fazer uma Consulta por PaymentId .

Saiba mais sobre o webhook em Post de Notificação

Operações da API

Acesse as páginas de cada operação da API para mais detalhes da integração:

Tratamento de erros

Confira os principais retornos e como tratá-los em Tratamento de erros para o Pix Automático.