TorbatYar/docs/provider-registry.md
Mortezakoohjani 9fac160258 feat(payment): ship Torbat Pay MVP phases 14.0-14.5
Add independent payment-service (port 8012, payment_db) with foundation licensing, BYO-PSP, merchant accounts, idempotent requests, callbacks, and immutable ledger.

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-07-27 17:57:04 +03:30

6.1 KiB

Provider Registry

Inventory of external providers. Template: provider-template.md. Detail sheets: provider-reference.md.


Payamak (پاینامک / Payamak-Panel)

Field Value
Provider Name Payamak
Country IR
Capabilities SMS OTP send; SMS messaging via Communication adapters
Version API as configured via env / tenant credentials
Dependencies Network egress to Payamak API
Supported Modules Core (auth OTP), Identity (via Core OTP client), Communication (platform SMS)
Configuration Core: PAYAMAK_*; Communication: tenant provider_configs.credentials
API Provider HTTP SendOtp / SendSimpleSMS
Status Active
Documentation provider-reference.md, communication-phase-8.md
Tests Core OTP tests; Communication provider/SMS tests

Communication Mock SMS

Field Value
Provider Name Mock SMS
Country N/A
Capabilities Deterministic SMS send for tests/dev
Version Built-in
Dependencies None
Supported Modules Communication
Configuration provider_kind=mock
API In-process adapter
Status Active
Documentation communication-phase-8.md
Tests Communication provider/failover tests

Keycloak

Field Value
Provider Name Keycloak
Country N/A (self-hosted)
Capabilities OIDC IdP, realm users/roles, themed login
Version As deployed in compose/production
Dependencies Postgres (Keycloak DB), HTTPS public URL
Supported Modules Identity & Access, Frontend SSO, all JWT-validating services
Configuration KEYCLOAK_*, realm superapp, theme torbatyar
API OIDC + Admin API
Status Active
Documentation identity-architecture.md
Tests Identity service tests + manual SSO flows

Let's Encrypt / Certbot

Field Value
Provider Name Let's Encrypt
Country N/A
Capabilities Public TLS certificates
Version Certbot on edge host
Dependencies Port 80 ACME, DNS pointing to edge
Supported Modules Edge / all public hosts, tenant SSL expansion
Configuration Nginx + provision_ssl.py + SSL_PROVISION_*
API ACME
Status Active
Documentation ssl.md
Tests Operational verification scripts

S3-Compatible Object Storage (planned)

Field Value
Provider Name S3-Compatible
Country N/A
Capabilities Object upload/download, tenant-scoped buckets/prefixes
Version TBD
Dependencies File Storage module
Supported Modules file_storage, experience (media refs), website_builder (historical), ecommerce media
Configuration Endpoint, keys, bucket (TBD)
API S3 API
Status Planned
Documentation phases/Future
Tests TBD

Payment Platform — Torbat Pay (planned)

Field Value
Provider Name Torbat Pay (payment service)
Country IR (initial); architecture supports future regions
Capabilities BYO-PSP, Torbat Pay Merchant, PaymentIntent, Checkout, Callback, Settlement; future Refund/Split/Subscription/Wallet/Installment
Version Contract v1 per payment-contracts.md
Dependencies Core entitlement payment.module.enabled; Accounting posting intents; Communication notify
Supported Modules All verticals via API/events — Hospitality, Marketplace, Sports Center, Experience, CRM, Delivery, …
Configuration PAYMENT_*, PSP adapters in Payment only (ADR-020, ADR-021)
API Port 8012 /api/v1/*
PSP adapters (initial catalog) ZarinPal, IDPay, NextPay, Pay.ir, Mellat, Parsian, Saman (+ mock)
Status Architecture complete (payment-arch); implementation from payment-14.0
Documentation payment-roadmap.md, payment-contracts.md
Tests From payment-14.0 (architecture, tenant, bundle isolation)

AI Model Provider (planned)

Field Value
Provider Name TBD
Country TBD
Capabilities Chat/completion, embeddings
Version TBD
Dependencies ai_assistant module
Supported Modules ai_assistant, live_chat assist
Configuration API keys, model ids
API Provider SDK/HTTP
Status Planned
Documentation ai-architecture.md
Tests TBD

Delivery Routing Engine (planned)

Field Value
Provider Name TBD (pluggable routing engines)
Country TBD
Capabilities Route planning, ETA, multi pickup/drop optimization
Version TBD
Dependencies Delivery Platform adapters
Supported Modules delivery
Configuration Tenant provider_configs / env per adapter
API Provider HTTP/SDK behind Delivery protocols
Status Planned
Documentation delivery-roadmap.md, ADR-015
Tests TBD (from Phase 10.6)

External Fleet Provider (planned)

Field Value
Provider Name TBD
Country TBD
Capabilities External courier/fleet fulfillment
Version TBD
Dependencies Delivery Platform adapters
Supported Modules delivery
Configuration Tenant credentials in Delivery only
API Provider HTTP behind Delivery protocols
Status Planned
Documentation delivery-roadmap.md, ADR-015
Tests TBD