支付宝银行红包发放

1、修订记录

修订记录 日期 说明
1.0 2024.07.26 初版

2、业务说明

(1)接口说明

支付宝银行红包发放。

请求主体类型:application/json

请求方式:POST

3、请求地址

环境 HTTPS请求地址
测试环境 https://appdev.ysepay.com/openapi/ysMarket/dtBankActivitySend
正式环境 https://ysgate.ysepay.com/openapi/ysMarket/dtBankActivitySend

4、请求参数说明

4.1、公共请求参数

参数 类型(长度) 必填 参数说明
timeStamp String Y 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss"
method String(128) Y 接口名称,固定值:ysMarket.dtBankActivitySend
charset String(10) Y 请求使用的编码格式,如utf-8,gbk,gb2312等,固定为utf-8
sign String Y 商户请求参数的签名串(签名算法默认为国密),详见demo,注意:请用商户私钥进行签名
check String Y 银盛公钥加密随机生成的字符串(key)得到的加密值,详见demo
bizContent String Y 业务参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递。注意:需要通过AES以及随机生成的字符串(key)加密业务参数集合,得到bizContent
reqId String Y 请求唯一流水号,商户系统唯一,要求32个字符内(最少14个字符),只能是数字、大小写字母_-且在同一个商户号下唯一。最后12位要求格式为"yyMMddHHmmss" 示例值:xy1415220315145602
certId String Y 发起方商户号,服务商在银盛给自己开设的商户号,即可当作发起方商户号,由银盛生成并下发。 注意:不同于子商户号,服务商发展的商户即为子商户号
version String Y 调用的接口版本,固定为:1.0

4.2、业务请求参数

(bizContent加密前的json数据明文字符串)

参数 类型(长度) 必填 参数说明
activityId String Y 活动id,数字分行活动id
logonId String N 支付宝loginid,支付宝用户ID 。user_id,logon_id,phone_id不能同时为空,优先级依次降低。 注:若手机号为非用户注册支付宝账号,则会发放失败。
outBizNo String N 外部流水号
phoneId String N 手机号,用户手机号
userId String N 支付宝userid,支付宝用户ID 。user_id,logon_id,phone_id不能同时为空,优先级依次降低。 注:UID为用户唯一标识,可通过授权方式获取,具体见产品文档。
openId String N 支付宝openid,【描述】映射user_id 详情可查看,推荐用openid

5、响应参数说明

请注意:银盛后期会对返回参数保留扩展的权力,扩展方式为新增参数但不会删除参数,请商户在解析银盛返回参数时要支持银盛可能扩展参数这种情况。

5.1、公共响应参数

参数 类型(长度) 必填 参数说明
code String(5) Y 网关响应码,示例值:00000 详见网关公共响应码
msg String(50) Y 网关响应码描述
subCode String Y 业务响应码,参见具体的API接口文档
subMsg String Y 业务响应描述
timeStamp String Y 响应时间,格式"yyyy-MM-dd HH:mm:ss"
norce String(128) Y 随机参数
sign String Y 响应参数的签名串,详见demo,
注意:请用银盛公钥进行验签
businessData String Y 业务响应参数集合,
注意:银盛网关通过AES加密业务响应参数集合,得到businessData,商户需要对其进行解密,详情请见demo

5.2、业务响应参数

响应业务参数businessData(json数据)

参数 类型(长度) 必填 参数说明
accountNo String N 接收渠道红包的,脱敏后的支付宝登录号
activityId String N 活动id
activityOrderId String N 活动流水唯一记录
discountThresholdAmt String N 优惠门槛,比喻:
   A.满5元减3元,则值是500
   B.满10元随机立减1元到3元,则值是1000
   整数类型,以分为单位。
discountType String N 优惠类型,reduce:满立减(满5元减3元)
   random:随机立减(满10元随机立减1元到3元)
discountValue String N 优惠制,比喻:
   A.满5元减3元,则值是300(单位:分)
   B.满10元随机立减1元到3元,则值是具体的金额,如果随机1.5元,则值为150(单位:分)
sendAmount String N 券面额,以分为单位,比喻599,代表5.99元的面额
sendStatus String N 发放流水状态
voucherId String N 券平台唯一id

6、业务响应码 网关公共响应码

响应码 响应码描述 解决方案
0000 成功
D572999 支付宝返回失败

results matching ""

    No results matching ""