本文档展示了如何从零开始，使用蚂蚁金服开放平台服务端SDK快速接入收发现金红包产品，完成与支付宝对接的部分。

注意： 文档中的代码示例和Demo是用来阐述API基本使用方法的，仅针对大众场景。

第一步：创建应用并获取APPID

要在您的应用中使用支付宝开放产品的接口能力，您需要先去蚂蚁金服开放平台（open.alipay.com），在管理中心中创建登记您的应用，并提交审核，审核通过后会为您生成应用唯一标识（APPID），并且可以申请开通开放产品使用权限，通过APPID您的应用才能调用开放产品的接口能力。需要详细了解开放平台创建应用步骤请参考《开放平台应用创建指南》。

第二步：配置密钥

开发者调用接口前需要先生成RSA密钥，RSA密钥包含应用私钥(APP_PRIVATE_KEY)、应用公钥(APP_PUBLIC_KEY）。生成密钥后在开放平台管理中心进行密钥配置，配置完成后可以获取支付宝公钥(ALIPAY_PUBLIC_KEY)。详细步骤请参考《配置应用环境》。

第三步：搭建和配置开发环境

1.下载服务端SDK

为了帮助开发者调用开放接口，我们提供了开放平台服务端SDK，包含JAVA、PHP和.NET三个语言版本，封装了签名&验签、HTTP接口请求等基础功能。请先下载对应语言版本的SDK并引入您的开发工程。 

2.接口调用配置

各语言版本服务端SDK详细使用说明，请参考《服务端SDK使用说明》

在SDK调用前需要进行初始化，代码如下：

AlipayClient alipayClient = new DefaultAlipayClient(URL, APP_ID, APP_PRIVATE_KEY, FORMAT, CHARSET, ALIPAY_PUBLIC_KEY, SIGN_TYPE);

关键参数说明：

接下来，就可以用alipayClient来调用具体的API了。alipayClient只需要初始化一次，后续调用不同的API都可以使用同一个alipayClient对象。

第四步：接口调用

4.1 红包无线支付接口（alipay.fund.coupon.order.app.pay）

场景描述：

商户app上集成支付宝APP支付SDK，用户在商户app上发红包时唤起支付宝钱包进行支付。

调用流程：

商户系统调用红包无线支付接口alipay.fund.coupon.order.app.pay完成红包的发放；商户客户端在获取到支付结果后，要将结果同步给商户的服务端进行验签和结果解析，确认结果无误后再显示红包，严禁直接在客户端进行验签和结果解析。

关键入参：

关键出参：

无线端接入特别说明：

红包无线支付Android调用说明：点此查看

红包无线支付IOS调用说明：点此查看

服务端接入方案：通过SDK集成接入，点此查看

4.2 红包页面支付接口（alipay.fund.coupon.order.page.pay）

场景描述：

用户在商户PC页进行红包的发放，付款时会链接到支付宝PC登录页面进行登录和后续的支付，在支付成功后跳转回商户页。

调用流程：

关键入参：

 关键出参：

4.3 红包协议支付接口（alipay.fund.coupon.order.agreement.pay）

场景描述：

B2C场景下，商户营销资金出资时，使用该接口进行支付，可以免去输入密码的过程。

调用流程：

商户系统调用红包协议支付接口alipay.fund.coupon.order.agreement.pay完成红包的发放；支付宝在返回结果给商户时，会带回关键的结果字段，商户需要进行结果解析，同时需要对异步商户通知进行验签，确认结果无误后再展示给用户。

关键入参：

关键出参：

4.4 红包打款接口（alipay.fund.coupon.order.disburse）

场景描述：

用户点击红包进行领取。

调用流程：

商户系统调用红包打款接口alipay.fund.coupon.order.disburse完成红包的领取，在调用接口时，必须传入发送红包时产生的支付宝授权资金订单号或商户授权资金订单号，用于关联该红包。红包金额会进入领取人的支付宝余额，可通过用户支付宝登录号或者支付宝Uid打款。建议使用Uid方式，可通过账户授权接口获取用户Uid。

关键入参：

关键出参： 

4.4 红包退回接口（alipay.fund.coupon.order.refund）

场景描述：

将剩余的未领取的红包资金退回红包发送方。

调用流程：

商户系统调用红包退回接口alipay.fund.coupon.order.refund完成红包剩余资金的退回，这个是提供给商户用的接口层面的退款。此外，支付宝端提供超时自动退款能力，用于将剩余资金全部退回，自助签约默认超时退款时间为48小时。

关键入参：

关键出参： 

4.5 红包明细查询接口（alipay.fund.coupon.operation.query）

场景描述：

用于查询红包详情；此外，当红包发送、领取和退回等操作没有拿到明确的结果时（如请求处理中、未知异常），则可以通过查询该笔操作的详情来确定。

调用流程：

支付宝提供两种方式的查询：

1）通过支付宝订单号和操作流水号查询，该查询方式效率高，建议尽可能使用该方式；

2）通过商户订单号和操作流水号查询，该查询方式效率低，不建议使用。

关键入参：

关键出参：

结果码

根据公共返回参数中的code，一次红包操作可能有四种状态：操作成功（10000），操作失败（40004），请求处理中（10003）和未知异常（20000）；此外，结果中还会提供更具体的错误码和错误描述，关于此部分见具体的接口文档。

FAQ