Appearance
API 接口
Base URL =
https://test-api.cxh.me(沙箱) /https://api.cxh.me(生产)。 所有业务接口POST+application/json,响应统一{code, message, data, requestId, timestamp, success}。 请求头部 / body 字段类型 / 状态码 / 重试规则等通用约定见 HTTP 请求 / 响应规范;签名与加密细节见 签名+字段加密。
整套 API 围绕订阅展开。每个订阅在 订阅下单 时必须显式指定清结算模式(settlementMode),事后不可修改:
CXH_DEDUCT— 用户在 CXH 完成绑卡(见 支付绑卡),CXH 调支付通道执行扣款。扣款成功才计费、才发放权益。CHANNEL_COLLECT— 渠道自有支付体系完成用户收款。CXH 在下单成功的同时开账并发放权益,不感知渠道侧实际扣款结果。
模块清单
| 模块 | 范围 | 适用模式 | 文档 |
|---|---|---|---|
| 鉴权 | 获取 accessToken | 两者 | api/auth |
| 商品查询 | 列出已授权 SPU 及周期 / 期数 / 单期价 / 结算模式 | 两者 | api/products |
| 支付绑卡 | 发送验证码 / 确认绑卡 / 替换共享协议 / 查询用户卡列表 | 仅 CXH_DEDUCT | api/binding |
| 订阅下单 | 创建主订单(必填 settlementMode) | 两者 | api/subscribe |
| 订阅查询 | 主订单详情 / 用户订阅列表 / 单期子订单查询 | 两者 | api/query |
| 订阅解约 | 主动取消订阅 | 两者 | api/unsubscribe |
| 回调通知 | CXH 主动推送订单 / 支付事件 | 两者 | api/callback |
退款规则
- A 模式:退款由 CXH 内部审核处理,渠道侧通过合同流程联系 BD 提交申请;退款结果通过 webhook 与查询接口感知
- B 模式:CXH 不参与退款,由渠道自行处理;已
BILLED期次保留,渠道侧退款不影响已发权益
详见 订阅下单 § 模式差异速查。
公证服务(独立板块)
公证服务不在本文订阅清单内,作为独立业务板块单独发布:
| 文档 | 用途 |
|---|---|
| 公证服务接入指南 | 板块入口:业务定位 + 文档导航 |
| 公证下单 | POST /openapi/v1/notary/orders/create |
| 公证查询 | POST /openapi/v1/notary/orders/query 查订单状态;响应含公证函下载 URL |
公证业务与订阅业务的核心差异:单次出证(无周期) / 不走 SPU/SKU/类目 / 公证收费 notaryFeeCent 由渠道传入,详见 公证服务接入指南。