账户接口¶
账户接口用于查看账户余额和交易流水记录。
认证方式
所有账户接口需要使用 JWT Token 认证。
接口列表¶
| 接口 | 方法 | 说明 |
|---|---|---|
| /api/transactions/ | GET | 获取交易流水 |
获取交易流水¶
获取当前用户的账户交易流水记录。
请求¶
地址：GET https://api.upath.cn/api/transactions/
请求头：
| 参数 | 必填 | 说明 |
|---|---|---|
| Authorization | 是 | Bearer |
查询参数：
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| page | integer | 否 | 页码，默认 1 |
| page_size | integer | 否 | 每页数量，默认 20 |
| type | string | 否 | 交易类型：recharge/consume/refund |
| start_date | string | 否 | 开始日期（YYYY-MM-DD） |
| end_date | string | 否 | 结束日期（YYYY-MM-DD） |
响应¶
成功响应：
| 字段 | 类型 | 说明 |
|---|---|---|
| count | integer | 总记录数 |
| next | string | 下一页 URL |
| previous | string | 上一页 URL |
| results | array | 交易记录列表 |
| results[].id | integer | 记录 ID |
| results[].type | string | 交易类型 |
| results[].amount | string | 交易金额 |
| results[].balance_before | string | 交易前余额 |
| results[].balance_after | string | 交易后余额 |
| results[].description | string | 交易描述 |
| results[].created_at | string | 交易时间 |
交易类型说明¶
| 类型 | 说明 |
|---|---|
| recharge | 充值 |
| consume | 消费（语音对话扣费） |
| refund | 退款 |
余额查询
当前账户余额可通过登录接口响应中的 customer.balance 字段获取。
账户余额¶
账户余额信息包含在登录响应的客户信息中。
获取方式¶
通过登录接口响应获取：
| 字段 | 说明 |
|---|---|
| customer.balance | 当前账户余额（元） |
余额变动场景¶
| 场景 | 说明 |
|---|---|
| 注册 | 新用户获得 5 元体验余额 |
| 充值 | 管理员为账户充值 |
| 语音对话 | StopVoiceChat 时自动扣费 |
| 退款 | 异常情况下的费用退还 |
余额不足
当账户余额不足时，调用 StartVoiceChat 将返回 INSUFFICIENT_BALANCE 错误。