智能終端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預授權交易查詢,返回交易詳情。 |
硬件類接口
接口名稱 | 描述 |
---|---|
打印機 | 該接口調用設備硬件進行打印。 |
攝像頭掃碼 | 該接口用設備硬件攝像頭并展示相應頁面。 |
獲取設備信息 | 該接口用設備硬件信息。 |
通知類接口
接口名稱 | 描述 |
---|---|
交易結果異步通知 | 該接口提供三方平臺接收交易結果異步通知。 |
系統查詢類接口
接口名稱 | 描述 |
---|---|
交易列表查詢接口 | 該接口提供三方平臺主動查詢終端交易列表。 |
掃碼交易詳情查詢接口 | 該接口提供三方平臺主動查詢終端掃碼交易詳情。 |
掃碼退款交易詳情查詢接口 | 該接口提供三方平臺主動查詢終端掃碼退款交易詳情。 |
銀行卡交易詳情查詢接口 | 該接口提供三方平臺主動查詢終端銀行卡交易詳情。 |