IFrame

环境

Env	URL	Description
Test	https://iframe.hipay.world
STG	暂无
Prod	不对外公布

商户授权鉴权流程

iframe前端对接

授权

iframe授权URL

https://iframe.hipay.world/en-US/alogin/?key=商户APIKey&ticket=商户鉴权标识

请求方式

GET

请求参数

字段	数据类型	说明	作用
key	String	请求 API KEY	标识区分出来白标用户
ticket	String	商户鉴权标识	商户自认证或鉴权标识
en-US	String	语言，URL上可以不携带语言标识，默认en-US	支持语言:zh-CN/en-US

iframe路由

说明

iframe支持页面单独加载，但是需要在url上面携带key和ticket，单独页面加载的时候会在当前界面提示授权，通过授权则可以正常使用
举例：https://iframe.hipay.world/aLogin?key=d1f1a482-6aba-4b6d-bcfe-1050c8cbabfc&ticket=13

模块路由

登录

登录入口：https://iframe.hipay.world/aLogin

卡片

卡片列表：https://iframe.hipay.world/

卡片资产：https://iframe.hipay.world/card

卡片-完整信息：https://iframe.hipay.world/card/info/[accountCardId]

卡片账单：https://iframe.hipay.world/card/bill

卡片账单-详情：https://iframe.hipay.world/card/bill/[id]

申请卡片列表：https://iframe.hipay.world/card/list

卡片详情：https://iframe.hipay.world/card/details/[ditchCardId]

我的卡片：https://iframe.hipay.world/card/my

充值/抵押：https://iframe.hipay.world/card/recharge

卡片记录：https://iframe.hipay.world/card/record

卡片记录-详情：https://iframe.hipay.world/card/record/[id]

地址

地址列表：https://iframe.hipay.world/address

添加地址：https://iframe.hipay.world/address/add

编辑地址：https://iframe.hipay.world/address/edit/[id]

iframe work flow

开卡work flow：

• 注册/登录(注册客户)：API
• 卡列表：iframe
• 卡详情：iframe
• 卡申请：iframe
• 开卡支付：API
• 开卡资料：iframe
• 手机号：API
• 邮箱：API
• 持卡人地址：iframe
• 提交审核：iframe
• 卡片资产：iframe

充值work flow:

• 注册/登录(注册客户)：API
• 我的卡片：iframe
• 充值申请：iframe
• 充值支付：API
• 充值提交完成：iframe

商户授权

商户需提供自我鉴权接口，配置在Broker管理平台

设置位置：

设置->访问管理->授权地址

实现主流程：

• iframe根据设置地址请求商户
• 商户通过商户鉴权标识Ticket进行自我认证和鉴权:
  • 拒绝则直接返回错误
  • 通过则调用OpenApi接口中“注册客户“进行UPay鉴权
  • 注册客服是通过手机号或邮箱注册在默认客户组下
• 鉴权完成则返回UPay发放的临时票据，返回到商户，商户需返回临时票据信息给IFrame的商户用户
• 商户用户则通过临时票据换取认证Token

授权接口

请求方式

POST

请求参数

字段	数据类型	说明	作用
ticket	String	商户鉴权标识	商户自认证或鉴权标识

JSON

{
    "ticket": "eff46b37-ee08-473e-a94b-c8b05069320b"
}

返回

字段	数据类型	说明	作用
ticket	String	UPay临时票据	用于IFrame换取Token

商户鉴权成功并返回UPay的临时票据：

JSON

{
    "data": {
        "ticket": "eff46b37-ee08-473e-a94b-c8b05069320b"
    },
    "code": 0,
    "msg": "success"
}

商户鉴权拒绝或失败返回

JSON

{
    "data": null,
    "code": 500,
    "msg": "fail"
}