数据模型

数据模型概述

本节提供Smilepayz API系统中使用的所有数据模型的综合文档。数据模型定义了请求和响应参数的结构和格式，确保一致和可靠的API通信。

核心数据模型

编号	模型名称	描述
1	金额模型	交易的货币和金额规范 功能：多货币支持、精度处理 组件：currency、amount、payAmount
2	商户模型	商户识别和层级信息 功能：主商户和子商户支持 组件：merchantId、merchantName、subMerchantId
3	付款人模型	收款交易的客户信息 功能：地区身份要求 组件：name、email、phone、idType、identity
4	收款人模型	付款交易的收款人信息 功能：地区合规要求 组件：name、email、phone、idType、identity、taxNumber
5	支付渠道模型	支付方式和处理信息 功能：多支付方式支持 组件：paymentMethod、paymentUrl、qrString、vaNumber
6	交易状态模型	交易生命周期状态定义 功能：状态跟踪和监控 组件：INIT、PROCESSING、SUCCESS、FAILED、EXPIRED
7	交易类型模型	交易类型分类 功能：收款和付款区分 组件：收款(1)、付款(2)
8	商品详情模型	产品和服务信息 功能：商品规格和定价 组件：name、quantity、price
9	地区模型	地区和网络规范 功能：地理和加密货币支持 组件：地区代码、货币映射

模型分类

交易模型

专门为金融交易处理设计的模型：

• 金额模型: 货币和金额处理
• 交易类型模型: 交易分类
• 交易状态模型: 状态跟踪

实体模型

用于识别和管理商业实体的模型：

• 商户模型: 商户识别和层级
• 付款人模型: 客户信息
• 收款人模型: 收款人信息

处理模型

用于支付处理和路由的模型：

• 支付渠道模型: 支付方式规范
• 地区模型: 地区和网络支持
• 商品详情模型: 产品和服务详情

数据模型特征

标准化

• 一致格式: 所有模型都遵循标准化的JSON格式
• 类型安全: 所有参数的清晰数据类型规范
• 验证规则: 综合验证要求
• 文档: 完整的参数文档和示例

地区支持

• 多地区: 支持多个国家和市场
• 本地合规: 地区监管合规要求
• 货币支持: 多货币交易处理
• 支付方式: 地区特定支付渠道支持

安全功能

• 数据加密: 传输中敏感数据加密
• 访问控制: 数据模型的基于角色的访问控制
• 审计跟踪: 数据模型使用的完整审计跟踪
• 隐私保护: GDPR和地区隐私法合规

实施指南

模型使用

• 请求模型: 用于API请求参数验证
• 响应模型: 用于API响应数据格式化
• 验证: 综合参数验证和错误处理
• 文档: 完整的模型文档和示例

最佳实践

• 一致命名: 所有模型的标准化命名约定
• 类型验证: 所有参数的严格数据类型验证
• 错误处理: 无效数据的综合错误处理
• 性能: 高效处理的优化模型结构

集成支持

• SDK集成: 所有数据模型的完整SDK支持
• 代码示例: 完整实现示例
• 测试: 模型验证的综合测试框架
• 文档: 详细的集成指南和教程

模型演进

版本管理

• 向后兼容: 维护现有模型的向后兼容性
• 版本控制: 模型更新的清晰版本策略
• 迁移支持: 模型变更的迁移指南
• 弃用政策: 清晰的弃用和终止政策

增强过程

• 功能请求: 模型增强请求的结构化过程
• 审查过程: 模型变更的综合审查过程
• 测试: 模型修改的广泛测试
• 文档: 所有模型变更的更新文档