翼支付客户端支付应用接入指南

1、翼支付客户端支付应用接入指南（HTML5应用开发）版本历史版本/状态作者部门日期备注邓志亮、胡灵敏客户端2015-9-23H5接入技术内容更新张记文客户端2015-04-01Onpay 删除 MERCHANTPWD目录本文阅读对彖为中国电信翼支付客户端合作商户的产品开发、研发相关技术人员。2使用用途本文介绍在HTML5平台开发符合标准的支付应用并与翼支付客户端集成的技术细节，帮 助商户将其业务与翼支付客户端系统对接。3名词解释名称名称说明说明安全支付模块翼支付客户端中向用户提供账户选择、订单确认、密码输入等功能并保障用户支 付安全的模块，供各类支付应用客户端调用。网关平台中国电信天翼电子商务有

2、限公司开发的与翼支付客户端、商户支付应用平台交互 的服务端系统。支付应用客户端合作商户开发的可下载集成到翼支付客户端的客户端软件，向手机用户提供该合 作商户的业务。支付应用平台合作商户的与支付应用客户端和网关平台交互的服务端系统。翼支付收银台主要用来向翼支付客户端及其商户应用提供便捷、安全以及可靠的支付服务终端平台指手机系统平台，android或ios功能验收测试翼支付根据商户提供的测试报告进行验收测试，并出具测试报告适配测试在功能验收测试通过的前提下，在android和IOS多种不同机型下进行测试，并出具 适配报告前置审核产品体验和功能验收测试通过之后，山商户提供产品手册和客服脚本，翼支付产

3、品 经理审核完成之后安排内部客户体验上线将商户应用开放给普通用户4接入流程1、中请接入：配置测试环境和网关商户编码；2、接入测试：应用方发【应用接入 】测试版本安装包到我方产品经理进行测试环 境配置，邮件格式见：3、我方产品经理通知运营进行应用配置；4、接入测试：测试环境配置完成之后通知应用方测试，回复【应用接入】邮件“测 试环境配置完成”，同时发送客户端测试安装包；5、接入测试：应用提供方发【测试报告】，（测试报告中需包含测试用例）邮件到我 方产品经理；6、功能验收测试：我方根据提供的测试报告进行验收测试，并岀具测试报告；7、接入生产环境：验收测试通过后，通知生产上线准备，接入生产测试：8、

4、接入生产测试：生产环境配置完成之后通知应用方生产即正式环境测试，回复【应 用接入】邮件“生产环境配置完成”；9、应用提供方发【测试报告】邮件到我方接口人；10、 接入生产测试：我方根据应用方提供的生产测试报告进行验收测试，并岀具测试 报告；11、 功能测试：通过之后请产品部进行产品体验；12、 前置审核：产品体验和功能验收测试通过之后需要应用方根据“客户端客服知识 库内容规范”和“客户端知识库及客服解释脚本模板0605”提供产品手册和客服脚本, 由产品经理审核完成之后安排内部客户体验；12、体验完成之后通知市场部，由市场部完成上线流程并开放给普通用户。5交互流程6接口说明客户端侧接口HTML5

5、本地接I I函数库，定义了支付应用与翼支付客户端原生应用本地之间的交互接I Io根据支付应用场景抽象出通用的类库，如用户信息、应用、对话框、通讯录、扫一扫、支付 模块等等。详见。服务器侧接口支付应用平台与网关平台间采用http方式通信，见文档【翼支付移动收银台支付接 口开发包标准版-3节】。7开发调试7.17.1翼支付提供的资源.1翼支付客户端翼支付客户端连接翼支付生产环境的客户端版本。（可自行到官网下载）.2 商户商户 IDID我们为所有翼支付客户端的合作商户分配一个专有的网关商户ID,作为商户的标识。.3翼支付账号开通翼支付账号开通应用配置到

6、测试环境后，合作商户的手机号码开通翼支付账户，充值并下发支付密 码，供开发测试使用。72商户准备的资源7.7. 2.12.1翼支付账号翼支付账号f f合作商户需在翼支付客户端注册开通翼支付账号(支持多个)，提供给翼支付运 营进行账号配置。7.7. 2.22.2 H5H5 站点站点合作商户开发的H5应用(远程站点)，用于展示合作商户的业务，将应用地址提供 翼支付运营进行应用配置。7.7. 2.32.3支付应用平台支付应用平台合作商户开发的支付应用平台，与翼支付网关环境对接，进行订单生成，接收并响 应支付结果。73商户进行H5开发使用账号登录翼支付客户端，即可在首页(或者首页更多页)看到商户自己的

7、应用，进行页面 H5应用开发，如需使用翼支付客户端侧接口(如支付)，在页面嵌入即可。7. 4注意事项应用首页必须回退到翼支付大厅，必须使用翼支付，且只能使用翼支付，不可使用其他第三 方支付工具。翼支付客户端H5应用容器的topbar区域属于native,默认情况卞，左上角返回按钮的事件 为退出当前H5应用，建议商户在自己的H5应用内用topbar控制页面返回。=function()(true);返回按钮事:件交由页面js处理(function(event) if (event = backpress) /触发返回按钮事件(对android来说，包括物理返回键)在应用首页的代码：()；8提交测试

8、提交测试报告支付应用开发完成并配置到测试环境/生产环境后，需提交测试报告，表明支付 应用己具备上线集成测试基础。测试报告需涵盖支付应用主要功能用例，包括完整的支付流程测试。测试报告需要以邮件的形式反馈【测试报告】【应用名称】测试环境/生产环境测 试报告附件：测试报告模板。见应用需称终端平台应用版本测试报告模板.Xlsx 此测试报告模板的中订单支付用例必须测试，且需要提供订单支付手机截图，其他应 用功能测试用例请应用提供方补充并完成测试。9客户端侧接口定义91用户接口 (User)9.9. L L 1 1 获取产品号获取产品号- - getProductgetProduct(1)接口描述接口描述

9、接口名称获取用户产品号接口描述获取用户产品号，也就是电话/手机号码接口提供者支付应用客户端接口使用者HT51L5业务应用应用场景业务应用需要用到当前登录用户的产品时，从当 前登录会话中读岀(2)请求参数请求参数无应答参数应答参数返回值：返回用户产品号的字符串。接口名称调用实例调用实例$_id( ,phone_edit) .value = User.();9. 2应用信息及操作(App)9.9. 2.12.1设置顶部标题设置顶部标题- -setTitlesetTitle(1)接口描述接口描述接口名称设置支付应用客户端顶部标题接口描述设置支付应用客户端顶部标题接口提供者支付应用客户端接口使用者HT

10、51L5业务应用(2)请求参数请求参数主字段含义炎型必填长度备注Title标题ansM20(3)应答参数应答参数无调用实例调用实例(”商品详情9.9. 2.2. 2 2 获取客户端版本号一获取客户端版本号一 getClientVersiongetClientVersion(1)接口描述接口描述获取客户端版本号接口描述获取客户端大厅的版本号接口提供者支付应用客户端接口使用者HT51L5业务应用(2)请求参数请求参数无应答参数应答参数(4)客户端人厅版本号字符串，如调用实例如调用实例0;9.9. 2.2. 3 3 打开浏览器窗口打开浏览器窗口 一一 openBrowseropenBrowser(1

11、)接口描述接口描述接口名称打开外部浏览器接口提供者支付应用客户端接口使用者HT51L5业务应用(2)请求参数请求参数字符串，url应答参数应答参数无调用实例调用实例App. open Browser9.29.24 4 截断返回键截断返回键- -overrideBackPressedoverrideBackPressed接口描述接口描述接口名称截断返回键接口描述用户按返回键时不会退出渲染页 面接口提供者支付应用客户端接口使用者HTN1L5业务应用(6)请求参数请求参数主字段含义炎型必填长度备注bound是否截断ansM20t rue(7)应答参数应答参数无(8)调用实例调用实例App. over

12、rideBackPressed(true);9.9. 2.2. 5 5 功能页面跳转功能页面跳转 - - jumpToNativeViewjumpToNativeView接口描述接口描述接口名称跳转至native页面接口描述跳转至翼支付客户端原生页面接口提供者支付应用客户端接口使用者HTN1L5业务应用(2)请求参数请求参数参数均为字符串参数均为字符串参数值说明RealnameVerifyEntranceActivity跳转至翼支付实名认证界面ForgotPaymentPassword跳转至翼支付忘记支付密码界面More_MainActivity跳转至翼支付客服中心BindCard跳转至翼支付

13、绑卡界面(3)应答参数应答参数(4)调用实例调用实例App. jumpToNative (BindCard)9.9. 2.2. 6 6 支付密码安全输入支付密码安全输入- - openSafKeyboardopenSafKeyboard(1)接口描述接口描述接口名称支付接口描述调起翼支付收银台进行支付接口提供者支付应用客户端接口使用者HT51L5业务应用(2)请求参数请求参数主字段含义炎型必填填长度备注len输入字符长 度ansM50暂固定6位title弹出框标题ansM50暂不可设置succ_cbk调用成功回 调函数funcM返回加密后的密码fail_cbk调用失败回 调函数func0(3)

14、应答参数应答参数无(4)调用实例调用实例(6，”，function(pwd)j function()9.9. 2.2. 7 7 获取登录会话码一获取登录会话码一 getSessionKeygetSessionKey(1)接口描述接口描述接口名称获取登录会话码接口描述获取登录会话码接口提供者支付应用客户端接口使用者HT51L5业务应用(2)请求参数请求参数无应答参数应答参数返回值：返回sessionKey调用实例调用实例App getSessionKey ();9.9. 2.2. 8 8 设置头部隐藏显示设置头部隐藏显示- - setHeaderVisiblesetHeaderVisible接口

15、描述接口描述接口名称设置头部隐藏显示接口描述设置头部隐藏显示接口提供者支付应用客户端接口使用者HT51L5业务应用(6)请求参数请求参数主字段含义炎型必填填长度备注isVisible头部是否隐藏ansM M20false(7)应答参数应答参数(8)调用实例调用实例App. setHeaderVisible (false);9.9. 2.2. 9 9登录会话码续期登录会话码续期- - autoLoginautoLogin(1)接口描述接口描述接口名称登录会话码续期接口描述登录会话码续期，成功后返回新的sessionKey接口提供者支付应用客户端接口使用者HT51L5业务应用(2)请求参数请求参数

16、无(3)应答参数应答参数返回值：回调函数中返回新的sessionKey调用实例调用实例App. autoLogin (function(sessionKey)lf(sessionKey != )=lastAddress;9.9. 2.2.1010 获取网络类型获取网络类型- -getNetworkTypegetNetworkType(1)接口描述接口描述接口名称获取网络类型接口描述获取当前手机连接的网络类型接口提供者支付应用客户端接口使用者HT51L5业务应用(2)请求参数请求参数无应答参数应答参数返回值：网络连接类型2g/3g/4g/wifi(4)调用实例调用实例var nt =();9.9

17、. 2.2.1111获取用户地区码获取用户地区码- -getLocationgetLocation接口描述接口描述接口名称获取用户地区码接口描述获取当前用户所在的城市地区码接口提供者支付应用客户端接口使用者HT51L5业务应用(2)请求参数请求参数无应答参数应答参数地区码好(4)调用实例调用实例var locationCode =();9.9. 2.2.1212退出当前应用退出当前应用- - exitAppexitApp接口描述接口描述接口名称退岀当前应用接口描述退出当前H5应用接口提供者支付应用客户端接口使用者HT51L5业务应用请求参数请求参数无(7)应答参数应答参数无调用实例调用实例$(

18、r,#exitAppw) click9. 3 通信接口 (Contacts)9.9. 3.3.1 1 打开联系人打开联系人- -openContactsopenContacts(1)接口描述接口描述接口名称打开联系人接口描述打开移动终端的联系人通讯录对话框接口接口提供者支付应用客户端接口使用者HT51L5业务应用(2)请求参数请求参数主字段含义炎型必填长度备注success调用成功时 执行的函数ansM M30fail调用失败时 执行的函数func0 0(3)应答参数应答参数无。所读取的联系人返回值通过回调函数获取。(4)调用实例调用实例0；function(phone_no)$_id(pho

19、ne_edit)value = phone_no;function(error)；9.9. 3.23.2打电话打电话- - teltel(1)接口描述接口描述接口名称打电话接口描述打电话接口接口提供者支付应用客户端接口使用者HT51L5业务应用(2)请求参数请求参数主字段含义炎型必填长度备注tel电话号码ansM M30(3)应答参数应答参数返回值：返回空字符串。(4)调用实例调用实例$_id(teleservice).onclick = function()94原生对话框(Dialog)9.9. 4.4.1 1俄弹出等待对话框一俄弹出等待对话框一 showProgressDialogshow

20、ProgressDialog(1)接口描述接口描述接口名称弹出等待对话框接口描述弹出等待对话框接口接口提供者支付应用客户端接口使用者HT51L5业务应用(2)请求参数请求参数主字段含义炎型必填长度备注title标题ansM50msg消息ans0200(3)应答参数应答参数返回值：返回对话框句柄标识字符串。(4)调用实例调用实例var dialogid = Dialog. showProgressDialog (提示/IE在加载业务数据,请稍候，)；9.9. 4.4. 2 2 关闭等待对话框关闭等待对话框- - dismissDialogdismissDialog(1)接口描述接口描述接口名称关闭等待对话框接口描述关闭等待对话框接口接口提供者支付应用客户端接口使用者HT51L5业务应用(2)请求参数请求参数主字段含义炎型必填长度备注iddialogic!ansM50(3)应答参数应答参数无调用实例调用实例Dialog dismissDialog(dialog_id);(2)alert(係统繁忙，请稍后再试);9.9. 4.34.3关闭所有弹出的对话框关闭所有弹出的对话框- - closeDialogcloseDialog(1)接口描述接口描述接口名称关闭弹出对话框接口描述关闭弹出对话框接口接口