Paymax Android SDK 使用文档

一、下载

在 https://www.paymax.cc 下载Android SDK，下载列表如下包含：

下载列表

注：要求jdk版本最低为1.7

二、快速体验

Paymax SDK 为开发者提供了demo 程序，可以快速体验 Paymax 接入流程。下载 Paymax SDK 之后将整个目录导入到您的 Android Studio 中。

使用 Android Studio 时，请选择 File → Open...→ PaymaxDemo

图片名称

三、快速集成

导入 Paymax SDK

Android Studio
  1. 在你的项目里创建 libs 目录:将项目切换到project模式，定位到你的module，右击 New → Directory→ 输入 libs→ OK
  2. 将下载的 paymax.jar 复制、粘贴到 libs 目录
  3. 同时将下载的微信 libammsdk.jar 、支付宝 alipaySdk-20160516 官方jar文件复制、粘贴到 libs 目录
  4. 找到module的 build.gradle → dependencies 填写
  1.      compile fileTree(dir: 'libs', include: ['*.jar'])

  1. 如果需要使用拉卡拉支付与人脸识别, 找到release → libs目录, 将其放置到与您项目并行目录下, 并在您项目的gradle文件进行如下配置

    1.  repositories {
    2.      flatDir {
    3.          dirs '../../libs'
    4.      }
    5.  }
    7.  dependencies {
    8.  compile fileTree(dir: 'libs', include: ['*.jar'])
    9.  compile(name: 'facesdk-release', ext: 'aar')
    10.  compile(name: 'lkl-pay-sdk-release', ext: 'aar')
    11.  compile(name: 'camera-release', ext: 'aar')
    12.  compile(name: 'idcardcaptorsdk-release', ext: 'aar')
    13.  compile(name: 'livenessdetectorsdk-release', ext: 'aar')
    14.  compile(name: 'livenessdetectionviewsdk-release', ext: 'aar')
    15.  compile files('../../libs/paymax.jar')
    16.  }
权限声明
  1. <!-- 微信和支付宝公共权限 -->
  2. <uses-permission android:name="android.permission.INTERNET" />
  4. <!-- 微信所需权限 -->
  5. <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
  7. <!-- 支付宝所需权限 -->
  8. <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
  9. <uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
  10. <uses-permission android:name="android.permission.READ_PHONE_STATE" />
  12. <!-- 拉卡拉 -->
  13. <uses-permission android:name="android.permission.RECEIVE_USER_PRESENT" />
  14. <uses-permission android:name="android.permission.WAKE_LOCK" />
  15. <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
  16. <uses-permission android:name="android.permission.SYSTEM_ALERT_WINDOW" />
  17. <uses-permission android:name="android.permission.MOUNT_UNMOUNT_FILESYSTEMS" />
  18. <uses-permission android:name="android.permission.VIBRATE" />
  19. <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
  20. <uses-permission android:name="android.permission.CHANGE_WIFI_STATE" />
  21. <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
  22. <uses-permission android:name="android.permission.WRITE_SETTINGS" />
  24. <!--人脸识别-->
  25. <uses-permission android:name="android.permission.CAMERA" />
  27. <uses-feature android:name="android.hardware.camera" />
  28. <uses-feature android:name="android.hardware.camera.autofocus" />
注册 activity
  1.  <!--人脸识别-->
  2.   <activity
  3.         android:name="com.swwx.facesdk.ui.FaceLivenessActivity"
  4.         android:screenOrientation="portrait" />
  7.  <!-- 注册微信 -->
  8.    <activity
  9.         android:name="com.swwx.paymax.PaymentActivity"
  10.         android:launchMode="singleTop"
  11.         android:theme="@android:style/Theme.Translucent.NoTitleBar" />
  13.    <activity-alias
  14.         android:name=".wxapi.WXPayEntryActivity"
  15.         android:exported="true"
  16.         android:targetActivity="com.swwx.paymax.PaymentActivity" />
  19.  <!-- 注册支付宝 -->
  20.     <activity
  21.         android:name="com.alipay.sdk.app.H5PayActivity"
  22.         android:configChanges="orientation|keyboardHidden|navigation|screenSize"
  23.         android:exported="false"
  24.         android:screenOrientation="behind"
  25.         android:windowSoftInputMode="adjustResize|stateHidden" >
  26.     </activity>   
  29.  <!-- 注册拉卡拉 -->
  31.     <activity
  32.         android:name="com.lkl.pay.ui.activity.SDK_StartJarActivity"
  33.         android:screenOrientation="portrait"
  34.         android:theme="@android:style/Theme.Translucent"  />
  35.     <activity
  36.         android:name="com.lkl.pay.ui.activity.SDK_LoginActivity"
  37.         android:screenOrientation="portrait" >
  38.     </activity>
  39.     <activity
  40.         android:name="com.lkl.pay.ui.activity.SDK_MsgLoginActivity"
  41.         android:screenOrientation="portrait" >
  42.     </activity>
  43.     <activity
  44.         android:name="com.lkl.pay.ui.activity.cardPay.BindCreditCardActivity"
  45.         android:screenOrientation="portrait" >
  46.     </activity>
  47.     <activity
  48.         android:name="com.lkl.pay.ui.activity.cardPay.BindDebitCardActivity"
  49.         android:screenOrientation="portrait" >
  50.     </activity>
  51.     <activity
  52.         android:name="com.lkl.pay.ui.activity.cardPay.HtmlProtocolActivity"
  53.         android:screenOrientation="portrait" >
  54.     </activity>
  55.     <activity
  56.         android:name="com.lkl.pay.ui.activity.cardPay.InputCardNoActivity"
  57.         android:screenOrientation="portrait" />
  58.     <activity
  59.         android:name="com.lkl.pay.ui.activity.cardPay.InputMessageCodeActivity"
  60.         android:screenOrientation="portrait" />
  61.     <activity
  62.         android:name="com.lkl.pay.ui.activity.forget.FindLoginPwdActivity"
  63.         android:screenOrientation="portrait" />
  64.     <activity
  65.         android:name="com.lkl.pay.ui.activity.forget.SetLoginPwdActivity"
  66.         android:screenOrientation="portrait" />
  67.     <activity
  68.         android:name="com.lkl.pay.ui.activity.register.SetPayPwdActivity"
  69.         android:screenOrientation="portrait" />
  70.     <activity
  71.         android:name="com.lkl.pay.ui.activity.payResult.SuccessActivity"
  72.         android:screenOrientation="portrait" />
  73.     <activity
  74.         android:name="com.lkl.pay.ui.activity.payResult.FailureActivity"
  75.         android:screenOrientation="portrait" />
  76.     <activity
  77.         android:name="cn.cloudcore.iprotect.plugin.CKbdActivity"
  78.         android:launchMode="singleTask"
  79.         android:configChanges="orientation"
  80.         android:theme="@android:style/Theme.Translucent"
  81.         />

四、人脸识别

说明：为了保证用户资金安全，使用拉卡拉支付必须支持人脸识别

发起支付前，请先通过后台接口判断是否需要调起人脸识别。商户后台通过调用Paymax Server SDK 向paymax服务器发起请求，获得结果码的方式进行判断（已经识别过的用户可不用再次识别验证），详细步骤请参考Demo

如果需要调用，请参考如下内容：

  1. /**
  2.  * 调用人脸识别接口
  3.  *  uId             商户用户号
  4.  *  authorization   商户号
  5.  *  realName        姓名
  6.  *  idCardNo        身份证
  7.  *  act             上下文
  8.  *
  9.  */
  10.  FaceRecoSDK.startReco(String uId, String authorization, String realName, String idCardNo, Activity act);

根据人脸识别结果进行相应处理，如下为理情况，仅供参考：

  1.     /**
  2.      * 人脸识别结果处理
  3.      * @param msg
  4.      */
  5.     public void handleMessage(Message msg) {
  7.         if (response != null) {
  8.             message = response.message;
  9.             switch (response.code) {
  11.                 //人脸识别一致
  12.                 case "ACCORDANCE":
  13.                     ok = true;
  14.                     code = CODE_VERIFY_SUCCESS;
  15.                     break;
  17.                 //人脸识别不一致
  18.                 case "INCONFORMITY":
  19.                     code = CODE_INCONFORMITY;
  20.                     break;
  22.                 //签名验证失败
  23.                 case "VERIFY_FAILED":
  24.                     code = CODE_VERIFY_FAILED;
  25.                     break;
  27.                 //时间戳过期或者提前
  28.                 case "REQUEST_TIMESTAMP_EXPIRE":
  29.                     code = REQUEST_TIMESTAMP_EXPIRE;
  30.                     break;
  32.                 //请求参数不合法
  33.                 case "ILLEGAL_REQUEST_BODY":
  34.                     code = ILLEGAL_REQUEST_BODY;
  35.                     break;
  37.                 //非法参数
  38.                 case "ILLEGAL_ARGUMENT":
  39.                     code = ILLEGAL_ARGUMENT;
  40.                     break;
  42.                 //请求数据非法
  43.                 case "ILLEGAL_DATA":
  44.                     code = ILLEGAL_DATA;
  45.                     break;
  47.                 //身份证号码不一致
  48.                 case "IDCARDNO_ERROR":
  49.                     code = IDCARDNO_ERROR;
  50.                     break;
  52.                 //姓名与身份证号不一致
  53.                 case "REALNME_IDCARD_NOT_SAME":
  54.                     code = REALNME_IDCARD_NOT_SAME;
  55.                     break;
  57.                 //服务器内部异常
  58.                 case "SERVER_ERROR":
  59.                     code = SERVER_ERROR;
  60.                     break;
  61.             }
  63.         }

五、获得 Charge

Charge 对象是一个包含支付信息的 JSON 对象，是 Paymax SDK 发起支付的必要参数。该参数需要请求用户服务器获得，服务端生成 charge 的方式参考 [Paymax 官方文档]。SDK 中的 demo 里面提供了如何获取 charge 的实例方法，供用户参考。

六、发起支付

  1. /**
  2.  * 发起支付
  3.  * @param activity
  4.  * @param charge   与服务器交互后的充值要素
  5.  * @param callback  充值结果回调接口
  6.  */
  8. PaymaxSDK.pay(Activity activity, String charge, PaymaxCallback callback);

七、获取支付状态

从 PaymaxCallback 的 onPayFinished() 方法中获得支付结果。支付成功后，用户服务器也会收到Paymax 服务器发送的异步通知。 最终支付成功请根据服务端异步通知为准。

  1. @Override
  2.  public void onPayFinished(PayResult result) {
  3.     String msg = "Unknow";
  4.     switch (result.getCode()) {
  5.         case Paymax.CODE_SUCCESS:
  6.             //支付成功
  7.             msg = "Complete, Success!";
  8.             break;
  10.         case Paymax.CODE_ERROR_CHARGE_JSON:
  11.             //非空格式
  12.             msg = "charge string isn't a json string error.";
  13.             break;
  15.         case Paymax.CODE_FAIL_CANCEL:
  16.             //用户取消
  17.             msg = "cancel pay.";
  18.             break;
  20.         case Paymax.CODE_ERROR_CHARGE_PARAMETER:
  21.             //字段不全
  22.             msg = "some charge paramters error.";
  23.             break;
  25.         case Paymax.CODE_ERROR_WX_NOT_INSTALL:
  26.             //微信未安装
  27.             msg = "wx not install.";
  28.             break;
  30.         case Paymax.CODE_ERROR_WX_NOT_SUPPORT_PAY:
  31.             //微信版本不支持
  32.             msg = "ex not support pay.";
  33.             break;
  35.         case Paymax.CODE_ERROR_WX_UNKNOW:
  36.             //微信未知错误
  37.             msg = "wechat failed.";
  38.             break;
  40.         case Paymax.CODE_ERROR_ALI_DEAL:
  41.             //支付宝正在处理中
  42.             msg = "alipay dealing.";
  43.             break;
  45.         case Paymax.CODE_ERROR_CONNECT:
  46.             //支付宝网络连接错误
  47.             msg = "alipay network connection failed.";
  48.             break;
  50.         case PaymaxSDK.CODE_ERROR_CHANNEL:
  51.             //渠道错误
  52.             msg = "channel error.";
  53.             break;
  55.         case PaymaxSDK.CODE_ERROR_LAK_USER_NO_NULL:
  56.             //拉卡拉商户用户号为空
  57.             msg = "lklpay user no is null.";
  58.             break;
  60.     }

注意事项

Android 不允许在 UI 线程中进行网络请求，所以请求 charge 对象的时候请使用 thread+handler 或者使用 AsyncTask 。example 里面的示例程序使用的就是 AsyncTask 方式请求 charge 对象。

混淆设置

用户进行 apk 混淆打包的时候，为了不影响 Paymax SDK 以及渠道 SDK 的使用，请在 proguard-rules 中添加一下混淆规则。

  1. -dontwarn com.alipay.**
  2. -keep class com.alipay.** {*;}
  4. -dontwarn  com.tencent.**
  5. -keep class com.tencent.** {*;}
  7. -dontwarn com.swwx.paymax.**
  8. -keep class com.swwx.paymax.** {*;}
  10. -dontwarn com.lkl.**
  11. -keep class com.lkl.** {*;}

日志开关

SDK 提供了日志功能，默认日志为关闭状态。 开发者可以通过下面设置打开日志开关。通过 PaymaxSDK 来对日志进行筛选。

  1. PayLog.DEBUG = true;