跳转到内容

OpenAPI 总览 ​

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

近期接口文档调整见 变更记录。

调用地址

沙箱环境 Base URL:https://sandbox-ucard-openapi.futurepay.cc

生产环境 Base URL:https://card-openapi.futurepayapp.com

接口索引和单接口页展示的是完整请求 PATH,例如 /openapi/v2/cards/recharge。

对应的完整请求 URL 为 https://sandbox-ucard-openapi.futurepay.cc/openapi/v2/cards/recharge。

快速查找

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

接入顺序 ​

  1. 阅读 加签说明,确认请求签名和响应验签。
  2. 阅读 公共响应,确认统一响应外层结构。
  3. 阅读 商户 Webhook,配置异步通知地址并实现验签、事件分发和幂等。
  4. 在下面的接口索引中按业务场景进入具体 endpoint。

接口索引 ​

健康检查 ​

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

用户接口 ​

接口方法路径
注册用户POST/openapi/v2/users/createUser
分页查询当前租户用户GET/openapi/v2/users/list
上传 KYC 图片POST/openapi/v2/users/uploadKycImage
查询 KYC 补件信息GET/openapi/v2/users/kyc/supplement/context
提交用户 KYCPOST/openapi/v2/users/kyc
查询用户 KYC 状态GET/openapi/v2/users/kyc/status

卡接口 ​

接口方法路径
用户开卡POST/openapi/v2/cards/issueCard
查询可办卡类型GET/openapi/v2/cards/types
绑卡POST/openapi/v2/cards/bindCard
分页查询开卡订单GET/openapi/v2/cards/open-orders
查询开卡订单详情GET/openapi/v2/cards/open-orders/{cardOrderNo}
查询用户开卡状态GET/openapi/v2/cards/status
查询卡详情GET/openapi/v2/cards
查询卡片验证码接收设置GET/openapi/v2/cards/{cardId}/3ds-contact
修改卡片验证码接收邮箱POST/openapi/v2/cards/{cardId}/3ds-contact/email
修改卡片验证码接收手机POST/openapi/v2/cards/{cardId}/3ds-contact/phone
查询用户卡列表GET/openapi/v2/cards/list
查询用户持卡概览GET/openapi/v2/cards/overview
查询卡敏感信息GET/openapi/v2/cards/sensitive
查询卡余额GET/openapi/v2/cards/balance
查询卡账户额度GET/openapi/v2/cards/account-limits
查询卡交易记录GET/openapi/v2/cards/transactions
查询卡交易处理过程GET/openapi/v2/cards/transactions/process
模拟卡交易POST/openapi/v2/cards/transactions/simulate
创建卡激活申请POST/openapi/v2/cards/activations
锁卡POST/openapi/v2/cards/lock
解锁POST/openapi/v2/cards/unlock
查询卡操作单列表GET/openapi/v2/cards/operations
查询卡操作单GET/openapi/v2/cards/operations/{operationOrderNo}
重新激活POST/openapi/v2/cards/reactivate
挂失POST/openapi/v2/cards/reportLost
修改 PINPOST/openapi/v2/cards/pin
卡充值POST/openapi/v2/cards/recharge

资金接口 ​

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