Skip to content

README.md

Latest commit

 

History

History
91 lines (63 loc) · 4.05 KB

README.md

File metadata and controls

91 lines (63 loc) · 4.05 KB
Raw

PayPlex

当前状态：PayPlex 的产品方向已经确认为 Vext 原生企业支付中台。企业平台运行时尚未交付；当前 payplex@0.0.4 只保留最小 Provider 契约内核，不能用于真实支付接入。

PayPlex 计划直接在一个 Vext 应用内提供商户接入、支付核心、账户账务、对账清结算、运营风控、权限审计和财务工作流。支付领域核作为内部可测试边界保护状态机、幂等和资金不变量；渠道 adapter 只负责渠道协议与外部事实。

产品范围

领域 已确认能力
支付网关 统一下单、查询、退款/部分退款、关单、异步通知、主动查询与补偿、SDK/OpenAPI
支付核心 支付/退款/出款状态机、幂等、路由、限流熔断降级、异常订单
账户账务 商户账户、可用/冻结/在途余额、流水、复式分录、冲正调账、一致性校验
对账清结算 渠道账单、自动对账、单边账、长短款、手续费、商户结算、结算单
运营与安全 商户/渠道管理、权限审计、风控规则、操作日志、告警监控、财务报表

这 34 项是企业支付中台核心能力基线，已经进入产品与领域规划，但当前运行时均未实现。完整 readiness 总账、经营模式矩阵、横切能力和范围决策见企业支付中台内部文档。

当前包边界

当前根入口可以本地验证：

  • PayPlex 的 Provider 注册、查找、能力读取和最小 Webhook 分发；
  • defineProvider() / defineMappedProvider() 的本地契约与映射切片；
  • Provider contract helper 和基础错误类型。

当前没有 Vext 平台应用、商户 HTTP API、真实 Stripe、签名基础设施、数据库、账务、清结算、管理端、任务补偿、生产 Webhook 流水线或 payplex/* 子路径。

import {
  PayPlex,
  defineProvider,
  defineMappedProvider,
  getCapability,
  runProviderContract,
} from 'payplex'

该导入只代表当前最小内核，不是企业支付 SDK 的生产接入示例。

验证

npm test
npm run smoke
npm pack --dry-run

这些命令证明当前内核、测试和包组成，不证明真实支付或企业平台可用。最小可执行示例见最小内核验证。

文档入口

  • 公开文档站源码：产品方向、角色、34 项范围、当前实现和支付安全边界。
  • 内部十区文档：经营模式、场景矩阵、商户接入、支付核心、账户账务、对账清结算、运营安全、渠道适配、平台工程和 API 准入。
  • 旧 SDK 草案归档：superseded 历史证据，不进入公开构建和搜索。

公开站不会发布尚未实现的端点、SDK 方法或生产 Quick Start。未来 API 只能从已实现且版本化的 Vext route/schema 与 OpenAPI 生成。

本地文档站

本地预览

PayPlex 运行时目标为 Node.js >= 18；当前站点依赖的 Rspress/Rsbuild 版本要求 Node.js >= 20.19（或 >= 22.12）。

cd website
npm install
npm run dev

构建站点

cd website
npm run build

未配置 PAYPLEX_DOCS_SITE_URL 时默认不生成 sitemap；部署环境必须提供包含部署 base path 的完整文档站根 URL。

维护说明

  • 产品范围或领域所有权变化：先更新 docs/01-product 和 ADR，再同步公开能力地图与 Profile。
  • 资金经营模式、横切能力或 conditional scope 变化：先更新 OperatingModelMatrix / ScopeDecisionRegister，再同步账务、清结算、运营安全和 API 蓝图。
  • 只有 package/source/test 或部署证据可支持“已实现”表述。
  • API 字段进入文档前，必须先存在实现、校验 schema、OpenAPI 和负向测试。
  • 不把账务、结算、风控、恢复或权限下沉为 Provider capability。
  • 当前工作树包含前序运行时内核改动；文档重构不回滚这些既有修改。

License

Apache-2.0