Receber — Assinaturas e recorrência

Receber

Assinaturas e recorrência

Assinaturas cobram o mesmo valor automaticamente em intervalos regulares. Você cria a assinatura, a plataforma dispara as cobranças e administra o ciclo.

POST/api/v1/bank/wallet/subscription/

Cria uma assinatura (recorrência) ligada a uma carteira. Cada ciclo gera uma cobrança.

Requisição
POST /bank/wallet/subscription/
Authorization: Bearer <token>
Content-Type: application/json

{
  "wallet_uuid": "00000000-0000-0000-0000-000000000000",
  "merchant_id": "MER-001",
  "amount": 49.90,
  "currency": "BRL",
  "cycle": "monthly",
  "charge_type": "credit_card",
  "card_holder_name": "JOAO DA SILVA",
  "card_number": "4111111111111111",
  "card_expiry_month": "12",
  "card_expiry_year": "2030",
  "card_cvv": "123",
  "payer_name": "João da Silva",
  "payer_tax_id": "12345678901",
  "payer_document_type": "CPF",
  "payer_email": "joao@example.com",
  "webhook_url": "https://your-store.com/webhook/charge"
}
Resposta
{
  "subscription_uuid": "6b7c8d9e-0f1a-2b3c-4d5e-6f7a8b9c0d1e",
  "wallet_uuid": "00000000-0000-0000-0000-000000000000",
  "amount": 49.90,
  "currency": "BRL",
  "cycle": "monthly",
  "charge_type": "credit_card",
  "status": "active",
  "next_billing_date": "2026-10-14 14:40:00",
  "stop_on_error": true
}

Ciclos suportados

cycleFrequência
weeklySemanal
biweeklyQuinzenal
monthlyMensal
quarterlyTrimestral
semiannuallySemestral
yearlyAnual

Gerenciar assinaturas

GET/api/v1/bank/wallet/subscription/

Lista as assinaturas da carteira com o status de cada uma.

POST/api/v1/bank/wallet/subscription/<subscription_uuid>/cancel/<wallet_uuid>/

Cancela uma assinatura. As cobranças futuras são suspensas; a atual continua até o fim.