Paylogos
  1. GESTÂO DE TRANSAÇÃO E RECEBÍVEIS
Paylogos
  • GUIA DE IMPLEMENTAÇÃO
    • INTRODUÇÃO E ASPECTOS GERAIS
      • Introdução a Paylogos
      • Requisitos de segurança
      • Autenticação
      • Bandeiras aceitas
      • Conta Gráfica Paylogos
      • Webhook
        • Notificações e eventos
        • Webhook com autorização
    • CADASTRO E CREDENCIAMENTO
      • Compradores
    • GESTÂO DE TRANSAÇÃO E RECEBÍVEIS
      • Pagamentos digitais
      • Recebível
      • Pagamentos Recorrentes (Planos e Assinaturas)
      • Recibo
      • Eventos de webhook
      • Dúvidas frequentes (FAQ)
      • Cartão de crédito online
        • Cobrando com cartão de crédito online
        • Coletando dados de cartão
        • Autorização direta de transações
        • Cobrando com o id do customer (customer_id)
        • Cobrando com o id do cartão (card_id)
        • Pré-autorização de transações
        • Parcelando transações
        • Utilizando Data Only
        • Utilizando 3DS MPI
      • Boleto bancário
        • Cobrando com boleto bancário
        • Layout boleto
        • Gerando um boleto
        • Multa, juros e descontos
      • PIX
        • Cobrando com Pix online
        • Pix online
        • Preparando o seller para oferta do Pix online
        • Criando uma transação Pix online
        • Regras de Payout Pix online
      • Cancelamentos e Extornos
        • Cancelando transações cartão
        • Solicitação de cancelamento e estorno de boletos
        • Estorno da transação Pix
    • REPASSES E TRANSFERÊNCIAS
      • Transferência
      • Política de recebimento
      • Saldo de conta
      • Eventos de webhook
      • Dúvidas frequentes (FAQ)
  • REFERÊNCIAS DE API
    • INTRODUÇÃO E ASPECTOS GERAIS
      • Introdução
      • Requisitos de segurança
      • Autenticação
      • Testando
      • Códigos de erro
    • CADASTRO E CREDENCIAMENTO
      • Compradores
        • Criar comprador
        • Listar compradores
        • Alterar comprador
        • Recuperar detalhes de comprador por ID
        • Remover comprador por ID
        • Buscar comprador por CPF/CNPJ
    • TOKENIZAÇÃO DE CARTÃO
      • Tokenização de cartão
        • Criar novo token de cartão
    • GESTÃO DE TRANSAÇÕES E RECEBÍVEIS
      • Gestão de cartão
        • Associar cartão com comprador
        • Listar detalhes de cartão pelo identificador
        • Remover cartão pelo identificador
      • Transações
        • Criar transação - Autorização Direta
        • Criar transação - Usando Customer ID
        • Criar transação - Usando Card ID
        • Criar transação - Boleto com PIX
        • Criar transação - Boleto Simples
        • Criar transação - Boleto Completo
        • Criar transação - PIX
        • Listar transações
        • Listar detalhes de transação pelo identificador
        • Alterar detalhes de transação pelo identificador
        • Estornar transação
        • Disponibilizar link carta de cancelamento
      • Source
        • Criar source para utilização transação
        • Listar detalhes de source pelo identificador
        • Remover source pelo identificador
      • Boleto
        • Enviar cobrança de boleto por email
        • Listar detalhes de boleto
        • Solicitar cancelamento de boleto
      • Planos de Recorrência
        • Criar um plano
        • Listar planos
        • Recupera um plano pelo identificador
        • Alterar plano pelo identificador
        • Deletar um plano pelo identificador
      • Assinatura de Recorrência
        • Criar uma assinatura
        • Listar assinaturas
        • Listar os detalhes de uma assinatura pelo identificador
        • Alterar os detalhes de uma assinatura pelo identificador
        • Remover uma assinatura pelo identificador
        • Suspender uma assinatura pelo identificador
        • Reativa uma assinatura pelo identificador
      • Fatura de Recorrência
        • Criar uma fatura avulsa
        • Listar faturas
        • Listar os detalhes de uma fatura pelo identificador
        • Remover uma fatura pelo identificador
        • Aprovar fatura pendente
        • Estornar e reembolsar fatura
      • Recibo
        • Enviar recibo por email
        • Enviar recibo por SMS
        • Recuperar detalhes do recibo
        • Renderizar template de recibo HTML
      • Recebível
        • Listar detalhes de recebível
        • Listar recebíveis por transação
    • REPASSES E TRANSFERÊNCIAS
      • Saldo de Conta
        • Listar contas por buyer
        • Listar histórico de lançamentos pelo identificador da conta
        • Listar histórico de lançamentos de conta
        • Listar histórico de lançamentos de conta por buyer
        • Recuperar saldo
      • Transferências
        • Listar transferências
        • Recuperar detalhes de transferência
        • Listar transações associadas a transferência
      • Lançamentos Futuros
        • Listar lançamentos futuros
      • Saldo atual de Conta
        • Recuperar saldo atual de conta
    • NOTIFICAÇÕES E EVENTOS
      • Webhook
        • Criar webhook
        • Listar webhooks
        • Recuperar detalhes de webhook
        • Remover webhook
  1. GESTÂO DE TRANSAÇÃO E RECEBÍVEIS

Pagamentos Recorrentes (Planos e Assinaturas)

O que é#

O serviço de recorrência da Paylogos é um conjunto de webservices que disponibiliza operação de transações recorrentes através de cartão de crédito, com base em políticas de cobrança pré-definidas, como frequência da cobrança, valor, período de "trial" e tolerância em caso de atraso.

Detalhes do produto#

Um plano define a frequência como as assinaturas serão transacionadas, renovadas e faturadas. Por exemplo, uma academia pode possuir um "Plano mensal", que é renovado automaticamente todo mês, ou um "Plano bimestral", renovado automaticamente a cada dois meses.
As Assinaturas definem a relação entre um plano e um cliente, possuindo data de início e fim, representando um contrato com cobranças recorrentes baseadas nas regras estabelecidas entre o cliente e o parceiro, conforme plano vinculado.
a9780a13aff9b61b732fe384066e2b44c13aed20c1a0b1fecbb11eea8727c095-fluxo_recorrencia.jpg

Fluxo detalhado#

Para usar o serviço de planos e assinatura, você precisa:
Será necessário ter um vendedor (seller) criado.
Aguardar a aprovação do vendedor que ocorre através do nosso time de credenciamento.
Criar comprador (buyer).
Crie um novo token do cartão de crédito.
Associe um cartão de crédito ao comprador (customer) existente, dando os identificadores de token de cartão gerado conforme o passo 4.
Criar um novo plano de recorrência com definição do valor e frequência a ser cobrado.
Criar uma nova assinatura, vinculando ao plano criado e associando um comprador.
A cada vencimento da assinatura, o sistema de recorrência irá gerar uma nova fatura, realizando a cobrança do valor, onde será notificado através do response da transação ou evento de webhook em caso de sucesso ou falha, dando visibilidade para o marketplace continuar o fluxo de aprovação/liberação dos serviços em seu sistema.

Recursos#

Cobrança de faturas avulsas caso ocorra ausência de pagamento.
Notificação através de eventos de webhooks de transações/faturas aprovadas ou rejeitadas através das assinaturas.
Gestão de múltiplos planos e assinaturas por marketplace.
Cobrança por cartão de crédito.
Retentativa automática de cobrança em caso de falha.
❗️ Importante
Intervalo de cobrança
O campo "interval" funciona em conjunto com o campo "frequency", ou seja, após declarado em quanto tempo a assinatura será cobrada (mensalmente, semanalmente, anualmente ou diariamente) no campo "frequency" deverá ser declarado o "interval" que se refere ao número de intervalos entre a primeira cobrança e as subsequentes.
Exemplo:
"frequency": "daily", ----> Frequência diária
"interval": 30, -----> A cada 30 dias o sistema recorrente irá realizar uma cobrança
Alteração de cartão de crédito
Caso ocorra alteração do cartão do comprador por qualquer motivo, não haverá necessidade de alterar a assinatura em vigor, automaticamente o novo cartão associado será o padrão (default) para a realização das cobranças futuras.
Será possível realizar as cobranças com um cartão específico (card_id), assim ficará a critério do do comprador (Customer) escolher qual cartão cadastrado/vinculado que seja utilizado nas cobranças das próximas assinaturas. Segue o exemplo de como ficará essa requisição no ato de criar uma assinatura:
{"plan": "plan_id","on_behalf_of": "seller_id",
"customer": "buyer_id",
"payment_method": "credit",
"due_date": "2022/08/08",
"currency": "BRL",
"card": "card_id"
}
❗️ Período de carência
É possível definir o período de carência através do campo "due_date" (data definida para o início da cobrança) no ato da criação de uma assinatura (subscription), uma vez definido a data da primeira cobrança irá ocorrer exatamente no prazo definido, assim, o comprador (Customer) já poderá utilizar o serviço do vendedor (Seller) com a data já definida para a próxima cobrança sem qualquer tipo de intervenção, ou seja completamente automatizado.
Exemplo:
Ao realizar uma requisição o cliente ganhará 4 dias de carência ou "teste grátis", logo o seller irá definir a data da primeira cobrança conforme o "request" abaixo:
{"plan": "plan_id","on_behalf_of": "seller_id",
"customer": "buyer_id",
"payment_method": "credit",
"due_date": "2022/08/30",
"currency": "BRL",
"card": "card_id"
}
Caso de uso:
Em um cenário, caso o comprador (Customer) queira realizar o cancelamento antes da primeira cobrança, caberá ao Marketplace disponibilizar uma opção de suspensão da assinatura através da API "Suspender uma assinatura pelo identificador" disponibilizada em nossa documentação de referencia.
🚧 Retentativa automatica
As regras da retentativa atendem o Normativo 21 da ABECS (regulatório) e aos mandantes de bandeira baseando-se nos códigos de retorno.
Reversível: Serão permitidas as retentativas transações que poderão ser aprovadas no mesmo dia ou em dias posteriores com os mesmos dados na mensagem de autorização da transação negada.
Irreversível: Serão irreversíveis as transações que em hipótese alguma poderão ser aprovadas no mesmo dia ou em dias posteriores, caso sejam submetidas com as mesmas características na mensageria de uma transação com autorização negada.
Exemplo: Cartão sem fundos, fora da validade e etc...
A retentativa será realizada no máximo 9 vezes, sendo a primeira em 5 minutos, segunda 10 minutos e a terceira em 1 hora.
Após, ocorrerão mais 5 tentativas de 3 em 3 horas totalizando o limite de 9 em um período aproximadamente 24 horas. Observando que mediante alguns retornos, a retentativa poderá ser realizada em D+1.
Modificado em 2025-06-04 20:04:30
Página anterior
Recebível
Próxima página
Recibo
Built with