更新时间:2025-07-25 16:37:15配置项检测工具收藏订阅更新我的文档设置接入检测(即可查看检测结果)若有未通过的接入检测项,接口将无法调通去登录返回文档完成 后,商家/服务商可根据本文指引快速接入 红包。说明:●红包 仅支持自研商家通过 自研应用,调用 api 接入。不支持第三方应用代调用。●红包 暂不支持沙箱调试。注意:支付宝将来可能会对接口、消息做优化升级,即新增接口、消息的返回参数,开发者的系统逻辑需要兼容此类升级。c2c 红包应用于 c2c 红包场景:a 用户在商户的 app 上发放红包并使用支付宝 app 支付;b 用户绑定支付宝账号后领取红包;超时未领取的红包资金原路退回 a 用户。支付宝 app 发红包接口 alipay.fund.trans.app.pay 场景描述在商户 app 上集成支付宝 app 支付 sdk,用户在商户 app上发红包时唤起支付宝客户端进行支付。接口调用流程接口说明1红包支付客户端 sdk 的返回结果可用于用户交互引导,但商户服务端单据的最终的支付结果请以蚂蚁消息 为准;2支付宝会对发起请求的时间戳进行校验,会拒绝超过一定时间段创建的请求(会基于安全的考虑进行间隔调整);3具体接入方式可以参考以下文档:○红包无线支付 android 调用。详情 点此查看。○红包无线支付 ios 调用。详情 点此查看。○服务端接入方案:通过 sdk 集成接入。详情 点此查看。○from 蚂蚁消息接入。详情 点此查看。(暂仅支持 http(s)方式接入,不支持 websocket 长连接方式)使用 sdk 快速接入以 java 语言为例,调用 支付宝 app 发红包接口的示例代码如下:关键入参参数类型最大长度必填描述out_biz_nostring64是商户端的唯一订单号,对于同一笔转账请求,商户需保证该订单号唯一。示例值:2018062800001trans_amountstring16是红包金额。示例值:8.88product_codestring64是业务产品码,固定std_red_packet。示例值:std_red_packetbiz_scenestring64是业务场景,本场景固定personal_pay。示例值:personal_payremarkstring200否备注。示例值:拼手气红包order_titlestring128是支付标题,支付收银台显示用,付款方在支付宝账单中可见。示例值:钉钉拼手气红包time_expirestring16否支付超时时间,格式为yyyy-mm-dd hh:mm。如果不传,默认30min。示例值:2018-03-23 00:00refund_time_expirestring16否退款超时时间,格式 yyyy-mm-dd hh:mm。到指定时间后,系统会自动触发退款,并原路退回到付款账户。如果指定了退款时间,必须早于开通产品的最晚退款时间。示例值:2018-03-24 00:00business_paramsstring2048是业务扩展字段,json格式。支持如下属性:●sub_biz_scene 子场景,必填,传redpacket。●payer_binded_alipay_uid 创建红包的商户会员绑定的支付宝用户uid,必填,可通过会员授权拿到支付宝用户uid。●payee_show_name,收款方显示名称,可选,付款方在支付宝账单中可见。示例值:{"sub_biz_scene":"redpacket","payer_binded_alipay_uid":"2088302510459335","payee_show_name":"钉钉红包"}响应示例红包打款接口 alipay.fund.trans.uni.transfer场景描述b 用户点击红包进行领取后,商户通过本接口向 b 用户的绑定支付宝账户中打款。接口调用流程接口说明●如果返回系统异常或未明确的错误码,请保持原始请求信息重试。●接口限制 tps 10。●商户服务器必须安装 ca 证书才可使用。使用 sdk 快速接入以 java 语言为例,调用 的例代码如下: 关键入参参数类型最大长度必填描述out_biz_nostring64是商户端的唯一订单号,对于同一笔转账请求,商户需保证该订单号唯一。示例值:2018062800001trans_amountstring16是订单总金额,单位为元,精确到小数点后两位,取值范围 [0.01,100000000]。示例值:6.88product_codestring64是销售产品码,固定 std_red_packet。biz_scenestring64是业务场景,本场景固定 personal_collection。original_order_idstring64是原支付宝业务单号。c2c 红包领取时,传红包支付时返回的支付宝单号;b2c红包不需要该参数。示例值:20190703110075000006530004756875payee_infoparticipant-是participant 类型,收款方信息。identitystring64是参与方的标识 id,比如支付宝用户 uid。示例值:2088123412341234identity_typestring64是参与方的标识类型,目前支持如下枚举:alipay_user_id 支付宝的会员id。alipay_logon_id 支付宝登录号。alipay_open_id 支付宝 openid。namestring256否参与方真实姓名,如果非空,将校验收款支付宝账号姓名一致性。order_title--是转账业务的标题,用于在支付宝用户的账单里显示。示例值:群聊拼手气红包remark--否业务备注。示例值:群聊拼手气红包business_params--是转账业务请求的扩展参数,支持传入的扩展参数如下:●sub_biz_scene:子业务场景,必传,取值 redpacket。●payer_show_name:付款方显示名称,可选,收款方在支付宝账单中可见。示例值:{"sub_biz_scene":"redpacket","payer_show_name":"钉钉红包"}关键出参参数类型必填最大长度描述out_biz_nostring是64商户订单号。示例值:201808080001order_idstring是64支付宝转账订单号。示例值:20180629110070000002040007320562pay_fund_order_idstring是64支付宝支付资金流水号。示例值:20190801110070001506380000251556statusstring否32转账单据状态。如 success 表示成功。响应示例红包资金退回接口 alipay.fund.trans.refund场景描述将剩余的未领取的红包资金退回红包发送方。接口调用流程接口说明如果返回系统异常或未明确的错误码,请保持原始请求信息重试。使用 sdk 快速接入以 java 语言为例,调用 的示例代码如下:关键入参参数类型最大长度必填描述order_idstring64是发红包时支付宝返回的支付宝订单号order_id。示例值:20190703110075000006530004756875out_request_nostring64是标识一次资金退回请求,一笔资金退回失败后重新提交,要采用原来的资金退回单号。总退款金额不能超过用户实际支付金额。示例值:2019063050784123refund_amountstring16是需要退款的金额,该金额不能大于原支付订单金额,单位为元,支持两位小数。示例值:0.15remarkstring200否资金退回备注。示例值:红包超时未领退回关键出参参数类型必填最大长度描述refund_order_idstring是64退款的支付宝系统内部单据 id。示例值:20180629110070001502040007320578order_idstring是64发红包时支付宝返回的支付宝订单号 order_id。示例值:20190703110075000006530004756875out_request_nostring是64标识一次资金退回请求,一笔资金退回失败后重新提交,要采用原来的资金退回单号。总退款金额不能超过用户实际支付金额。示例值:2019063050784123statusstring是64状态。success:退款成功refund_amountstring是16本次退款的金额,单位为元,支持两位小数。示例值:0.15refund_datestring是20退款资金退回时间。示例值:2019-01-01 08:08:08响应示例单据查询接口 alipay.fund.trans.common.query 场景描述查询发送红包、红包打款、红包退回订单的信息。 接口调用流程接口说明●查询入参 out_biz_no、order_id 与 pay_fund_order_id 三者不可同时为空,三者优先级为 pay_fund_order_id > order_id > out_biz_no,高优先级与低优先级参数同时给出时,用高优先级参数查询,忽略低优先级参数。●使用 out_biz_no 查询时,必须传 product_code 和 biz_scene。使用 sdk 快速接入以 java 语言为例,调用 的示例代码如下:按转账单据号查询场景按资金流水号查询场景按订单号查询场景关键入参参数类型最大长度必填描述order_idstring64特殊必填支付宝转账单据号:●本参数和商户转账唯一订单号、支付宝支付资金流水号三者不能同时为空。●当本参数和商户转账唯一订单号、支付宝支付资金流水号三者同时提供时,将用支付宝支付资金流水号进行查询,忽略其余两者。●当本参数和支付宝支付资金流水号同时提供时,将用支付宝支付资金流水号进行查询,忽略本参数。●当本参数和商户转账唯一订单号同时提供时,将用本参数进行查询,忽略商户转账唯一订单号。示例值:20190703110075000006530004756875pay_fund_order_idstring64特殊必填支付宝支付资金流水号:●本参数和支付宝转账单据号、商户转账唯一订单号三者不能同时为空。●当本参数和支付宝转账单据号、商户转账唯一订单号同时提供时,将用本参数进行查询,忽略本参数。●当本参数和支付宝转账单据号同时提供时,将用本参数进行查询,忽略支付宝转账单据号。●当本参数和商户转账唯一订单号同时提供时,将用本参数进行查询,忽略商户转账唯一订单号。示例值:20190801110070001506380000251556out_biz_nostring64特殊必填商户转账唯一订单号:发起转账来源方定义的转账单据 id:●本参数和支付宝转账单据号、支付宝支付资金流水号三者不能同时为空。●当本参数和支付宝转账单据号、支付宝支付资金流水号同时提供时,将用支付宝支付资金流水号进行查询,忽略本参数。●当本参数和支付宝转账单据号同时提供时,将用支付宝转账单据号进行查询,忽略本参数。示例值:2019063050784144product_codestring64特殊必填销售产品码,固定 std_red_packet,如果传了out_biz_no,则该字段必传。biz_scenestring64特殊必填描述特定的业务场景,如果传递了out_biz_no 则该字段为必传。可取的业务场景如下:●personal_pay:c2c 红包-发红包。●personal_collection:c2c 红包-领红包。关键出参参数类型必填最大长度描述order_idstring是64支付宝转账单据号,查询失败不返回。示例值:20190703110075000006530004756875out_biz_nostring是64商户订单号。示例值:2019063050784144statusstring是64转账单据状态。可能出现的状态如下:success:转账成功;wait_pay:等待支付;closed:订单超时关闭。pay_fund_order_idstring否64支付宝支付资金流水号(转账成功才返回)。示例值:20190801110070001506380000251556pay_datestring否20支付时间,格式为yyyy-mm-dd hh:mm:ss,转账失败不返回。示例值:2019-01-01 08:08:08响应示例蚂蚁消息:单据状态变更通知 alipay.fund.trans.order.changed场景描述单笔转账支付接口支付宝单据状态变更后触发通知。接口调用流程消息参数参数类型必填最大长度描述out_biz_nostring是64商户端的唯一订单号。示例值:201806300001product_codestring是32销售产品码,商家和支付宝签约的产品码。固定值 std_red_packet:红包。biz_scenestring是32描述特定的业务场景,如果传递了 out_biz_no 则该字段为必传。可取的业务场景如下: ●personal_pay:c2c 红包-发红包。●personal_collection:c2c 红包-领红包。●direct_transfer:b2c 红包。origin_interfacestring是64请求来源的接口。示例值:alipay.fund.trans.app.payorder_idstring是64支付宝系统的单据唯一 id。示例值:20190624110075000006530000014566pay_fund_order_idstring否64支付宝支付资金流水号(转账成功时才返回)。示例值:20190801110070001506380000251556statusstring是16转账单据状态。可能出现的状态如下:●success:转账成功。● wait_pay:等待支付。●closed:订单超时关闭。alipay.fund.trans.app.pay 涉及的状态: wait_pay success closed。alipay.fund.trans.uni.transfer、alipay.fund.trans.refund 涉及的状态:success。action_typestring是32资金订单的操作类型,取值如下:●create-创建。●finish- 订单处理已完结。●close-超时关闭 。trans_amountstring是20转账金额。示例值:32.00pay_datestring否20支付完成时间。示例值:2013-01-01 08:08:08响应值响应值描述是否重试fail消息获取失败重试success消息获取成功不重试消息示例消息验签在公钥证书模式下,支付宝开放平台 sdk 提供了 alipaysignature.rsacertcheckv1 方法,可以使用该方法对通知报文验签。蚂蚁消息:资金退回成功通知 alipay.fund.trans.refund.success场景描述资金退回成功后触发的通知。接口调用流程消息参数参数类型必填最大长度描述order_idstring是64该笔支付在支付宝系统内部的单据 id。示例值:20190624110075000006530000014566refund_order_idstring是64该笔退款在支付宝系统内部的单据 id。示例值:20190625110070000006800000071477out_request_nostring是64商户请求资金退回的请求单号,支付宝会对该参数做唯一性控制。示例值:refund201906270001refund_amountstring是16需要退款的金额,该金额不能大于订单金额,单位为元,支持两位小数。示例值:8.88statusstring是64资金退回状态。success:退款成功。refund_datestring否20退款完成时间。示例值:2019-01-01 08:08:08响应值响应值描述是否重试fail消息获取失败重试success消息获取成功不重试消息示例消息验签在公钥证书模式下,支付宝开放平台 sdk 提供了 alipaysignature.rsacertcheckv1 方法,可以使用该方法对通知报文验签。b2c 红包 应用于 b2c 红包的场景:商户向 b 用户发放营销红包,b 用户领取红包到自己的支付宝账户中。发放红包在营销等业务场景下,商户通过调用 直接给用户发放红包。接口调用流程接入说明●如果返回系统异常或未明确的错误码,请保持原始请求信息重试。●接口限制 tps 10。●商户服务器必须安装 ca 证书才可使用。●服务端接入方案:通过 sdk 集成接入,点此查看。●from蚂蚁消息接入说明:点此查看 (暂仅支持 http(s)方式接入,不支持 websocket 长连接方式)使用 sdk 快速接入以 java 语言为例,调用 的示例代码如下:关键入参参数类型最大长度必填描述out_biz_nostring64是商户端的唯一订单号,对于同一笔转账请求,商户需保证该订单号唯一。示例值:20190619000000001trans_amountstring16是订单总金额,单位为元,精确到小数点后两位,取值范围 [0.01,100000000]。示例值:1.68product_codestring64是销售产品码,固定 std_red_packet。biz_scenestring64是业务场景,本场景固定 direct_transfer。payee_infoparticipant-是participant 类型,收款方信息。└ identitystring64是参与方的标识id,比如支付宝用户 uid。示例值:2088123412341234└ identity_typestring64是参与方的标识类型,目前支持如下枚举:●alipay_user_id:支付宝的会员 id。●alipay_logon_id:支付宝登录号,支持邮箱和手机号格式。●alipay_open_id:支付宝 openid。└ namestring256否参与方真实姓名,如果非空,将校验收款支付宝账号姓名一致性。当 identity_type=alipay_logon_id 时,本字段必填。order_titlestring64是转账业务的标题,用于在支付宝用户的账单里显示。示例值:新人注册红包remarkstring200 否业务备注。示例值:新人注册红包business_paramsstring2048是转账业务请求的扩展参数,支持传入的扩展参数如下:●sub_biz_scene, 子业务场景,必传,取值redpacket。●payer_show_name,付款方显示名称,可选,收款方在支付宝账单中可见。示例值:{"sub_biz_scene":"redpacket","payer_show_name":"新人红包"}关键出参参数类型必填最大长度描述order_idstring是64支付宝转账单据号。示例值:20190619110070000006800000025890out_biz_nostring是64商户订单号。示例值:20190619000000001statusstring是64转账单据状态。success:转账成功。pay_fund_order_idstring否64支付宝支付资金流水号。示例值:20190801110070001506380000251556响应示例查询红包记录查询 b2c 红包转账订单的信息,通过 ,开发者可以查询到商家发出的记录和金额等信息。 接口调用流程接入说明●查询入参 out_biz_no、order_id 与 pay_fund_order_id 三者不可同时为空,三者优先级为 pay_fund_order_id > order_id > out_biz_no,高优先级与低优先级参数同时给出时,用高优先级参数查询,忽略低优先级参数。●使用 out_biz_no 查询时,必须传 product_code 和 biz_scene。使用 sdk 快速接入以 java 语言为例,调用 的示例代码如下:按转账单据号查询场景按资金流水号查询场景按订单号查询场景关键入参参数类型最大长度必填描述order_idstring64特殊必填支付宝转账单据号:●本参数和商户转账唯一订单号、支付宝支付资金流水号三者不能同时为空。●当本参数和商户转账唯一订单号、支付宝支付资金流水号三者同时提供时,将用支付宝支付资金流水号进行查询,忽略其余两者。●当本参数和支付宝支付资金流水号同时提供时,将用支付宝支付资金流水号进行查询,忽略本参数。●当本参数和商户转账唯一订单号同时提供时,将用本参数进行查询,忽略商户转账唯一订单号。示例值:20190619110070000006800000025890out_biz_nostring64特殊必填商户转账唯一订单号:发起转账来源方定义的转账单据id。●本参数和支付宝转账单据号、支付宝支付资金流水号三者不能同时为空。●当本参数和支付宝转账单据号、支付宝支付资金流水号同时提供时,将用支付宝支付资金流水号进行查询,忽略本参数。●当本参数和支付宝转账单据号同时提供时,将用支付宝转账单据号进行查询,忽略本参数。示例值:20190619000000001pay_fund_order_idstring64特殊必填支付宝支付资金流水号:●本参数和支付宝转账单据号、商户转账唯一订单号三者不能同时为空。●当本参数和支付宝转账单据号、商户转账唯一订单号同时提供时,将用本参数进行查询,忽略本参数。●当本参数和支付宝转账单据号同时提供时,将用本参数进行查询,忽略支付宝转账单据号。●当本参数和商户转账唯一订单号同时提供时,将用本参数进行查询,忽略商户转账唯一订单号。示例值:20190801110070001506380000251556product_codestring64特殊必填销售产品。如果传了 out_biz_no,则该字段必传。本场景固定传 std_red_packet。biz_scenestring64特殊必填描述特定的业务场景。如果传递了 out_biz_no 则该字段为必传。本场景固定传 direct_transfer。关键出参参数类型必填最大长度描述order_idstring是64支付宝转账单据号,查询失败不返回。示例值:20190703110075000006530004756875out_biz_nostring是64商户订单号。示例值:20190619000000001pay_fund_order_idstring否64支付宝支付资金流水号(转账成功才返回)。示例值:20190801110070001506380000251556pay_datestring否20支付时间,格式为yyyy-mm-dd hh:mm:ss,转账失败不返回。示例值:2013-01-01 08:08:08statusstring是64转账单据状态。可能出现的状态如下:success:转账成功;wait_pay:等待支付;closed:订单超时关闭示例值:success响应示例 红包状态变更通知通过调用 ,商户在支付宝单据状态变更后(如红包发放成功或者被领取后)触发的通知。说明:暂仅支持 http(s)方式接入,不支持 websocket 长连接方式。接口调用流程消息参数参数类型必填最大长度描述out_biz_nostring是64商户端的唯一订单号。示例值:201806300001product_codestring是32销售产品码,商家和支付宝签约的产品码。固定值 std_red_packet:红包。biz_scenestring是32描述特定的业务场景,如果传递了out_biz_no则该字段为必传。固定值:direct_transfer。origin_interfacestring是64请求来源的接口。示例值:alipay.fund.trans.uni.transferorder_idstring是64支付宝系统的单据唯一 id。示例值:20190624110075000006530000014566pay_fund_order_idstring否64支付宝支付资金流水号(转账成功时才返回)。示例值:20190801110070001506380000251556statusstring是16转账单据状态。可能出现的状态为 success:转账成功。action_typestring是32资金订单的操作类型,取值 finish- 订单处理已完结。trans_amountstring是20转账金额。示例值:32.00pay_datestring否20支付完成时间。示例值:2013-01-01 08:08:08响应值响应值描述是否重试fail消息获取失败重试success消息获取成功不重试消息示例消息验签在公钥证书模式下,支付宝开放平台 sdk 提供了 alipaysignature.rsacertcheckv1 方法,可以使用该方法对通知报文验签。