Android SDK开发接入

1.SDK简介

1.1 前言

合码云 Android SDK集成了各种支付方式,第三方通过调用本 SDK,可以轻松将支付宝,微 信,百度钱包,京东钱包支付等多种支付方式集成到自己的应用。

1.2 主要功能

• 激活: 新的终端使用 SDK,需要先激活终端,才可以进行交易
• 付款: 支持支付宝、微信、百度钱包、京东钱包支付
• 退款: 对已经支付成功的订单进行退款操作
• 查询: 对已经支付的订单查询
• 撤单: 直接取消某一笔交易
• 预下单: 支持支付宝、微信、百度钱包、京东钱包支付

1.3 框架设计

第三方用户通过集成合码云 SDK,面对前方商户提供多种可选的支付方式,同时喔噻可以将交易 路由至支付宝,微信等服务器。

1.4 工作模式

1.4.1、SDK 标准界面模式

SDK 默认的工作模式,激活、付款、退款、撤单、预下单集成了 UI 界面,不需要特别配置。

1.4.2、SDK 无界面标准模式

SDK 无界面的工作模式,在调用接口时,需要在 UpayOrder 订单参数中指定调用模式为 setPayModel(UpayOrder.PayModel.NO_UI)。

2.开发指南

下载最新版的SDK。为保证您的财产和数据安全，请勿使用从其他非h合码云渠道获取的SDK。对由于使用了非官方SDK而导致的任何物质或非物质损失，收钱吧概不负责。

3.集成步骤

3.1 Eclipse下集成SDK

3.1.1 解压 SDK,得到以下文件夹;

3.1.2 打开 eclipse 文件夹,将文件夹下面的 libs,与 res 文件夹 copy 到集成的项目中

3.1.3 在 AndroidManifest.xml 中声明以下权限;

<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" /> 
<uses-permission android:name="android.permission.BLUETOOTH" /> 
<uses-permission android:name="android.permission.BLUETOOTH_ADMIN" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />  
<uses-permission android:name="android.permission.READ_PHONE_STATE" /> 
<uses-permission android:name="android.permission.INTERNET" /> 

<!--允许程序读取或写入系统设置 -->
<uses-permission android:name="android.permission.WRITE_SETTINGS" />
<!-- GPS 定位权限 -->
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" /> 
<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" /> 
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" /> 
<uses-permission android:name="android.permission.CHANGE_WIFI_STATE" />

<!-- SD 卡读取权限,用户写入离线定位数据-->
<uses-permission android:name="android.permission.MOUNT_UNMOUNT_FILESYSTEMS"/> 
<uses-permission android:name="android.permission.WAKE_LOCK" /> 
<uses-permission android:name="android.permission.CAMERA" />
<uses-permission android:name="android.permission.VIBRATE" />
<uses-permission android:name="android.permission.FLASHLIGHT" /> 
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" /> 
<uses-permission android:name="android.permission.REORDER_TASKS" /> 
<uses-permission android:name="android.permission.VIBRATE" />

3.1.4、在 AndroidManifest.xml 中声明以下 SDK 用到的 activity、service、receiver;

<activity
    android:name="com.wosai.upay.ui.MainActivity" 
    android:theme="@style/AppBaseTheme"
    android:configChanges="keyboardHidden|orientation|screenSize" 
    android:windowSoftInputMode="stateHidden|adjustResize">
</activity>
<activity
    android:name="com.wosai.upay.zbar.activity.CaptureActivity"
    android:theme="@style/AppBaseTheme"
    android:windowSoftInputMode="adjustPan">
</activity>
<receiver
    android:name="com.wosai.upay.common.UpayTask$MyBroadcastReceiver"
     android:exported="false">
    <intent-filter>
        <action android:name="com.wosai.upay" /> 
    </intent-filter>
</receiver>
<meta-data
    android:name="com.baidu.lbsapi.API_KEY"
    android:value="jb5QfTeGACZiPIUBx9ZwIC82" />
<service android:name="com.baidu.location.f" 
    android:enabled="true" android:process=":remote">
</service>

3.1.5、初始化 SDK,在程序入口处初始化 SDK,如果初始化提示 AndroidManifest.xml 文件配置 有误,请检查配置文件;

/**
* initUpay 初始化 UpayTask
* @param context 上下文对象
* @param isPlaySound 是否打开交易完成时,成功和失败的提示声音 
* @param urlType 服务器地址类型:DEV:开发环境,PRO:生产环境 
*/
DebugConfig.setDebug(true);//默认为非调试模式,如果需要调试,请设置为 true,打印和保存相关日志
UpayTask.getInstance().initUpay(context,isPlaySound,Env.UrlType.PRO);

3.2 Android Studio下集成SDK

3.2.1、解压 SDK,得到以下文件夹:

3.2.2、打开 studio 文件夹,拷贝 SQB-Android-SDK-x.x.x.aar 结尾的压缩包到项目的 libs 下:

3.2.3、在 build.gradle 文件中添加以下代码;

repositories { 
    flatDir {
        dirs 'libs' 
    }
}
dependencies {
    compile(name: 'HMY-Android-SDK-2.1.0', ext: 'aar'))//name 后面紧跟的为引入的 aar 包名 
}

3.2.4、初始化 SDK,在程序入口处初始化 SDK,如果初始化提示 AndroidManifest.xml 文件配置 有误,请检查配置文件;

/**
* initUpay 初始化 UpayTask
* @param context 上下文对象
* @param isPlaySound 是否打开交易完成时,成功和失败的提示声音 
* @param urlType 服务器地址类型:DEV:开发环境,PRO:生产环境 
*/
DebugConfig.setDebug(true);//默认为非调试模式,如果需要调试,请设置为 true,打印和保存相关日志
UpayTask.getInstance().initUpay(context,isPlaySound,Env.UrlType.PRO);

3.2.5、SDK 成功集成到项目

4.重要参数说明

4.1 UpayTask类

4.1.1、UpayTask 对象获取

UpayTask.getInstance()

4.1.2 UpayTask方法说明

激活

/**
* activate 激活
* @param code 激活码内容
* @param vendor_id 服务商 ID
* @param vendor_key 服务商 KEY 
* @param appId 服务商应用ID
* @param deviceSn 设备号
* @param deviceName 设备名称
* @param payModel 支付模式
* @param callBack 请求回调
*/
public void activate(String code, String vendor_id, String vendor_key,String appId,String deviceSn,String deviceName, UpayOrder.PayModel payModel, UpayCallBack callBack)

检查终端是否激活

/**
 * 终端是否已经激活
 * @return true:终端已激活，false：终端未激活
 */
 public boolean isActivated()

付款

/**
* pay 付款
* @param order 业务订单类 
* @param callBack 请求回调 
*/
public void pay(UpayOrder order, UpayCallBack callBack)

退款

/**
* refund 退款
* @param order 业务订单类 
* @param callBack 请求回调 
*/
public void refund(UpayOrder order, UpayCallBack callBack)

查询

/**
* query 查询
* @param order 业务订单类 
* @param callBack 请求回调 
*/
public void query(UpayOrder order, UpayCallBack callBack)

撤单

/**
* revoke 撤单(退货)
* @param order 业务订单类 
* @param callBack 请求回调 
*/
public void revoke(UpayOrder order, UpayCallBack callBack)

预下单

/**
* preCreate 预下单
* @param order 业务订单类 
* @param callBack 请求回调 
*/
public void preCreate(UpayOrder order, UpayCallBack callBack)

横竖屏设置

/**
* 设置UI横屏显示
* 如果发现SDK的UI无法适配屏幕分辨率，调用这个方法
* @param horizontalScreen
*/
public void setHorizontalScreen(boolean horizontalScreen)
/**
* 设置UI竖屏显示
* 如果发现SDK的UI无法适配屏幕分辨率，调用这个方法
* @param verticalScreen
*/
public void setVerticalScreen(boolean verticalScreen)

4.2 UpayOrder类说明

4.3 UpayResult类说明

payway支付方式列表

未来会不断补充

4.4 UpayResult中result_code 状态码说明

备注

• 如果 激活 接口 result_code返回的不是 ACTIVATE_SUCCESS，则认为激活失败
• 如果 付款 接口 result_code返回的不是 PAY_SUCCESS，则认为付款失败
• 如果 退款 接口 result_code返回的不是 REFUND_SUCCESS，则认为退款失败
• 如果 撤单 接口 result_code返回的不是 CANCEL_SUCCESS 或者 CANCEL_ABORT_SUCCESS 则认为撤单失败
• 如果 预下单 接口 result_code返回的不是 PRECREATE_SUCCESS，则认为预下单失败
• 如果 查询 接口 result_code返回的不是 SUCCESS，则认为查询失败
• 如果 result_code 返回值为 null 或者 0，通过 error_code 和 error_message 信息处理。
• 如果 result_code 返回的是失败响应码,可先通过 error_code 和 error_message 信息处理,如果不存在 error_code 和 error_message,再根据 result_code 的含义及下一步处理。

5.SDK有界面模式调用示例

5.1 激活

String vendorId = "10298371039";//服务商 ID
String vendorKey = "68d499beda5f72116592f5c527465656";//服务商 KEY
String appId="12313123223";  //服务商应用ID
String deviceSn="213213343323"; //商户设备号，在商户下要唯一，非必传
String deviceName="设备名"; //商户设备名，非必传
UpayTask.getInstance().activate("", vendorId, vendorKey, appId, deviceSn, deviceName
UpayOrder.PayModel.UI, new UpayCallBack() { 
    @Override
    public void onExecuteResult(UpayResult result) {
        //回调结果,请参考 UpayResult 类说明,根据回调结果添加自己的业务逻辑的处理
    } 
});

5.2 支付

UpayOrder order = new UpayOrder(); 
order.setClient_sn("client1241241");//商户订单号 
order.setTotal_amount("100");//交易总金额 order.setPayway("1");//支付方式 
order.setSubject("Android SDK");//交易简介 
order.setOperator("操作员 007");//门店操作员 
order.setDescription("餐饮");//商品详情 
order.setReflect("测试反射参数");//反射参数 

UpayTask.getInstance().pay(order, new UpayCallBack() {
    @Override
    public void onExecuteResult(UpayResult result) {
        //回调结果,请参考 UpayResult 类说明,根据回调结果添加自己的业务逻辑的处理
    } 
});

5.3 退款

UpayOrder order = new UpayOrder();
order.setSn("7894259244086017");//合码云订单号
order.setClient_sn("client1241241");//商户订单号 
order.setRefund_request_no("23524241");//退款序列号
order.setOperator("操作员 007");//操作员
order.setRefund_amount("100");//退款金额
order.setReflect("测试反射参数");//反射参数
order.setRefundModel(UpayOrder.RefundModel.CLIENT_SN);//指定退款模式为商户订单号退款 

UpayTask.getInstance().refund(order, new UpayCallBack() {
    @Override
    public void onExecuteResult(UpayResult result) {
        //回调结果,请参考 UpayResult 类说明,根据回调结果添加自己的业务逻辑的处理
    } 
});

5.4 撤单

UpayOrder order = new UpayOrder(); 
order.setSn("7894259244086017");//合码云订单号 
order.setClient_sn("client1241241");//商户订单号 
order.setReflect("测试反射参数");//反射参数
order.setRevokeModel(UpayOrder.RevokeModel.CLIENT_SN);//指定退款模式为商户订单号退款

UpayTask.getInstance().revoke(order, new UpayCallBack() { 
    @Override
    public void onExecuteResult(UpayResult result) {
        //回调结果,请参考 UpayResult 类说明,根据回调结果添加自己的业务逻辑的处理
    } 
});

5.5 预下单

UpayOrder order = new UpayOrder();
order.setClient_sn("client1241241");//商户订单号 
order.setTotal_amount("100");//交易总金额 
order.setPayway("1");//支付方式
order.setSubject("Android SDK");//交易简介
order.setOperator("操作员 007");//门店操作员
order.setDescription("餐饮");//商品详情
order.setReflect("测试反射参数");//反射参数 

UpayTask.getInstance().preCreate(order, new UpayCallBack() {
    @Override
    public void onExecuteResult(UpayResult result) {
    //回调结果,请参考 UpayResult 类说明,根据回调结果添加自己的业务逻辑的处理
    } 
});

6.SDK无界面模式调用示例

6.1 激活

String code = "131451574136";//激活码
String vendorId = "10298371039";//服务商 ID
String vendorKey = "68d499beda5f72116592f5c527465656";//服务商 KEY
String appId="12313123223";  //服务商应用ID
String deviceSn="213213343323"; //商户设备号，在商户下要唯一，非必传
String deviceName="设备名"; //商户设备名，非必传

UpayTask.getInstance().activate(code, vendorId, vendorKey,appId,deviceSn, deviceName
UpayOrder.PayModel.NO_UI, new UpayCallBack() { 
    @Override
    public void onExecuteResult(UpayResult result) {
    //回调结果,请参考 UpayResult 类说明,根据回调结果添加自己的业务逻辑的处理
    } 
});

6.2 支付

UpayOrder order = new UpayOrder();
order.setClient_sn("client1241241");//商户订单号 
order.setTotal_amount("100");//交易总金额 order.setPayway("1");//支付方式 
order.setDynamic_id("285362899388441557");//付款码内容 
order.setSubject("Android SDK");//交易简介 
order.setOperator("操作员 007");//门店操作员 
order.setDescription("餐饮");//商品详情 
order.setReflect("测试反射参数");//反射参数
order.setPayModel(UpayOrder.PayModel.NO_UI );//指定 SDK 启动模式为无界面模式

UpayTask.getInstance().pay(order, new UpayCallBack() { 
    @Override
    public void onExecuteResult(UpayResult result) {
        //回调结果,请参考 UpayResult 类说明,根据回调结果添加自己的业务逻辑的处理
    } 
});

6.3 退款

UpayOrder order = new UpayOrder(); 
order.setSn("7894259244086017");//合码云订单号 
order.setClient_sn("client1241241");//商户订单号 
order.setRefund_request_no("23524241");//退款序列号 
order.setOperator("操作员 007");//操作员 
order.setRefund_amount("100");//退款金额 
order.setReflect("测试反射参数");//反射参数 
order.setPayModel(UpayOrder.PayModel.NO_UI);//指定 SDK 启动模式为无界面模式 

UpayTask.getInstance().refund(order, new UpayCallBack() {
    @Override
    public void onExecuteResult(UpayResult result) {
    //回调结果,请参考 UpayResult 类说明,根据回调结果添加自己的业务逻辑的处理
    }
});

6.4 查询

UpayOrder order = new UpayOrder(); 
order.setSn("7894259244086017");//合码云订单号 
order.setClient_sn("client1241241");//商户订单号 

UpayTask.getInstance().query(order, new UpayCallBack() {
    @Override
    public void onExecuteResult(UpayResult result) {
    //回调结果,请参考 UpayResult 类说明,根据回调结果添加自己的业务逻辑的处理
    } 
});

6.5 撤单

UpayOrder order = new UpayOrder(); 
order.setSn("7894259244086017");//合码云订单号 
order.setClient_sn("client1241241");//商户订单号 
order.setReflect("测试反射参数");//反射参数 
order.setPayModel(UpayOrder.PayModel.NO_UI);//指定 SDK 启动模式为无界面模式 

UpayTask.getInstance().revoke(order, new UpayCallBack() {
    @Override
    public void onExecuteResult(UpayResult result) {
        //回调结果,请参考 UpayResult 类说明,根据回调结果添加自己的业务逻辑的处理
    }
});

6.6 预下单

UpayOrder order = new UpayOrder(); 
order.setClient_sn("client1241241");//商户订单号 
order.setTotal_amount("100");//交易总金额
order.setPayway("1");//支付方式
order.setSubject("Android SDK");//交易简介
order.setOperator("操作员 007");//门店操作员 
order.setDescription("餐饮");//商品详情 
order.setReflect("测试反射参数");//反射参数 
order.setPayModel(UpayOrder.PayModel.NO_UI);//指定 SDK 启动模式为无界面模式 

UpayTask.getInstance().preCreate(order, new UpayCallBack() {
    @Override
    public void onExecuteResult(UpayResult result) {
        //回调结果,请参考 UpayResult 类说明,根据回调结果添加自己的业务逻辑的处理
    } 
});

7.本地日志文件存放路径

sdk本地日志格式是txt,日志保存路径：
内部存储路径：/data/data/应用包名/files/
SD卡路径：/Android/data/应用包名/Log/

8.联系我们

如以上信息无法帮助你解决在开发中遇到的问题,请通过一下方式联系我们 邮箱:[email protected] 我们的工程师会在第一时间回复您。