Pagamentos Recorrentes

Suggest Edits

O Pagamento Recorrente PagBank permite que você faça cobranças de forma automática, no valor e intervalo que escolher por meio da criação de planos. É possível gerenciar mensalidades, assinaturas, contas de assinantes e cobranças recorrentes, podendo ser utilizado para assinaturas de produtos e/ou serviços em seus mais variados setores.

O Pagamento Recorrente é um conjunto de serviços interconectados que constituem o Pagamento Recorrente PagBank. Esses serviços abrangem entidades centrais, como planos, assinantes e assinaturas, e também incluem elementos secundários, como cupons e pagamentos.

👍

Interface do usuário

Além das APIs o produto também conta com uma interface do usuário para melhorar a gestão dos planos, assinaturas e assinantes. Essa interface está em constante evolução para melhorar a sua experiência.

Como os Pagamentos Recorrentes PagBank funcionam

O processo básico de utilização dos serviços do Pagamentos Recorrentes PagBank envolvem 4 passos principais:

  1. Acesse o Painel de assinaturas do PagBank para autorizar cobranças.
  2. Crie sua chave pública para utilizar os endpoints da API.
  3. Crie um plano de assinaturas utilizando o endpoint Criar plano da API de Assinaturas.
  4. Crie um novo cliente utilizando o endpoint Criar assinante.
  5. O último passo é criar uma assinatura usando o endpoint Criar assinatura. Dessa forma, o assinante e o plano são conectados através de seus respectivos IDs, resultando em uma assinatura.

Com os 4 passos acima, você já conseguirá fornecer aos seus clientes planos de pagamentos recorrentes.

📘

Como integrar com a API de Pagamento Recorrente?

Para integrar com a API de Pagamento Recorrente no ambiente de produção, é necessário entrar em contato com o time de Integrações do PagBank para liberação da conta. Após a liberação é só seguir o passo a passo na aba de autenticação.

Serviços da API de Pagamento Recorrente

A API de Pagamentos Recorrentes do PagBank disponibilizada por meio de grupos de endpoints. Cada grupo cobre funções específicas associadas ao processo de pagamentos recorrentes. Abaixo você encontra a lista desses grupos de serviços:

  • Criptografia e chave pública: para utilizar os serviços do sistema de Pagamentos Recorrentes você irá utilizar chaves públicas. Esse recurso é utilizado em outras APIs do PagBank. No entanto, para os pagamentos recorrentes você utilizará chaves públicas exclusivas desse serviço. Além disso, você pode criptografar seus cartões para garantir maior segurança para os seus usuários.
  • Planos: um plano contém as configurações que uma assinatura vai seguir, como valor e intervalo de cobrança. Através desse serviço, você consegue gerenciar todos os processos relacionados aos seus planos.
  • Assinantes: para criar uma assinatura, você precisa cadastrar um assinante com os dados de pagamento. Através do serviço de assinantes, você cria e gere os seus clientes recorrentes.
  • Assinaturas: uma assinatura permite a cobrança recorrente de um cliente (assinante) de forma automática e simples. Para criar uma assinatura, basta informar o plano, o cliente da assinatura e um identificador para ela. Se quiser, é possível criar o cliente e seus dados de pagamento com a assinatura. Todo esse gerenciamento é feito através do serviço de Assinaturas.
  • Cupons: você pode criar cupons de descontos para oferecer aos assinantes. Os cupons podem dar descontos de valores inteiros ou percentuais, e podem ter data de vencimento ou limite de assinaturas.
  • Pagamentos: o serviço de Pagamentos possibilita que você realize consulta sobre o status dos pagamentos dos assinantes e crie estornos quando necessário.
  • Retentativa automática: no caso de uma fatura ter seu pagamento negado é possível fazer novas tentativas de cobrança de pagamento automaticamente através da configuração do sistema.
  • Preferências de notificação: possibilita que você pode altere as preferências de notificação por meio de uma requisição via API. As configurações que podem ser alteradas são envio de e-mails ao vendedor, envio de e-mails ao assinante e URL de notificação.

📘

Autenticação

Para utilizar os serviços da API de Pagamentos Recorrentes você precisa estar autenticado. Acesse a página de Autenticação para maiores informações.

Objetos da API de Pagamentos Recorrentes

A API de Pagamentos Recorrentes utiliza os objetos Plano, Assinante, Assinatura e Cupom. Para identificar todos os parâmetros, seus respectivos tipos e exemplos de cada parâmetro de cada objeto, acesse as páginas de cada objeto.

Teste sua integração

A API de Pagamentos recorrentes do PagBank conta com dados específicos para realizar testes durante a integração. Acesse Testar sua integração para utilizar os dados de teste.

Webhooks

O PagBank disponibiliza webhooks para que você seja notificado sempre que uma atualização ocorra. Acesse Webhooks para ter mais informações dos eventos que possuem notificações automáticas e como configurá-las.

Erros

Os erros relacionados à requisição aos endpoints da API de Pagamentos Recorrentes estão normalmente associados ao fornecimento de parâmetros incorretos ou falta de autenticação. Para te auxiliar a entender os problemas ao executar as requisições, você pode acessar a página Códigos de erro, que lista os códigos que você pode receber e provê detalhes adicionais para cada erro.

Updated 2 months ago