API 列表

C2C 现金红包接口列表

接口英文名 接口描述 使用场景
alipay.fund.trans.app.pay 支付宝 APP 发红包接口,通过调用该接口创建发红包订单并让用户在支付宝无线端支付 平台调用该接口,用户进入支付宝钱包完成支付,资金实时进入支付宝中间户,完成发送红包环节
alipay.fund.trans.uni.transfer 红包打款接口,通过调用该接口将资金打款给收款人 平台调用该接口,将资金从支付宝中间户打款给领取红包的人(可通过会员授权的方式取得用户 UID)
alipay.fund.trans.refund 资金退还接口,支持部分退回和全部退回 平台调用该接口,将未打款的资金从支付宝中间户退回给付款人
alipay.fund.trans.common.query 转账业务单据查询接口,通过调用该接口查询订单详情 商户后台、网络、服务器等出现异常,商户系统最终未接收到支付通知,需要主动查询红包状态时调用。可查询发送红包、红包打款、红包退回的单据。
alipay.fund.trans.order.changed  资金单据状态变更通知接口,发送红包、红包打款接口执行结果的消息通知。使用与配置参考:From蚂蚁消息的使用与配置 发送红包除了支付宝sdk返回的数据外、建议监听蚂蚁消息获取发送红包的结果,只在处理成功时和支付超时关闭时发送通知;红包打款除了依赖同步结果外,当无法获取同步结果时,可监听蚂蚁消息来获取打款结果,只在处理成功时发送。
alipay.fund.trans.refund.success 红包资金退回成功接口,执行结果的消息通知。使用与配置参考:From蚂蚁消息的使用与配置 红包退回可处理同步返回结果和监听消息通知以更新退回结果。只在处理成功时发送。

B2C 现金红包接口列表

接口英文名 接口描述 使用场景
alipay.fund.trans.uni.transfer
统一转账接口,通过调用该接口将资金打款给收款人 平台调用该接口,将资金从发起请求的商户支付宝账户余额打款给领取红包的人(支持支付宝用户UID或支付宝登录账号,可通过会员授权的方式取得支付宝用户UID)
alipay.fund.trans.common.query
转账业务单据查询接口,通过调用该接口查询订单详情 商户后台、网络、服务器等出现异常,商户系统最终未接收到支付通知,需要主动查询红包打款结果时调用。
alipay.fund.trans.order.changed 
资金单据状态变更通知接口,执行结果的消息通知。使用与配置参考:From蚂蚁消息的使用与配置 红包打款除了依赖同步结果外,当无法获取同步结果时,可监听蚂蚁消息来获取打款结果,只在处理成功时发送。
onlineServer