智能终端APP接入
最近更新时间:2022.12.27
本文档主要描述了汇付数据智能POS标准第三方接入的规范,其中调用方式主要为SDK调用。
接入流程
开发机申请
开始接入前,需申请联调开发测试终端,所有联调均在生产环境进行调试。业务方联系对应汇付业务对接人员,汇付业务会内部申请专用联调开发机提供给对接方。联调开发机中会有明确图标表示为开发机,仅开发机可自行安装app进行调试且开发机不可用于真实商户收款。
测试商户
终端调试需使用调试商户,生产环境联调中,客户可自行准备生产环境测试商户。如客户无法准备测试商户,可咨询相关运营协助提供开发联调商户。
上架发布
当客户联调完成后,需进行应用上架汇付应用市场进行生产验证。客户将最终确定的app包进行签名打包,打包时必须包含V1签名。并将app包邮件发送汇付运营,提供相关app功能说明及版本说明,提供推送终端编号。
接入流程图
总体思路如下: 基于POS智能终端安装三方app,通过引入SDK并调用SDK接口,决定收银台展现页面。
接入说明
SDK文件下载
当前版本:V1.0.3
Androidx版本点我下载
Android support版本点我下载
SDK引入
把SDK文件放入三方APP的libs文件夹下并在 文件中引入,代码如下:build.gradle
android {
...
...
...
repositories {
flatDir { dirs 'libs' }
}
}
dependencies {
...
...
...
implementation(name: 'pnr_mis_sdk_V1.0.3', ext: 'aar')
implementation 'com.google.code.gson:gson:2.8.2'
implementation 'com.jakewharton.timber:timber:4.7.1'
implementation 'com.google.zxing:core:3.4.0'
...
...
...
}
SDK初始化
在 Application 的 onCreate() 方法中调用 PnrDevice.getInstance(this).init();
SDK调用
Androidx版本demo下载
Android support版本demo下载
日志规范
-
每天的日志写入同一个文件并以当天日期{yyyyMMdd}命名;
-
日志写入终端本地路径: mtms/log/outapp/{ APP应用包名} /{yyyyMMdd}.log;
-
应用内日志保留时间为15天,过期日志应及时删除。
注:在SDK中已经集成了日志保存逻辑,只需要使用Timber输出日志即可完成日志写入。
API接口汇总
以下为调用的api接口汇总。
支付类接口
接口名称 | 描述 |
---|---|
消费 | 该接口用于三方app调用发起消费收款,支持银行卡、反扫、正扫聚合支付。 |
消费撤销 | 该接口用于三方app调用发起消费撤销。 |
消费退款 | 该接口用于三方app调用发起消费退款。 |
花呗分期 | 该接口用于三方app调用发起花呗分期交易,支持支付宝花呗分期。 |
预授权 | 接口用于三方app调用银行卡预授权交易,银行卡预授权交易仅冻结用户资金。 |
预授权撤销 | 该接口用于三方app调用银行卡预授权撤销交易。 |
预授权完成 | 该接口用于三方app调用银行卡预授权完成交易。 |
预授权完成撤销 | 该接口用于三方app调用银行卡预授权完成撤销交易。 |
管理类接口
接口名称 | 描述 |
---|---|
操作员登录 | 该接口用于三方app调用操作员登录,将商户和终端绑定。 |
商户号登录 | 该接口用于三方app调用商户号登录,将商户和终端绑定。 |
注销 | 该接口用于三方app退出登录,进行操作员切换。 |
获取商户信息 | 该接口用于三方app获取当前使用商户相关信息。 |
补打签购单 | 该接口用于三方APP调用收银台,补打印历史交易的签购单。 |
换班 | 该接口提供三方app调用换班功能,提供换班相关操作数据。 |
设置 | 该接口提供三方app调用设置功能。 |
数据类接口
接口名称 | 描述 |
---|---|
查询明细 | 该接口用于三方app调用,查询历史交易信息。 |
日对账单 | 该接口提供三方app查询日对账单。 |
交易列表查询 | 该接口提供三方app查询交易列表。 |
余额查询 | 该接口提供查询银行卡余额功能。 |
AT预授权交易列表查询 | 该接口提供三方app查询AT预授权交易列表。 |
AT预授权明细查询 | 该接口提供AT预授权交易查询,返回交易详情。 |
硬件类接口
接口名称 | 描述 |
---|---|
打印机 | 该接口调用设备硬件进行打印。 |
摄像头扫码 | 该接口用设备硬件摄像头并展示相应页面。 |
获取设备信息 | 该接口用设备硬件信息。 |
通知类接口
接口名称 | 描述 |
---|---|
交易结果异步通知 | 该接口提供三方平台接收交易结果异步通知。 |
系统查询类接口
接口名称 | 描述 |
---|---|
交易列表查询接口 | 该接口提供三方平台主动查询终端交易列表。 |
扫码交易详情查询接口 | 该接口提供三方平台主动查询终端扫码交易详情。 |
扫码退款交易详情查询接口 | 该接口提供三方平台主动查询终端扫码退款交易详情。 |
银行卡交易详情查询接口 | 该接口提供三方平台主动查询终端银行卡交易详情。 |