OpenAPI 总览
这里是开发者查找接口的入口。按业务分组浏览,或直接搜索接口名称、HTTP 方法、请求路径。
快速查找
在浏览器内使用页面搜索查找接口路径,例如 /openapi/v1/cards/recharge;站点也开启了 VitePress 本地搜索。
接入顺序
接口索引
健康检查
| 接口 | 方法 | 路径 |
|---|---|---|
| 查询服务健康状态 | GET | /openapi/v1/health |
用户接口
| 接口 | 方法 | 路径 |
|---|---|---|
| 注册用户 | POST | /openapi/v1/users/createUser |
| 上传 KYC 图片 | POST | /openapi/v1/users/uploadKycImage |
| 提交用户 KYC | POST | /openapi/v1/users/kyc |
| 查询用户 KYC 状态 | GET | /openapi/v1/users/kyc/status |
| 绑卡 | POST | /openapi/v1/users/bindCard |
卡接口
| 接口 | 方法 | 路径 |
|---|---|---|
| 用户开卡 | POST | /openapi/v1/cards/issueCard |
| 查询可办卡类型 | GET | /openapi/v1/cards/types |
| 分页查询开卡订单 | GET | /openapi/v1/cards/open-orders |
| 查询开卡订单详情 | GET | /openapi/v1/cards/open-orders/{cardOrderNo} |
| 查询用户开卡状态 | GET | /openapi/v1/cards/status |
| 查询卡详情 | GET | /openapi/v1/cards |
| 查询用户卡列表 | GET | /openapi/v1/cards/list |
| 查询卡敏感信息 | GET | /openapi/v1/cards/sensitive |
| 查询卡余额 | GET | /openapi/v1/cards/balance |
| 查询卡交易记录 | GET | /openapi/v1/cards/transactions |
| 创建卡激活申请 | POST | /openapi/v1/cards/activations |
| 锁卡 | POST | /openapi/v1/cards/lock |
| 解锁 | POST | /openapi/v1/cards/unlock |
| 重新激活 | POST | /openapi/v1/cards/reactivate |
| 挂失 | POST | /openapi/v1/cards/reportLost |
| 修改 PIN | POST | /openapi/v1/cards/pin |
| 卡充值 | POST | /openapi/v1/cards/recharge |
资金接口
| 接口 | 方法 | 路径 |
|---|---|---|
| 卡提现 | POST | /openapi/v1/funds/cardWithdrawals |
