本文档展示了如何从零开始,快速接入蚂蚁金服开放平台App支付产品,完成与支付宝对接的部分。
注意: 文档中的代码示例和Demo是用来阐述API基本使用方法的,仅针对大众场景。供ISV参考,特殊情况还请ISV自行扩展,确保符合自身业务需求。
支付产品全面升级,若您使用的是老接口,请移步老版本移动支付文档。
若您希望从“移动支付”老版本升级为“APP支付”新版本,请参考以下步骤完成“APP支付”新版本的接入工作。若想了解更多关于新版本的升级改造内容,可参考移动支付与APP支付对比。
要在您的应用中接入支付宝App支付能力,需要通过创建应用的方式接入蚂蚁相关接口并进行开发,基于对行业及业务场景痛点的理解,创造能够满足市场需要的解决方案,以应用的形式服务用户。
若还未成为开放平台的入驻服务商或者商户, 请完成入驻指引。入驻完成后,您需要去蚂蚁金服开放平台(open.alipay.com),在开发者中心中创建您的应用,会为您生成应用唯一标识(APPID),并且可以申请开通开放产品使用权限,通过APPID您的应用才能调用开放产品的接口能力。需要详细了解开放平台创建应用步骤请参考《开放平台应用创建指南》。
在创建应用后即生成应用的标识APPID,使用支付宝账号登录开放平台后,在“我的应用”中按下图方式查看APPID。
应用创建完成后,需要给应用添加App支付功能,这样就可以在你的应用里使用App支付能力。此时该应用为开发中状态,只能在沙箱环境下进行调试。应用开发完成后,请开发者自行进行验收和安全性检查(安全性检查可参考《开放平台第三方应用安全开发指南》),验收检查完成后可申请上线。应用申请上线后,会同时申请此列表的功能,接口即生效,这个状态下的应用能够调用生产环境的接口。
在使用这些能力的时候,需要在开放平台里进行签约,这时候约定的合同就生效了。也可以代替商户签约。
为了保证交易双方(商户和支付宝)的身份和数据安全,开发者在调用接口前,需要配置双方密钥,对交易数据进行双方校验。
1、了解下支付宝密钥处理体系:
2、密钥包含:
应用公钥:由商户自己生成的RSA公钥(与应用私钥必须匹配),商户需上传应用公钥到支付宝开放平台,以便支付宝使用该公钥验证该交易是否是商户发起的。
应用私钥:由商户自己生成的RSA私钥(与应用公钥必须匹配),商户开发者使用应用私钥对请求字符串进行加签。
支付宝公钥:支付宝的RSA公钥,商户使用该公钥验证该结果是否是支付宝返回的。
生成密钥后在开放平台开发者中心进行密钥配置,配置完成后可以获取支付宝公钥。具体方法流程请参见上传应用公钥并获取支付宝公钥。
3、配置生成的密钥等应用信息。配置的详细步骤请参考《配置应用环境》。
注:签名验签常见问题排查
支付宝开放平台SDK封装了签名和验签过程,只需配置账号及密钥参数,强烈建议使用。更多签名问题的自助排查流程,可以参考支付宝验签专区的未使用开放平台SDK的自助排查流程。关于同步通知和异步通知的验签规则,可参考验签教程。
更多关于签名教程和签名工具下载等问题,请参见签名专区。
接入app支付需要集成两个SDK,客户端SDK需要集成在商户自己的APP中,用于唤起支付宝客户端APP并发送交易数据,并在支付宝APP返回商户APP时获得支付结果。服务端SDK需要商户集成在自己的服务端系统中,用于下单参数的组装、协助解析并验证客户端同步返回的支付结果和异步通知。
在开始集成和开发前,首先了解一下常用的接入方式和架构建议:
其次,为了保证交易安全,支付宝采用了一系列的安全手段:
1. 采用HTTPS协议传输交易数据,防止数据被截获,解密。
2. 采用RSA非对称密钥,明确交易双方的身份,保证交易主体的正确性和唯一性
了解更多的安全设计指南。
在集成App支付能力时,提供主流移动平台的App提供集成方式。
更多集成说明参见客户端集成说明。
为了验证交易数据的来源,保证交易安全,开发者需要在商家后台对交易数据进行加签、验签,需要集成开放平台服务端SDK。
服务端SDK包含JAVA、PHP和.NET三语言版本,封装了签名&验签、HTTP接口请求等基础功能。请先下载对应语言版本的SDK并引入您的开发工程。
SDK调用前需要进行初始化,代码示例如下:
AlipayClient alipayClient = new DefaultAlipayClient(URL, APP_ID, APP_PRIVATE_KEY, FORMAT, CHARSET, ALIPAY_PUBLIC_KEY, SIGN_TYPE);
关键参数说明:
配置参数 | 示例值解释 | 获取方式/示例值 |
---|---|---|
URL | 支付宝网关(固定) | https://openapi.alipay.com/gateway.do |
APP_ID | APPID即创建应用后生成 | 获取见上面创建应用并获取APPID |
APP_PRIVATE_KEY | 开发者应用私钥,由开发者自己生成 | 获取见上面配置密钥 |
FORMAT | 参数返回格式,只支持json | json(固定) |
CHARSET | 请求和签名使用的字符编码格式,支持GBK和UTF-8 | 开发者根据实际工程编码配置 |
ALIPAY_PUBLIC_KEY | 支付宝公钥,由支付宝生成 | 获取详见上面配置密钥 |
SIGN_TYPE | 商户生成签名字符串所使用的签名算法类型,目前支持RSA2和RSA,推荐使用RSA2 | RSA2 |
接下来,就可以用alipayClient来调用具体的API了。alipayClient只需要初始化一次,后续调用不同的API都可以使用同一个alipayClient对象。
为了避免在线上生产环境联调过程中遇到问题,建议在沙箱环境中联调通过后再在线上生产环境进行联调,具体操作步骤见沙箱联调指南。如果需要在线上调用接口,需要参考下面第六步:应用上线后再进行接口调用,不然会报出“无权限错误”。
系统交互流程如下图:
如图,以Android平台为例(虚线标识商户链路,实线标识支付宝链路):
第4步:调用支付接口:此消息就是本接口所描述的支付宝客户端SDK提供的支付对象PayTask,将商户签名后的订单信息传进payv2方法唤起支付宝收银台,交易数据格式具体参见请求参数说明。
第5步:支付请求:支付宝客户端SDK将会按照商户客户端提供的请求参数发送支付请求。
第8步:接口返回支付结果:商户客户端在第4步中调用的支付接口,会返回最终的支付结果(即同步通知),参见客户端同步返回。
第13步:用户在支付宝APP或H5收银台完成支付后,会根据商户在手机网站支付API中传入的前台回跳地址return_url自动跳转回商户页面,同时在URL请求中附带上支付结果参数。同时,支付宝还会根据原始支付API中传入的异步通知地址notify_url,通过POST请求的形式将支付结果作为参数通知到商户系统,详情见支付结果异步通知。
除了正向支付流程外,支付宝也提供交易查询、关闭、退款、退款查询以及对账等配套API。
特别注意:
App支付API必须通过支付宝提供的移动端SDK来调用。
1.交易查询接口alipay.trade.query:
AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do", APP_ID, APP_PRIVATE_KEY, "json", CHARSET, ALIPAY_PUBLIC_KEY, "RSA2"); //获得初始化的AlipayClient AlipayTradeQueryRequest request = new AlipayTradeQueryRequest();//创建API对应的request类 request.setBizContent("{" + " \"out_trade_no\":\"20150320010101001\"," + " \"trade_no\":\"2014112611001004680073956707\"" + " }");//设置业务参数 AlipayTradeQueryResponse response = alipayClient.execute(request);//通过alipayClient调用API,获得对应的response类 System.out.print(response.getBody()); //根据response中的结果继续业务逻辑处理
关键入参:
参数名称 | 参数说明 |
---|---|
out_trade_no | 支付时传入的商户订单号,与trade_no必填一个 |
trade_no | 支付时返回的支付宝交易号,与out_trade_no必填一个 |
关键出参:
参数名称 | 参数说明 |
---|---|
trade_no | 支付宝28位交易号 |
out_trade_no | 支付时传入的商户订单号 |
trade_status | 交易当前状态 |
2.交易退款接口alipay.trade.refund:
商户由于业务原因如金额错误、用户退货、对账不平等情况可能需要退款,退款的途径按照支付途径原路返回。支付渠道为花呗、余额等退款即时到账。银行卡的退款时间以银行退款时间为准,一般情况下2小时内可到账。可在商户门户(b.alipay.com)中退款;也可使用交易成功的商户订单号或支付宝交易号进行退款 , 支持全额和部分退款,其过程如下图所示:
退款接口调用示例如下:
AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do", APP_ID, APP_PRIVATE_KEY, "json", CHARSET, ALIPAY_PUBLIC_KEY, "RSA2"); //获得初始化的AlipayClient AlipayTradeRefundRequest request = new AlipayTradeRefundRequest();//创建API对应的request类 request.setBizContent("{" + " \"out_trade_no\":\"20150320010101001\"," + " \"trade_no\":\"2014112611001004680073956707\"," + " \"out_request_no\":\"1000001\"," + " \"refund_amount\":\"1\"" + " }");//设置业务参数 AlipayTradeRefundResponse response = alipayClient.execute(request);//通过alipayClient调用API,获得对应的response类 System.out.print(response.getBody()); // 根据response中的结果继续业务逻辑处理
关键入参:
参数名称 | 参数说明 |
---|---|
out_trade_no | 支付时传入的商户订单号,与trade_no必填一个 |
trade_no | 支付时返回的支付宝交易号,与out_trade_no必填一个 |
out_request_no | 本次退款请求流水号,部分退款时必传 |
refund_amount | 本次退款金额 |
关键出参:
参数名称 | 参数说明 |
---|---|
refund_fee | 该笔交易已退款的总金额 |
3.查询对账单下载地址接口alipay.data.dataservice.bill.downloadurl.query:
为了保障交易的正确性,支付宝提供了交易账单数据提供给商户对账,对账说明。
AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do", APP_ID, APP_PRIVATE_KEY, "json", CHARSET, ALIPAY_PUBLIC_KEY, "RSA2"); //获得初始化的AlipayClient AlipayDataDataserviceBillDownloadurlQueryRequest request = new AlipayDataDataserviceBillDownloadurlQueryRequest();//创建API对应的request类 request.setBizContent("{" + " \"bill_type\":\"trade\"," + " \"bill_date\":\"2016-04-05\"" + " }");//设置业务参数 AlipayDataDataserviceBillDownloadurlQueryResponse response = alipayClient.execute(request); System.out.print(response.getBody()); //根据response中的结果继续业务逻辑处理
关键入参:
参数名称 | 参数说明 |
---|---|
bill_type | 固定传入trade |
bill_date | 需要下载的账单日期,最晚是当期日期的前一天 |
关键出参:
参数名称 | 参数说明 |
---|---|
bill_download_url | 账单文件下载地址,30秒有效 |
下载账单文件:
//将接口返回的对账单下载地址传入urlStr String urlStr = "http://dwbillcenter.alipay.com/downloadBillFile.resource?bizType=X&userId=X&fileType=X&bizDates=X&downloadFileName=X&fileId=X"; //指定希望保存的文件路径 String filePath = "/Users/fund_bill_20160405.csv"; URL url = null; HttpURLConnection httpUrlConnection = null; InputStream fis = null; FileOutputStream fos = null; try { url = new URL(urlStr); httpUrlConnection = (HttpURLConnection) url.openConnection(); httpUrlConnection.setConnectTimeout(5 * 1000); httpUrlConnection.setDoInput(true); httpUrlConnection.setDoOutput(true); httpUrlConnection.setUseCaches(false); httpUrlConnection.setRequestMethod("GET"); httpUrlConnection.setRequestProperty("Charsert", "UTF-8"); httpUrlConnection.connect(); fis = httpUrlConnection.getInputStream(); byte[] temp = new byte[1024]; int b; fos = new FileOutputStream(new File(filePath)); while ((b = fis.read(temp)) != -1) { fos.write(temp, 0, b); fos.flush(); } } catch (MalformedURLException e) { e.printStackTrace(); } catch (IOException e) { e.printStackTrace(); } finally { try { fis.close(); fos.close(); httpUrlConnection.disconnect(); } catch (NullPointerException e) { e.printStackTrace(); } catch (IOException e) { e.printStackTrace(); } }
支付能力直接涉及到交易与资金,为了方便开放者调试支付能力,我们已经准备好沙箱环境,包括沙箱环境账号和沙箱版支付宝钱包,这样就可以在沙箱环境调试了。具体操作步骤见沙箱接入指南。
商户本身应用上线时候,也要把支付宝开放平台的应用上线。