Skip to content

README.md

Latest commit

 

History

History
46 lines (29 loc) · 2.13 KB

README.md

File metadata and controls

46 lines (29 loc) · 2.13 KB
Raw

@vmp/payments

Pluggable payment providers for VMP billing.

Providers

ID Status Default enabled
stripe Production Yes
qerko Production (legacy eshop / migration) Only when listed in tenant settings
gopay Stub (NotImplementedError) No
comgate Stub (NotImplementedError) No

Admin settings still store legacy in CSV lists; the registry normalizes that to qerko. D1 subscriptions.provider continues to use legacy for Qerko rows.

Tenant configuration

payments_enabled_providers and payment_provider_order in admin_settings control which providers are active, e.g.:

  • Fresh launch: stripe
  • Migrated tenant: stripe,legacy (parsed as stripe,qerko)

createEnabledProviders(enabledIds, config) returns a Map of configured provider instances. Billing code must resolve the provider from this map — never import Stripe or Qerko SDKs directly.

Capabilities

Each provider exposes capabilities:

  • newSubscriptions — may onboard brand-new subscribers (Qerko: true when enabled in tenant settings; uses the legacy eshop initial payment / CardOnFile create flow)
  • migrationOnly — only for pre-existing platform subscribers (Qerko: false; relink still works via needs_relink + purchaseId)
  • recurringPayments, refunds, webhooks — feature flags for future UI/guards

Checkout must gate on provider.capabilities.newSubscriptions instead of hardcoded provider IDs. Admins still control whether Qerko appears at checkout via payments_enabled_providers.

Adding a provider

  1. Add src/providers/<id>/index.ts exporting createXProvider(config): PaymentProvider.
  2. Register in src/registry.ts PROVIDER_FACTORIES.
  3. Wire config in the API composition root (packages/api/src/paymentProviders.ts).
  4. Add webhook route /api/payments/webhook/<id> or dispatch by path.

GoPay / Comgate are registered stubs — enable in settings only after real implementations land.

GoPay / Comgate assumptions (confirm with product)

Stub capabilities are set to all false until real implementations land. Treat as placeholder until PSP contracts are finalized.