Pré-requisitos
Antes de começar, você precisará de:- Merchant ID: Identificador do seu fluxo na Malga;
- API Keys: Chaves de autenticação para acessar as APIs;
- ClientId: Seu identificador na Malga.
Passo 1: Criar um Customer
Primeiro, você precisa criar um customer na Malga para associar à recorrência.O customer é obrigatório para criar uma assinatura. Confira a documentação
completa da API de
Customers
para mais detalhes.Adicionamos novos campos de endereço de entrega e de cobrança para melhor suporte a antifraude dos provedores de pagamento.
Exemplo de criação de customer
Passo 2: Salvar um Cartão
Para criar uma recorrência, você precisa de um cartão salvo na Malga. O processo é dividido em duas etapas:Criar um Token
Primeiro, crie um token com os dados do cartão.O token é temporário e deve ser usado imediatamente para salvar o cartão.
Confira a documentação da API de
Tokens para mais detalhes.
Salvar o Cartão
Agora, use o token para salvar o cartão.O cartão salvo será usado para as cobranças recorrentes. Confira a
documentação da API de
Cards para mais
detalhes.
Vincular o cartão de crédito ao customer (recomendado)
Não é obrigatório vincular o cartão de crédito ao customer, mas é recomendado para melhorar a experiência do cliente. Por padrão não vinculamos o cartão de crédito ao customer. Para fazer isso, utilize a API de Vinculação de cartão de crédito ao customer.Request
Passo 3: Criar a Recorrência
Agora você pode criar a assinatura recorrente com todos os dados necessários.Os intervalos de recorrência disponíveis são: weekly
(semanal), monthly (mensal), quarterly (trimestral) e yearly (anual). Escolha o intervalo que
melhor se adequa ao seu modelo de negócio.Novidade: Agora também suportamos assinaturas com período de trial gratuito - confira a documentação do sistema de trial.Importante: O campo
startAt
deve ser informado em formato UTC (YYYY-MM-DD).Assinaturas trimestrais seguem a mesma estratégia de retentativas das assinaturas mensais e anuais: 5 tentativas em D+0, D+1, D+4, D+9 e D+16.
Assinaturas com Trial
O motor de recorrência suporta períodos de trial gratuito. Durante o trial, a assinatura fica no statustrialing
e não gera cycles de cobrança.
Exemplo: Assinatura com Trial
Características dos Trials
- Período gratuito: Cliente pode usar o serviço sem ser cobrado
- Status
trialing
: Assinatura fica neste status durante o período - Transição automática: Ao expirar, transiciona para
created
- Apenas cancelamento: Durante o trial, apenas cancelamento é permitido (não pausar)
O campo
trialEnd
deve ser uma data no formato YYYY-MM-DD
indicando quando o trial termina. Se startAt
não for fornecido, será automaticamente definido como a data de término do trial.Próximos passos
Agora que sua recorrência está criada, você pode:Entenda pagamentos instantâneos
Saiba como realizar pagamentos instantâneos com a recorrência e entenda as
suas particularidades.
Gerenciar assinatura
Ative, pause ou cancele a assinatura conforme necessário.
Trial
Configure períodos de trial gratuito para suas assinaturas.
Configurações
Personalize retentativas e statement descriptors.