智能終端APP接入
最近更新時(shí)間:2022.12.27
本文檔主要描述了匯付數(shù)據(jù)智能POS標(biāo)準(zhǔn)第三方接入的規(guī)范,其中調(diào)用方式主要為SDK調(diào)用。
接入流程
開(kāi)發(fā)機(jī)申請(qǐng)
開(kāi)始接入前,需申請(qǐng)聯(lián)調(diào)開(kāi)發(fā)測(cè)試終端,所有聯(lián)調(diào)均在生產(chǎn)環(huán)境進(jìn)行調(diào)試。業(yè)務(wù)方聯(lián)系對(duì)應(yīng)匯付業(yè)務(wù)對(duì)接人員,匯付業(yè)務(wù)會(huì)內(nèi)部申請(qǐng)專用聯(lián)調(diào)開(kāi)發(fā)機(jī)提供給對(duì)接方。聯(lián)調(diào)開(kāi)發(fā)機(jī)中會(huì)有明確圖標(biāo)表示為開(kāi)發(fā)機(jī),僅開(kāi)發(fā)機(jī)可自行安裝app進(jìn)行調(diào)試且開(kāi)發(fā)機(jī)不可用于真實(shí)商戶收款。

測(cè)試商戶
終端調(diào)試需使用調(diào)試商戶,生產(chǎn)環(huán)境聯(lián)調(diào)中,客戶可自行準(zhǔn)備生產(chǎn)環(huán)境測(cè)試商戶。如客戶無(wú)法準(zhǔn)備測(cè)試商戶,可咨詢相關(guān)運(yùn)營(yíng)協(xié)助提供開(kāi)發(fā)聯(lián)調(diào)商戶。
上架發(fā)布
當(dāng)客戶聯(lián)調(diào)完成后,需進(jìn)行應(yīng)用上架匯付應(yīng)用市場(chǎng)進(jìn)行生產(chǎn)驗(yàn)證。客戶將最終確定的app包進(jìn)行簽名打包,打包時(shí)必須包含V1簽名。并將app包郵件發(fā)送匯付運(yùn)營(yíng),提供相關(guān)app功能說(shuō)明及版本說(shuō)明,提供推送終端編號(hào)。
接入流程圖

總體思路如下: 基于POS智能終端安裝三方app,通過(guò)引入SDK并調(diào)用SDK接口,決定收銀臺(tái)展現(xiàn)頁(yè)面。
接入說(shuō)明
SDK文件下載
當(dāng)前版本:V1.0.3
Androidx版本點(diǎn)我下載
Android support版本點(diǎn)我下載
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() 方法中調(diào)用 PnrDevice.getInstance(this).init();
SDK調(diào)用
Androidx版本demo下載
Android support版本demo下載
日志規(guī)范
-
每天的日志寫入同一個(gè)文件并以當(dāng)天日期{yyyyMMdd}命名;
-
日志寫入終端本地路徑: mtms/log/outapp/{ APP應(yīng)用包名} /{yyyyMMdd}.log;
-
應(yīng)用內(nèi)日志保留時(shí)間為15天,過(guò)期日志應(yīng)及時(shí)刪除。
注:在SDK中已經(jīng)集成了日志保存邏輯,只需要使用Timber輸出日志即可完成日志寫入。
API接口匯總
以下為調(diào)用的api接口匯總。
支付類接口
接口名稱 | 描述 |
---|---|
消費(fèi) | 該接口用于三方app調(diào)用發(fā)起消費(fèi)收款,支持銀行卡、反掃、正掃聚合支付。 |
消費(fèi)撤銷 | 該接口用于三方app調(diào)用發(fā)起消費(fèi)撤銷。 |
消費(fèi)退款 | 該接口用于三方app調(diào)用發(fā)起消費(fèi)退款。 |
花唄分期 | 該接口用于三方app調(diào)用發(fā)起花唄分期交易,支持支付寶花唄分期。 |
預(yù)授權(quán) | 接口用于三方app調(diào)用銀行卡預(yù)授權(quán)交易,銀行卡預(yù)授權(quán)交易僅凍結(jié)用戶資金。 |
預(yù)授權(quán)撤銷 | 該接口用于三方app調(diào)用銀行卡預(yù)授權(quán)撤銷交易。 |
預(yù)授權(quán)完成 | 該接口用于三方app調(diào)用銀行卡預(yù)授權(quán)完成交易。 |
預(yù)授權(quán)完成撤銷 | 該接口用于三方app調(diào)用銀行卡預(yù)授權(quán)完成撤銷交易。 |
管理類接口
接口名稱 | 描述 |
---|---|
操作員登錄 | 該接口用于三方app調(diào)用操作員登錄,將商戶和終端綁定。 |
商戶號(hào)登錄 | 該接口用于三方app調(diào)用商戶號(hào)登錄,將商戶和終端綁定。 |
注銷 | 該接口用于三方app退出登錄,進(jìn)行操作員切換。 |
獲取商戶信息 | 該接口用于三方app獲取當(dāng)前使用商戶相關(guān)信息。 |
補(bǔ)打簽購(gòu)單 | 該接口用于三方APP調(diào)用收銀臺(tái),補(bǔ)打印歷史交易的簽購(gòu)單。 |
換班 | 該接口提供三方app調(diào)用換班功能,提供換班相關(guān)操作數(shù)據(jù)。 |
設(shè)置 | 該接口提供三方app調(diào)用設(shè)置功能。 |
數(shù)據(jù)類接口
接口名稱 | 描述 |
---|---|
查詢明細(xì) | 該接口用于三方app調(diào)用,查詢歷史交易信息。 |
日對(duì)賬單 | 該接口提供三方app查詢?nèi)諏?duì)賬單。 |
交易列表查詢 | 該接口提供三方app查詢交易列表。 |
余額查詢 | 該接口提供查詢銀行卡余額功能。 |
AT預(yù)授權(quán)交易列表查詢 | 該接口提供三方app查詢AT預(yù)授權(quán)交易列表。 |
AT預(yù)授權(quán)明細(xì)查詢 | 該接口提供AT預(yù)授權(quán)交易查詢,返回交易詳情。 |
硬件類接口
接口名稱 | 描述 |
---|---|
打印機(jī) | 該接口調(diào)用設(shè)備硬件進(jìn)行打印。 |
攝像頭掃碼 | 該接口用設(shè)備硬件攝像頭并展示相應(yīng)頁(yè)面。 |
獲取設(shè)備信息 | 該接口用設(shè)備硬件信息。 |
通知類接口
接口名稱 | 描述 |
---|---|
交易結(jié)果異步通知 | 該接口提供三方平臺(tái)接收交易結(jié)果異步通知。 |
系統(tǒng)查詢類接口
接口名稱 | 描述 |
---|---|
交易列表查詢接口 | 該接口提供三方平臺(tái)主動(dòng)查詢終端交易列表。 |
掃碼交易詳情查詢接口 | 該接口提供三方平臺(tái)主動(dòng)查詢終端掃碼交易詳情。 |
掃碼退款交易詳情查詢接口 | 該接口提供三方平臺(tái)主動(dòng)查詢終端掃碼退款交易詳情。 |
銀行卡交易詳情查詢接口 | 該接口提供三方平臺(tái)主動(dòng)查詢終端銀行卡交易詳情。 |