Overview

ℹ️

Vá para a referência da API para acessar os exemplos completos de requisição e resposta.

Para que você possa usar todos os recursos disponíveis em nossa API, é importante que antes você conheça os conceitos envolvidos no módulo de recorrência.

Modelos de Plano

A Safe2Pay disponibiliza dois modelos de plano para cobrança recorrente, que devem ser escolhidos conforme a necessidade do seu negócio.

Plano Personalizado (PlanOption = 1)

Indicado para modelos flexíveis de cobrança.

Características:

• Permite definir o dia exato da cobrança.
• Frequência disponível: semanal ou mensal.
• Possibilidade de cobrança imediata (IsImmediateCharge = true).
• O valor da cobrança pode ser proporcional ao uso, configurado por você.

📘

Use quando precisar de liberdade para definir a lógica de cobrança de forma dinâmica e ajustável.

Plano Fixo (PlanOption = 2)

Indicado para modelos com periodicidade e valores bem definidos.

Características:

• A primeira cobrança é feita no momento da assinatura.
• Próximas cobranças sempre consideram o dia da assinatura como base.
• Frequência disponível: semanal, mensal, bimestral, trimestral, semestral e anual.
• Não permite definir um dia específico para cobrança.

📘

Use quando quiser manter um ciclo fixo e previsível de pagamentos.

Cobrança Imediata

Quando a configuração IsImmediateCharge estiver como true, a cobrança será realizada no momento da assinatura, com comportamento diferente para cada meio de pagamento:

• Boleto bancário: boleto é gerado e enviado em até 1 hora.
• Cartão de crédito: se o cartão estiver tokenizado e informado na assinatura, a cobrança acontece imediatamente.

📘

Caso você não envie o cartão tokenizado, será gerado um link para tokenização do cartão. Depois da tokenização, a cobrança deve acontecer em até 1h.

Descontos para Boleto Bancário

A configuração de desconto para pagamentos via boleto está disponível apenas para planos do tipo Fixo. Planos Personalizados não suportam essa funcionalidade.

Tabela de frequência da retentativa