Cost+Docs

Pagamentos Recorrentes (MIT)

Configure pagamentos recorrentes e subscrições iniciados pelo comerciante

Os pagamentos recorrentes permitem cobrar clientes de forma programada sem a sua participação ativa. Este é um fluxo de Transação Iniciada pelo Comerciante (MIT).

Como Funciona

O fluxo recorrente tem duas fases:

  1. Primeiro pagamento — O cliente autentica-se e paga, concedendo permissão para cobranças futuras
  2. Pagamentos subsequentes — Cobra-se o cartão armazenado do cliente sem a sua interação

Fase 1: Primeiro Pagamento

Crie uma encomenda com recurring_type: "first" e um schedule_type:

POST /v1/orders/
{
  "merchant_order_id": "first-recurring",
  "currency": "EUR",
  "amount": 1295,
  "return_url": "https://www.example.com",
  "transactions": [
    {
      "payment_method": "credit-card",
      "recurring_type": "first",
      "schedule_type": "scheduled"
    }
  ]
}

Tipos de Agendamento

TipoDescrição
scheduledAgendamento fixo (ex.: subscrição mensal)
unscheduledPeriodicidade variável (ex.: recarga quando o saldo é baixo)

Após o pagamento bem-sucedido, guarde o vault_token e/ou first_transaction_id da resposta.

Fase 2: Pagamento Recorrente Subsequente

Cobre o cliente utilizando o token armazenado:

POST /v1/orders/
{
  "merchant_order_id": "recurring-order",
  "currency": "EUR",
  "amount": 995,
  "transactions": [
    {
      "payment_method": "credit-card",
      "recurring_type": "recurring",
      "vault_token": "{vault_token}"
    }
  ]
}

Os pagamentos recorrentes não devolvem um payment_url na resposta, uma vez que não é necessária interação do cliente. O pagamento é processado imediatamente.

Pode utilizar tanto vault_token como first_transaction_id para referenciar o cartão armazenado.

Validade do Token

Os tokens recorrentes têm uma validade máxima de 1 ano. Após a expiração, deve iniciar um novo primeiro pagamento para obter um token novo.

Certifique-se de que o seu sistema trata a expiração de tokens de forma adequada. Configure um processo para reautenticar os clientes antes de os seus tokens expirarem.

Recorrente vs One-Click

FuncionalidadeRecorrente (MIT)One-Click (CIT)
Iniciado porComercianteCliente
Cliente presenteNãoSim
Caso de usoSubscrições, faturação programadaCheckout rápido para clientes recorrentes
schedule_type obrigatórioSimNão
payment_url devolvidoNãoSim

Endpoints Relacionados

  • Criar Encomenda — utilize recurring_type e schedule_type na transação para configurar ou cobrar pagamentos recorrentes

On this page