支付宝生活号下单
1、修订记录
修订记录 | 日期 | 说明 |
---|---|---|
1.0 | 2024.03.12 | 初版 |
2、业务说明
(1)接口说明
注意事项:
1、调用此接口前,请确保已开通“生活号第三方应用”。
2、代创建提交且支付宝审核通过后,下一步则需商户做代创建的授权确认,商户可登录商家中心b.alipay.com查看待办事项,并确认授权。
请求主体类型:application/json
请求方式:POST
3、请求地址
环境 | HTTPS请求地址 |
---|---|
测试环境 | https://appdev.ysepay.com/openapi/unify/alipay/js |
正式环境 | https://ysgate.ysepay.com/openapi/unify/alipay/js |
4、请求参数说明
4.1、公共请求参数
参数 | 类型(长度) | 必填 | 参数说明 |
---|---|---|---|
timeStamp | String | Y | 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" |
method | String(128) | Y | 接口名称,固定值:unify.alipay.js |
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数据明文字符串)
参数 | 类型(长度) | 必填 | 参数说明 |
---|---|---|---|
orderId | String(32) | Y | 订单号,商户系统生成的订单号,要求如下: 1、须保证在商户端不重复。 2、只能由大小写英文字母、数字、下划线及横杠组成。 建议前8位为交易日期,如20220525,范围跨度支持包含当天在内的前后一天,示例值:202205256843192280647118。 |
shopDate | String(8) | N | 交易日期,商户系统的交易发生日期格式yyyyMMdd, 示例值:20180525。 |
note | String(125) | Y | 订单备注 |
amount | String(10) | Y | 订单总金额,该笔订单的资金总额,必须为正整数,单位:分。 |
currency | String(3) | N | 交易币种,默认CNY(人民币)。 |
payeeMercId | String(20) | Y | 收款商户号 |
payeeMercName | String(50) | N | 商户名称,收款商户号对应商户名称。 |
timeOutExpress | String(6) | Y | 交易超时时间,设置未付款交易的超时时间,一旦超时,该笔交易就会自动被关闭。单位:分钟。注意:设置了未付款交易超时时间的情况下,若我司在限定时间内没有收到成功支付通知,则会关闭交易,关闭后该笔交易若付款方支付成功的情况下,会自动原路退款至付款方。 |
extraCommonParam | String(1000) | N | 公用回传参数 |
busiCode | String(10) | Y | 业务代码,请联系银盛客户经理获取。 注意:业务代码非固定值,不同到账方式需要传不同的业务代码。 |
limitCreditPay | String(1) | N | 是否限制信用卡,0:不限制(默认值); 1:禁用信用卡; 2:禁用花呗; 3:禁用花呗分期; 4:禁用所有信用支付类型; |
allowRepeatPay | String(1) | N | 是否允许多次支付,类型如下: Y-允许 N-不允许(参数为空或者Y时,默认该笔订单交易状态非成功状态时,支持选择其他支付方式继续付款, 当为N时表示该笔订单交易状态为失败状态时,不支持选择其他支付方式继续付款) |
notifyUrl | String(190) | Y | 通知地址 |
failNotifyUrl | String(190) | N | 失败通知地址,失交易状态为失败时,银盛支付服务器主动通知商户网站里指定的页面http路径,支持多个url进行异步通知,多个url用分隔符“,”分开,格式如:url1,url2,url3。 注:只有不允许重复支付的交易才会通知。 |
buyerLogonId | String(100) | N | 买家支付宝账号,和bugerId不能同时为空。该字段于2023-9-1已不支持使用,请使用buyerId对接,如有疑问请咨询银盛技术支持! |
buyerId | String(100) | N | 买家支付宝用户ID,买家支付宝用户ID,和buyerLogonId不能同时为空。bugerId获取方法:https://doc.open.alipay.com/doc2/detail.htm?spm=a219a.7629140.0.0.8ujLD6&treeId=115&articleId=104114&docType=1通过网页授权获取用户信息,同步响应结果中的user_id对应文档中的bugerId。 |
srcIP | String(16) | Y | 发起方IP |
payerIP | String(16) | N | 付款方IP |
gpsInfo | String | N | 付款方gps信息 |
province | String | N | 所属省编码 |
city | String | N | 所属市编码 |
agentNo | String | N | 代理商编号 |
paygateNo | String | N | 支付网关编号,900000001:银联-支付宝;10000012:网联-支付宝。 |
hbFqNum | String | N | 花呗分期期数,仅在支付宝支付的时候生效,目前期数支持6,12。 |
storeId | String(32) | N | 商户门店编号 |
alipayStoreId | String(28) | N | 支付宝的店铺编号 |
operatorId | String(28) | N | 商户操作员编号 |
terminalId | String(32) | N | 商户机具终端编号 |
businessParams | String(32) | N | 支付宝花呗分期专属字段 |
subMerchantInfo | Object | N | 二级商户信息,暂包括merName、merShortName、merAddr、mobileNo、merNo、category、mrchntCertId。如果有值则二级商户信息都不能为空,如果没值则都不能有值 |
consigneeInfo | Object | N | 收货人信息 |
buyerRealNameInfo | Object | N | 购买人实名认证信息 |
unionQrcodeParams | Object | N | 银联259号文条码改造参数 |
aliGoodsDetailList | Array | N | 支付宝营销单品详情列表 |
4.2.1 subMerchantInfo具体参数
参数 | 类型(长度) | 必填 | 参数说明 |
---|---|---|---|
merName | String(50) | N | 二级商户名称 |
merShortName | String(50) | N | 二级商户简称 |
merAddr | String(200) | N | 二级商户地址 |
telephone | String(13) | N | 客户手机号 |
merNo | String(32) | N | 二级商户编号 |
category | String(20) | N | 类目编号,类目,按附件内容输入类目编号 |
mrchntCertId | String(18) | N | 身份证号,只支持身份证格式。 |
4.2.2 consigneeInfo具体参数
参数 | 类型(长度) | 必填 | 参数说明 |
---|---|---|---|
consigneeName | String(150) | N | 收货人姓名 |
consigneeAddr | String(200) | N | 收货地址 |
transportationInfo | String(200) | N | 物流配送信息,物流名称+订单号。 |
commodityName | String(150) | N | 商品名称 |
commodityNumber | String(10) | N | 商品数量 |
4.2.3 buyerRealNameInfo具体参数
参数 | 类型(长度) | 必填 | 参数说明 |
---|---|---|---|
idNo | String | Y | 证件号,只支持身份证格式。 |
idType | String | Y | 证件类型,只支持身份证,枚举值:1。 |
idName | String | Y | 证件姓名 |
4.2.4 unionQrcodeParams具体参数
参数 | 类型(长度) | 必填 | 参数说明 |
---|---|---|---|
terminalNo | String(8) | N | 终端号 |
terminalType | String(2) | N | 终端类型,线下交易场景必填。类型如下: 01-自动柜员机(含 ATM 和 CDM)和多媒体自助终端 02-传统 POS 03-mPOS 04-智能 POS 05-II 型固定电话 06-云闪付终端 07-保留使用 08-手机 POS 09-刷脸付终端 10-条码支付受理终端 11-辅助受理终端 12-行业终端(公交、地铁用于指定行业的终端) 13-MIS 终端 |
serialNum | String(50) | N | 终端序列号 |
networkLicense | String(5) | N | 入网认证编号 |
appVersion | String(5) | N | 终端应用版本号 |
terminalGps | String(32) | N | 交易设备位置信息,交易设备位置信息,格式:纬度/经度,东经为正数,西经为负数;北纬为正数,南纬为负数,线下交易场景、terminalIp和terminalGps 二者选其一 必填。 |
terminalIp | String(8) | N | 终端设备IP,如经、维度信息未上送,该字段必送。 |
encrypRandNum | String(10) | N | 加密随机因子 |
secretText | String(16) | N | 密文数据 |
4.2.5 aliGoodsDetailList具体参数
参数 | 类型(长度) | 必填 | 参数说明 |
---|---|---|---|
goodsId | String(32) | Y | 商品编号 |
alipayGoodsId | String(32) | N | 支付宝商品编号,支付宝定义的统一商品编号。 |
goodsName | String(256) | Y | 营销单品名称 |
quantity | String(10) | Y | 营销单品数量,不超过10位的正整数。 |
price | String(12) | Y | 营销单品单价,单位:分。 |
goodsCategory | String(24) | N | 营销单品类目 |
categoriesTree | String(128) | N | 营销单品类目树 |
body | String(500) | N | 营销单品描述 |
showUrl | String(200) | N | 营销单品展示地址 |
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数据)
参数 | 类型(长度) | 必填 | 参数说明 |
---|---|---|---|
reqMsgId | String | Y | 请求流水号,同⼊参请求流水号 |
systemCode | String | N | 系统编码 |
data | Object | Y | 响应结果对象 |
5.2.1 data具体参数
参数 | 类型(长度) | 必填 | 参数说明 |
---|---|---|---|
orderId | String | N | 商户订单号 |
tradeSn | String | N | 交易流水号 |
tradeStatus | String | N | 交易状态,如下: 00-交易成功 02-支付成功,合单交易渠道成功但参与营销,需人工调账待支付 11-支付中(已向渠道跳转) 12-部分支付 13-全部已支付(担保交易使用)等待发货 14-未确认收货(等待付款方确认) 60-提现登记 61-提现完成 70-自动关闭处理中 80-部分退款 81-全部退款 97-客户主动关闭 99-到时关闭' 01-支付成功 98-支付失败 96-交易失败(超金额支付) 50-业务超时 95-关闭订单 94-无支付订 93-订单撤销 |
amount | String | N | 订单金额,单位:分。 |
currency | String | N | 交易币种 |
extraCommonParam | String | N | 公共回传参数 |
jsapiPayInfo | Object | N | 支付宝返回参数,JSON字符串。 |
5.2.1.1 jsapiPayInfo具体参数
参数 | 类型(长度) | 必填 | 参数说明 |
---|---|---|---|
tradeNO | String(32) | Y | 交易流水 |
status | String(32) | Y | 状态 |
6、业务响应码 网关公共响应码
响应码 | 响应码描述 | 解决方案 |
---|---|---|
0000 | 请求成功 | 成功后,根据返回businessData业务参数,进行业务处理。 |
9999 | 系统异常 | 系统异常后,调用查询接口查询该订单的状态。 |
5000 | 交易超时 | 超时后,调用查询接口查询该订单的状态。 |
A029998 | 网关非法参数 | 检查请求参数,修改后重新发起请求。 |
B020100 | 前置无提供者 | 检查请求参数,修改后重新发起请求。 |
B021100 | 前置系统参数验证错误 | 检查请求参数,修改后重新发起请求。 |
B022011 | 商户号错误,请上送正确的商户号 | 检查发起方商户号和商户号的归属关系。 |
B023006 | 订单重复支付 | 检查订单号是否重复,重新生成订单号。 |
B029901 | 业务失败 | 根据实际返回消息分析具体原因。 |
B023003 | 商户号异常,请检查! | 请上送正确的商户号。 |
B084323 | 订单重复:原订单不支持重复下单。 | 重新生成订单号。 |
B084335 | 处理异常:客单价个性化配置中交易金额不在范围内 | 检查金额,重新上送支持范围的金额。 |
B087084 | 客户名不合法 | 输入正确的客户名称。 |
B083305 | 获取支付控件失败,当前商户需补齐相关资料后,才可进行支付交易 | 请商户联系服务商 |