Skip to content

OpenAPI 总览

这里是开发者查找接口的入口。按业务分组浏览,或直接搜索接口名称、HTTP 方法、请求路径。

快速查找

在浏览器内使用页面搜索查找接口路径,例如 /openapi/v1/cards/recharge;站点也开启了 VitePress 本地搜索。

接入顺序

  1. 阅读 加签说明,确认请求签名和响应验签。
  2. 阅读 公共响应,确认统一响应外层结构。
  3. 在下面的接口索引中按业务场景进入具体 endpoint。

接口索引

健康检查

接口方法路径
查询服务健康状态GET/openapi/v1/health

用户接口

接口方法路径
注册用户POST/openapi/v1/users/createUser
上传 KYC 图片POST/openapi/v1/users/uploadKycImage
提交用户 KYCPOST/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
修改 PINPOST/openapi/v1/cards/pin
卡充值POST/openapi/v1/cards/recharge

资金接口

接口方法路径
卡提现POST/openapi/v1/funds/cardWithdrawals