开发者文档中心

面向第三方开发者与 AI 接入助手。这里提供开放 API 的完整接入说明、可运行的 SDK 示例,以及可直接复制给 AI 的自包含接入文档。

开放 API 参考 接口列表、参数、响应、错误码、回调规范,按实现单一数据源渲染。 AI 接入文档(.md) 自包含 Markdown,复制全文交给任意 AI 即可生成可运行接入代码。 OpenAPI 3.0 规范(.json) 机器可读,可导入 Postman / Swagger / 各类代码生成工具。 Node.js SDK 示例 零依赖,严格按平台签名规则实现,可直接运行。 Python SDK 示例 仅用标准库,签名与请求逻辑与平台一致。

快速开始

  1. 在后台「开放 API / 应用」创建应用,获取 app_id 与 app_secret(secret 仅展示一次)。
  2. 下载上方的 Node.js 或 Python SDK,填入凭证与平台地址。
  3. 先调用 GET /openapi/v1/ping 验证签名是否正确(返回 code:"0" 即成功)。
  4. 实现 callback_url 端点:校验签名、按 event_id 幂等、返回 2xx。

服务地址示例:http://localhost:3000(生产环境请替换为平台分配的域名)。所有接口统一前缀 /openapi/v1。

查看完整 API 参考 →

接口一览

方法路径所需 Scope说明
GET /openapi/v1/ping 无(仍需签名) 连通性探测
GET /openapi/v1/system/status 无(仍需签名) 支付可用状态
GET /openapi/v1/balance balance.read 查询用户余额
GET /openapi/v1/transactions transactions.read 查询交易流水
POST /openapi/v1/pay pay.debit 代付 / 扣款
POST /openapi/v1/recharge wallet.recharge 为用户入账
GET /openapi/v1/kyc/status kyc.read 查询实名状态