目录

pay

接口定义

PendingResult<PayResult> payResult = HuaweiPay.HuaweiPayApi.pay(HuaweiApiClient mClient, PayReq payReq)

接口描述

此接口用于您自行设置商品价格,而不是从华为开发者平台获取价格。此接口不提供商品信息自动全球化能力,需要开发者在接口中指定价格、币种和国家/地区。

请求参数

参数

参数类型

是否必填

描述

payReq

PayReq

是

支付请求参数。

mClient

HuaweiApiClient

是

用于调用IAP SDK接口。

表1 PayReq

参数

是否必选

参数类型

是否参与签名

描述

productName

是

String(0,50)

是

商户对商品的自定义名称。此名称将会在支付时显示给用户确认。该字段中不能包含特殊字符,包括# " & / ? $ ^ *:) \ < > , | % +

productDescription

是

String(0,100)

是

商品描述, 商户对商品的自定义描述 。该字段中不能包含特殊字符,包括# " & / ? $ ^ *:) \ < > , | % +

applicationID

是

String

是

应用ID,在华为开发者联盟上获取的App ID。

requestId

是

String(2,32)

是

商品订单号。

来源:您的应用在支付前生成,用于唯一标识一次支付请求。支付平台在服务器回调接口中会原样返回requestId的值。该字段由字母和数字组成,必须在商户内唯一,用于唯一标识一个商户订单。

amount

是

String

是

商品金额,商品所要支付金额。此金额将会在支付时显示给用户确认。

说明:

请保留小数点后两位,如20.00。如果不按照格式传入金额,会导致支付失败。

merchantId

是

String

是

商户ID。

来源:在华为开发者联盟上获取的“支付ID”。

serviceCatalog

是

String

否

商品类型。

  • X4:主题
  • X5:应用商店
  • X6:游戏
  • X7:天际通
  • X8:云空间
  • X9:电子书
  • X10:华为学习
  • X11:音乐
  • X12 视频
  • V0:vmall实体商品
  • X31:话费充值
  • X32:机票/酒店
  • X33:电影票
  • X34:团购
  • X35:手机预购
  • X36:公共缴费
  • X37:基金理财
  • X38:彩票
  • X39:流量充值

游戏设置为"X6",应用设置为"X5"。如果传入类型错误,会影响风控,请商户按照真实业务类型传入。

merchantName

是

String(0,50)

否

商户名称。

来源:您注册的公司名。

sdkChannel

是

int

是

渠道信息,取值如下:

  • 0代表自有应用,无渠道
  • 1代表应用市场渠道
  • 2代表预装渠道
  • 3代表游戏中心

游戏设置为3,应用设置为1。

url

否

String(0,255)

是

支付结果回调地址 。

华为服务器收到后检查该应用有无在开发者联盟配置回调URL,如果配置了则使用应用配置的URL,否则使用此URL作为该次支付的回调URL。

说明:

必须是合法的URL,长度最大255,不能以“\”结尾,不能包含get参数。

例:

正确:https://domain.com/path

错误:https://domain.com/path?key=value

currency

否

String

是

币种,当前只支持人民币,如果不填写则默认为CNY。

country

否

String

是

国家/地区码,用于区分国家/地区信息。当前只支持中国大陆。

如果不填写则默认为CN。

urlVer

否

String

是

支付结果回调版本。

该值可以不传,如果传值则固定值传2,如果不传2会导致支付不成功。

说明:

该字段拼接至待签名字段序列时,应修改为urlver, 例如urlver=2。

extReserved

否

String(0,128)

否

商户侧保留信息。

若该字段有值,在华为支付服务器回调接口中原样返回。

sign

是

String

否

  1. 取相关参数字段,按参数名的ASCII码的增序排序,若遇到相同首字母,则看第二个字母,以此类推。
    说明:

    参与签名的参数原则如下:

    • 所有payreq携带,标识为“参与签名”且参数值不为null或者“”的参数必须参与签名,签名时参数值必须与payreq传递的保持一致。
    • sign参数不参与签名。
    • 如果有多套密钥时,需要在签名前增加索引前缀,如:1-XXXX。
  2. 排序完成之后,再把所有参数名和参数值的键值对以“&”字符连接起来,得到的字符串即为待签名串。
  3. 将待签名字符串使用RSA私钥进行签名,得到的字符串即为sign参数的值。

返回值

返回值

参数类型

描述

payResult

PendingResult<PayResult>

支付接口请求结果,调用setResultCallback可获取结果回调。

表2 PayResult

参数

参数类型

描述

status

Status

包含接口返回码,IAP收银台页面等信息。接口返回成功时,可通过此对象的startResolutionForResult拉起IAP返回的页面。

调用示例

以下代码片段来源于客户端示例代码,您可直接下载代码工程。相关的类和常量定义等可参见代码工程。

PendingResult<PayResult> payResult =
    HuaweiPay.HuaweiPayApi.pay(mClient, createPayReq("黄金会员", "开通会员服务", "0.01"));
payResult.setResultCallback(new ResultCallback<PayResult>() {
    @Override
    public void onResult(PayResult payResult) {
        if (payResult == null) {
            Log.e("IAP", "payResult is null");
            return;
        }
        Status status = payResult.getStatus();
        if (status == null) {
            Log.e("IAP", "status is null");
            return;
        }
        int rstCode = status.getStatusCode();
        if (rstCode == PayStatusCodes.PAY_STATE_SUCCESS) {
            //启动支付流程
            try {
                status.startResolutionForResult(MainActivity.this, REQUEST_PAY);
            } catch (IntentSender.SendIntentException e) {
                Log.e("IAP", "SendIntentException");
            }
        } else {
            Log.e("IAP", "pay state failed");
        }
    }
});

private PayReq createPayReq(String productName, String productDesc, String amount) {
    Map<String, Object> params = new HashMap<String, Object>();
    params.put(HwPayConstant.KEY_MERCHANTID, Constant.getMerchantID());
    params.put(HwPayConstant.KEY_APPLICATIONID, Constant.getAppID());
    params.put(HwPayConstant.KEY_PRODUCTNAME, productName);
    params.put(HwPayConstant.KEY_PRODUCTDESC, productDesc);
    requestID = Util.getRequestID();
    params.put(HwPayConstant.KEY_REQUESTID, requestID);
    params.put(HwPayConstant.KEY_SDKCHANNEL, 1);
    params.put(HwPayConstant.KEY_URLVER, "2");
    params.put(HwPayConstant.KEY_AMOUNT, Util.getAmount(amount));
    params.put(HwPayConstant.KEY_URL, "https://selfURL.cn");

    params.put(HwPayConstant.KEY_COUNTRY, "CN");
    params.put(HwPayConstant.KEY_CURRENCY, "CNY");

    // 强烈建议在 商户服务端做签名处理,且私钥存储在服务端
    // PaySignUtil为自定义签名工具类,实现方法可参加示例代码
    String noSign = PaySignUtil.getSignData(params);
    String sign = PaySignUtil.rsaSign(noSign);

    PayReq payReq = new PayReq();
    // 商品名称 必填。 此名称将会在支付时显示给用户确认 注意:该字段中不能包含特殊字符,包括# " & / ? $ ^ *:) \ < > ,
    payReq.productName = (String) params.get(HwPayConstant.KEY_PRODUCTNAME);

    // 商品描述 必填。注意:该字段中不能包含特殊字符,包括# " & / ? $ ^ *:) \ < > , |
     payReq.productDesc = (String) params.get(HwPayConstant.KEY_PRODUCTDESC);

    // 商户ID 必填。 由华为开发者联盟分配
    payReq.merchantId = Constant.getMerchantID();

    // 应用ID 必填 由华为开发者联盟分配
    payReq.applicationID = (String) params.get(HwPayConstant.KEY_APPLICATIONID);

    // 待支付金额 必填 。格式为:元.角分,最小金额为分, 例如:20.00,此金额将会在支付时显示给用户确认),保留到小数点后两位
    payReq.amount = (String) params.get(HwPayConstant.KEY_AMOUNT);

    // 请求订单号 必填。其值由商户定义生成,用于标识一次支付请求,每次请求需唯一,不可重复。
    // 支付平台在服务器回调接口中会原样返回requestId的值。
    // 注意:该字段中不能包含特殊字符,包括# " & / ? $ ^ *:) \ < > , |
    payReq.requestId = (String) params.get(HwPayConstant.KEY_REQUESTID);

    // 支付结果回调URL 选填, 华为服务器收到后检查该应用有无在开发者联盟配置回调URL,如果配置了则使用应用配置的URL,否则使用此url
    // 作为该次支付的回调URL
    // 建议直接 以配置在 华为开发者联盟的回调URL为准
    payReq.url = (String) params.get(HwPayConstant.KEY_URL);

    // 渠道信息,选填。 取值如下:0 代表自有应用,无渠道 1 代表智汇云渠道 2 代表预装渠道 3 代表游戏吧
    payReq.sdkChannel = (Integer) params.get(HwPayConstant.KEY_SDKCHANNEL);

    // 回调接口版本号, 选填。 建议传值2, 额外回调信息,具体参考接口文档
    payReq.urlVer = (String) params.get(HwPayConstant.KEY_URLVER);

    // 国家/地区码 选填。建议无特殊需要,不传
    payReq.country = (String) params.get(HwPayConstant.KEY_COUNTRY);
    // 币种 选填。建议无特殊需要不传此参数。目前仅支持CNY,默认CNY
    payReq.currency = (String) params.get(HwPayConstant.KEY_CURRENCY);

    /* 以上字段皆需要参与签名 * */

    // 签名字段 必填。采用华为开发者联盟分配的私钥进行签名,强烈建议在服务端进行签名 .
    // 【注意】以下参数不参与签名:
    // a)sign参数
    // b)参数说明中标识不参与签名的参数
    // c)没有值的参数,包括null和“”两种情况
    // 2、排序完成之后,再把所有参数名和参数值的键值对以“&”字符连接起来,得到的字符串即为待签名串。如:
    // amount=XXX&applicationID=XXX&country=XXX&currency=XXX&merchantId=XXX&productDesc=XXX&productName=XXX&requestId=XXX&
    //sdkChannel=XXX&url=XXX&urlver=XXX
    // 3、将待签名字符串使用RSA私钥进行签名,采用 SHA256WithRSA签名算法 得到的字符串即为sign参数的值
    payReq.sign = sign;

    // 商户名称,必填,不参与签名。会显示在支付结果页面
    payReq.merchantName = getString(R.string.merchantName);

    // 分类,选填,不参与签名。该字段会影响风控策略
    // X4:主题  X5:应用商店 X6:游戏 X7:天际通 X8:云空间 X9:电子书  X10:华为学习  X11:音乐  X12 视频
    // X31 话费充值   X32 机票/酒店   X33 电影票  X34 团购  X35 手机预购  X36 公共缴费   X39 流量充值
    payReq.serviceCatalog = "X6";

    return payReq;
}