Fluxo básico
Criação do Plano
O primeiro passo para criar adesões é criar um plano. Os planos criados podem ser visualizados no seu Painel.
Os planos personalizados permitem que não seja informado o campo amountPerPayment que informa o valor a ser cobrado na recorrência. Essa configuração permite que sejam realizadas chamadas de cobrança de valores variáveis.
Nos planos personalizados, a responsabilidade de fazer o pedido de cobrança é do vendedor. Caso não haja condições de adequar seu sistema para enviar a chamada ao serviço de cobrança nos momentos corretos, opte pelo plano Automático, (charge = AUTO). Para mais informações veja sobre as Regras de Planos em Especificações Funcionais.
O parâmetro de status, pode ser visto na Tabelas de Status e Erros.
Adesão ao plano
A adesão é o mecanismo que une o consumidor ao plano, possibilitando que ele faça os pagamentos de forma recorrente, de acordo com o que foi estipulado no plano ao qual ele está aderindo.
Note que você irá precisar do token de cartão gerado tópico de Integrações no Browser em Endpoints da API.
Para criar uma adesão utilize o método /pre-approvals
O método retorna o código da adesão. Guarde-o para cada adesão efetuada, pois ele será necessário para referenciá-las nos métodos que estão documentados a seguir.
As adesões podem ser visualizadas no seu Painel.
Cobrança do plano
Cobrança de plano Automático
A cobrança de planos automáticos é efetuada pelo PagSeguro na periodicidade configurada na criação do plano, não necessitando realizar nenhuma chamada ao método.
Cobrança de plano Personalizado
Na data estipulada para cobrança, deve ser feita uma chamada a este serviço. Qualquer chamada que esteja divergente das configurações do plano no qual a cobrança será efetuada - por exemplo, na data errada ou com outro valor - será recusada.
Para efetuar uma cobrança personalizada, utilize o método /pre-approvals/payment.
O método retorna o código da transação de cobrança efetuada.
Caso o plano personalizado tenha sido criado sem valor pré-configurado, é necessário enviar também o parâmetro valor. Esta funcionalidade permite que o valor seja variável para cada cobrança.
O PagSeguro não verifica se a cobrança da recorrência já foi feita para determinada vigência do plano. Se a aplicação enviar uma mesma cobrança duas vezes, a recorrência será cobrada em duplicidade. Esta verificação deverá existir na aplicação do vendedor. A não ser que o valor máximo de cobrança do período seja ultrapassado (amount).
Updated almost 4 years ago