Documentation Index
Fetch the complete documentation index at: https://docs.profy.cn/llms.txt
Use this file to discover all available pages before exploring further.
金融支付
Profy 内置完整的虚拟货币体系——金币(Coin)。用户通过微信支付充值获得金币,使用金币消费应用服务。系统支持充值方案、交易记录、幂等消费和 OpenAPI 对外调用。
金币体系
数据模型
| 表 | 说明 |
|---|
coinAccounts | 用户金币账户,记录余额 |
coinTransactions | 金币变动流水(充值/消费/退款) |
consumeRecords | 消费明细(关联任务/服务) |
账户接口
| 方法 | 路径 | 说明 |
|---|
| GET | /api/finance/balance | 查询当前余额 |
| POST | /api/finance/consume | 消费金币 |
| POST | /api/finance/preCheck | 预检余额是否充足 |
| POST | /api/finance/records | 查询交易记录 |
消费类型
金币消费支持三种计费模式:
| 类型 | 标识 | 说明 |
|---|
| 按Token | TOKEN | 根据 AI 模型输入/输出 Token 数计费 |
| 按时长 | DURATION | 根据服务使用时长计费 |
| 固定价格 | FIXED | 单次固定金额扣费 |
幂等消费
每次消费请求携带唯一 requestId,系统通过该 ID 保证同一笔消费不会重复扣款。适用于网络重试和回调重放场景。
充值流程
充值接口
| 方法 | 路径 | 说明 |
|---|
| GET | /api/finance/recharge/plans | 充值方案列表 |
| GET | /api/finance/recharge/preview | 预览到账金币数 |
| POST | /api/finance/recharge/create | 创建充值订单 |
| GET | /api/finance/recharge/status/:orderNo | 查询充值状态 |
| POST | /api/finance/recharge/summary | 充值汇总 |
| POST | /api/finance/recharge/records | 充值记录 |
服务计划
服务计划(Service Plan)为不同业务线提供差异化的计费配置。
| 方法 | 路径 | 说明 |
|---|
| GET | /api/finance/servicePlan/list | 服务计划列表(按 serviceCode 筛选) |
服务计划定义了:
- 服务标识(
serviceCode)
- 计费单价和模式
- 有效期和限额
- 关联的金币消费规则
微信支付集成
支付架构
支付接口
| 方法 | 路径 | 说明 |
|---|
| POST | /api/payment/create | 创建支付订单 |
| GET | /api/payment/status/:outTradeNo | 查询支付状态 |
| POST | /api/payment/close/:outTradeNo | 关闭支付订单 |
| POST | /api/payment/notify/:channel | 支付结果回调(免认证) |
支付流程要点
- Native 支付 — 生成二维码 URL,用户微信扫码完成支付
- 异步回调 — 微信服务器 POST 通知到
/api/payment/notify/wechat
- 验签保障 — 使用微信支付 V3 证书验证回调签名
- 幂等处理 — 通过
outTradeNo 防止重复处理同一笔支付
消费记录
消费概览
| 方法 | 路径 | 说明 |
|---|
| POST | /api/consumption/summary | 消费汇总统计 |
| POST | /api/consumption/records | 分页消费明细 |
消费记录关联任务、服务和 Agent 实例,用户可在「消费记录」页面查看完整的金币流向。
OpenAPI 金币接口
第三方系统可通过 API Key 调用金币接口,实现外部服务的计费集成:
| 方法 | 路径 | 认证方式 | 说明 |
|---|
| GET | /openapi/coin/balance | API Key | 查询余额 |
| POST | /openapi/coin/consume | API Key | 消费金币 |
| POST | /openapi/coin/preCheck | API Key | 预检余额 |
请求头中通过 X-Api-Key: sk_xxxxx 或 Authorization: Bearer sk_xxxxx 传递密钥。
相关链接