These docs are for v1.0. Click to read the latest docs for v4.1.


Nesta documentação você verá os seguintes itens:

[Como Funciona <i class="icon-link"></i>](🔗) [Modalidades de Cobrança <i class="icon-link"></i>](🔗) [Retentativa de Pagamento <i class="icon-link"></i>](🔗)

<a name="como-funciona"></a>

## Como Funciona

Com o Pagamento Recorrente você cria um plano, definindo as regras de cobrança, periodicidade, valor, entre outros. Com o plano criado, sua aplicação registra os compradores para serem cobrados no plano desejado.

Por exemplo, se o plano for mensal, seu cliente irá realizar a adesão somente uma vez e ele será cobrado mensalmente sem precisar realizar nenhuma outra ação. Além disso, você pode definir desconto para a próxima cobrança, listar pagamentos de um plano, efetuar a retentativa de pagamento para cartões de crédito que falharam no momento da cobrança, mudar o status de uma adesão (suspender ou reativar) e também trocar o seu meio de pagamento.

<a name="modalidades-de-cobranca"></a>

## Modalidades de Cobrança

O PagSeguro possui 2 modalidades de cobrança:

  • Plano Automático

  • Plano Personalizado

### Plano Automático - Gestão da Recorrência via PagSeguro

Nesta modalidade, você define a periodicidade e detalhes de cobrança, e o PagSeguro se encarrega de efetuar todas as cobranças nas datas especificadas.



Para planos automáticos aceitamos apenas cartão de crédito como meio de pagamento.

**Fluxo básico da recorrência automática:**

  • Cliente adere ao plano e informa dados do cartão de crédito

  • PagSeguro efetua transação de cartão no valor da parcela do plano

  • Primeira cobrança da vigência do plano é criada

  • Plano de recorrência fica ativo para o cliente

  • Após o período de vigência, o PagSeguro irá realizar nova cobrança no cartão do cliente automaticamente.

1528


Para auxiliar sua gestão de cobranças, você poderá implementar a consulta de ordens de pagamento por meio do serviço [Listar ordens de pagamento](🔗). Por meio deste serviço é possível consultar o status de pagamento de cada ordem (parcela).

### Plano Personalizado – Gestão da Recorrência via Vendedor

Nesta modalidade, o PagSeguro não efetua a gestão da recorrência. Portanto, nas datas definidas no plano, a sua aplicação deverá fazer uma chamada ao serviço de solicitação de pagamento para realizar a cobrança, ou seja, a cada período estabelecido, o vendedor deverá fazer as chamadas de cobrança para o PagSeguro.

**Fluxo básico da recorrência personalizada:**

  • Cliente adere ao plano e informa dados cartão de crédito

  • PagSeguro efetua transação validadora (no valor de R$ 1,50) apenas para verificar a validade do cartão

  • Transação validadora é estornada

  • Plano de recorrência fica ativo para o cliente

  • Aplicação do vendedor realizada chamada ao serviço de cobrança nas datas de renovação de pagamento.

1528


Para auxiliar sua gestão de cobranças, você poderá implementar a consulta de ordens de pagamento por meio do serviço [Listar ordens de pagamento](🔗). Por meio deste serviço é possível consultar o status de pagamento de cada ordem (parcela).

<a name="retentativa-de-pagamento"></a>

## Retentativa de Pagamento

O PagSeguro possibilita que transações sem sucesso sejam submetidas a retentativa de pagamento. Dessa forma, antes de recorrer a outras formas de pagamento, você pode tentar novamente a cobrança no cartão de crédito de seus clientes.

Existem três formas de retentativa de pagamento. E essas são distintas para Planos Automáticos e Planos Personalizados, veja abaixo.

**a) Retentativa Automática - Válida apenas para planos automáticos**

Para cobranças sem sucesso por motivo que não sejam cartão cancelado ou vencido, como por exemplo limite de crédito excedido, o PagSeguro poderá realizar uma única retentativa após 3 dias da não aprovação da transação.

Se esta cobrança falhar novamente, ela permanecerá aberta, ficando a cargo do vendedor tomar medidas.

Essa funcionalidade deve ser habilitada dentro do Painel na página do PagSeguro >> Minha Conta >> Pagamento Recorrente >> <a href="https://pagseguro.uol.com.br/pagamento-recorrente/planos/lista.jhtml" target="_blank">Planos</a>.

**b) Retentativa Manual - Válida para planos automáticos e personalizados**

  • **Botão via Painel:** No Painel, ao acessar o menu Pagamento Recorrente >> <a href="https://pagseguro.uol.com.br/pagamento-recorrente/lista.html" target="_blank">Adesões</a>, caso hajam adesões com pagamento pendente, é exibido um botão para uma listagem de pagamentos pendentes. Ao entrar nesta listagem, um outro botão permite que você submeta as adesões não pagas para a fila de retentativa. O botão fica disponível um dia após a transação não ser aprovada.

Esta fila será processada até 3 vezes sendo retentada uma vez por dia. Após isso, o botão fica indisponível no Painel. Note que a retentativa por botão sobrepõe a retentativa automática.

  • **API**: O serviço de retentativa de pagamento pode ser chamado quantas vezes forem necessárias, porém a cobrança será realizada somente se a ordem de pagamento da adesão estiver com o status “Não Pago”, que sinaliza que já foi realizada uma tentativa de pagamento sem sucesso.

**c) Retentativa por Mudança de Meio de Pagamento - Válido apenas para Planos Automáticos **

Se o cartão estiver vencido ou cancelado durante a renovação da recorrência, a adesão passa para o status "Troca de Meio de Pagamento" (Status M) sinalizando que é necessário que o cliente atualize seu cartão (veja [Mudança de meio de pagamento](🔗)).

Assim quando seu cliente acessar o Painel do PagSeguro e alterar o cartão de uma adesão com status "Troca de Meio de Pagamento", automaticamente é realizada uma retentativa de pagamento para a última cobrança que ficou com pagamento em aberto. Caso esta retentativa tenha sucesso, a adesão retorna ao status Ativo (Status A).

Se houver mais de uma cobrança em aberto, a retentativa irá se aplicar somente à última cobrança. As outras precisarão ser regularizadas à parte, fora do sistema de recorrência.

Se a ordem de pagamento vencer na data atual e seu cliente atualizar o cartão na mesma data, a cobrança será agendada para o dia seguinte. Porém se a ordem já estiver vencida e o cliente atualizar o cartão, a cobrança será agendada para a mesma data.