最新更新时间:2020.03.05 版本说明
用户申请使用服务时,商户可通过此接口申请创建微信支付分订单。
•免确认模式下创单成功返回的state是DOING:进行中;state_description:USER_CONFIRM:用户确认。
•如免确认模式下返回的是CREATED:商户已创建服务订单,则为创单失败。
•API参数涉及时间参数时需注意,可能由于商户时钟系统和微信支付分时钟系统,取当前时间存在一定误差。可能导致在API调用出现失败情况。因此商户在传入时间参数时需预留一定误差时间
适用对象:直连商户
请求URL:https://api.mch.weixin.qq.com/v3/payscore/serviceorder
请求方式:POST
path 指该参数为路径参数
query 指该参数需在请求URL传参
body 指该参数需在请求JSON传参
参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
商户服务订单号 | out_order_no | string[1,32] | 是 | body 商户系统内部服务订单号(不是交易单号),要求此参数只能由数字、大小写字母_-|*组成,且在同一个商户号下唯一。详见[商户订单号]。 示例值:1234323JKHDFE1243252 |
应用ID | appid | string[1,32] | 是 | body 微信为调用商户分配的公众账号ID,接口传入的appid应该为公众号的appid和小程序的appid(在mp.weixin.qq.com申请的)或APP的appid(在open.weixin.qq.com申请的)。 校验规则: 1、该appid需要与调用接口的商户号(即请求头中的商户号)有绑定关系,若未绑定,可参考该指引完成绑定(商家商户号与AppID账号关联管理); 2、该appid需要在支付分系统中先进行配置 示例值:wxd678efh567hg6787 |
服务ID | service_id | string[1,32] | 是 | body该服务ID有本接口对应产品的权限。 示例值:500001 |
服务信息 | service_introduction | string[1,20] | 是 | body 服务信息,用于介绍本订单所提供的服务 ,当参数长度超过20个字符时,报错处理。 示例值:某某酒店 |
+后付费项目 | post_payments | array | 否 | body后付费项目列表,最多包含100条付费项目。 如果传入,用户侧则显示此参数。 |
+后付费商户优惠 | post_discounts | array | 否 | body后付费商户优惠列表,最多包含30条商户优惠。 如果传入,用户侧则显示此参数。 |
+服务时间段 | time_range | object | 是 | body 服务时间范围 |
+服务位置 | location | object | 否 | body服务位置信息 如果传入,用户侧则显示此参数。 |
+订单风险金 | risk_fund | object | 是 | body订单风险金信息 |
商户数据包 | attach | string[1,256] | 否 | body商户数据包可存放本订单所需信息,需要先urlencode后传入。 当商户数据包总长度超出256字符时,报错处理。 注意:创单接口的商户数据包和支付分订单的对账单中返回的商户数据包实际上是不一致的,只和查单、回调中返回的商户数据包一致。 示例值:Easdfowealsdkjfnlaksjdlfkwqoi&wl3l2sald |
商户回调地址 | notify_url | string[1,255] | 是 | body商户接收用户确认订单和付款成功回调通知的地址。 示例值:https://api.test.com |
用户标识 | openid | string[1,128] | 条件选填 | body微信用户在商户对应appid下的唯一标识。 免确认订单:必填 需确认订单:不填 获取用户openid指引 示例值:oUpF8uMuAJO_M2pxb1Q9zNjWeS6o |
是否需要用户确认 | need_user_confirm | bool | 否 | body枚举值: false:免确认订单 true:需确认订单 默认值true 示例值:true |
{
"out_order_no": "1234323JKHDFE1243252",
"appid": "wxd678efh567hg6787",
"service_id": "500001",
"service_introduction": "某某酒店",
"post_payments": [
{
"name": "就餐费用服务费",
"amount": 4000,
"description": "就餐人均100元服务费:100/小时",
"count": 1
}
],
"post_discounts": [
{
"name": "满20减1元",
"description": "不与其他优惠叠加"
}
],
"time_range": {
"start_time": "20091225091010",
"end_time": "20091225121010"
},
"location": {
"start_location": "嗨客时尚主题展餐厅",
"end_location": "嗨客时尚主题展餐厅"
},
"risk_fund": {
"name": "ESTIMATE_ORDER_COST",
"amount": 10000,
"description": "就餐的预估费用"
},
"attach": "Easdfowealsdkjfnlaksjdlfkwqoi&wl3l2sald",
"notify_url": "https://api.test.com",
"openid": "oUpF8uMuAJO_M2pxb1Q9zNjWeS6o",
"need_user_confirm": true
}
参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
应用ID | appid | string[1,32] | 是 | 调用接口提交的公众账号ID。 示例值:wxd678efh567hg6787 |
商户号 | mchid | string[1,32] | 是 | 调用接口提交的商户号。 示例值:1230000109 |
商户服务订单号 | out_order_no | string[1,32] | 是 | 调用接口提交的商户服务订单号。 示例值:1234323JKHDFE1243252 |
服务ID | service_id | string[1,32] | 是 | 调用该接口提交的服务ID。 示例值:500001 |
服务信息 | service_introduction | string[1,20] | 是 | 服务信息,用于介绍本订单所提供的服务。 示例值:某某酒店 |
服务订单状态 | state | string[1,32] | 是 | 表示当前单据状态。 枚举值: |
订单状态说明 | state_description | string (32) | 否 | 对服务订单"进行中"状态的附加说明。 1、USER_CONFIRM:用户确认 2、MCH_COMPLETE:商户完结 示例值:MCH_COMPLETE |
+后付费项目 | post_payments | array | 否 | 后付费项目列表,最多包含100条付费项目。 如果传入,用户侧则显示此参数。 |
+后付费商户优惠 | post_discounts | array | 否 | 后付费商户优惠,最多包含30条付费项目。 如果传入,用户侧则显示此参数。 |
+订单风险金 | risk_fund | object | 是 | 订单风险金信息 |
+服务时间段 | time_range | object | 是 | 服务时间范围 |
+服务位置 | location | object | 否 | 服务使用信息。 如果传入,用户侧则显示此参数。 |
商户数据包 | attach | string[1,256] | 否 | 商户数据包,可存放本订单所需信息,需要先urlencode后传入,总长度不大于256字符,超出报错处理。 示例值:Easdfowealsdkjfnlaksjdlfkwqoi&wl3l2sald |
商户回调地址 | notify_url | string[1,255] | 否 | 商户接收用户确认订单或扣款成功回调通知的地址。 示例值:https://api.test.com |
微信支付服务订单号 | order_id | string[1,64] | 是 | 微信支付服务订单号,每个微信支付服务订单号与商户号下对应的商户服务订单号一一对应。 示例值:15646546545165651651 |
跳转微信侧小程序订单数据 | package | string[1,300] | 是 | 用户跳转到微信侧小程序订单数据,需确认模式特有API中调起支付分-确认订单传入。该数据一小时内有效。 示例值:DJIOSQPYWDxsjdldeuwhdodwxasd_dDiodnwjh9we |
{
"appid": "wxd678efh567hg6787",
"mchid": "1230000109",
"out_order_no": "1234323JKHDFE1243252",
"service_id": "500001",
"service_introduction": "某某酒店",
"state": "CREATED",
"state_description": "MCH_COMPLETE",
"post_payments": [
{
"name": "就餐费用服务费",
"amount": 4000,
"description": "就餐人均100元服务费:100/小时",
"count": 1
}
],
"post_discounts": [
{
"name": "满20减1元",
"description": "不与其他优惠叠加"
}
],
"risk_fund": {
"name": " ESTIMATE_ORDER_COST",
"amount": 10000,
"description": "就餐的预估费用"
},
"time_range": {
"start_time": "20091225091010",
"end_time": "20091225121010"
},
"location": {
"start_location": "嗨客时尚主题展餐厅",
"end_location": "嗨客时尚主题展餐厅"
},
"attach": "Easdfowealsdkjfnlaksjdlfkwqoi&wl3l2sald",
"notify_url": "https://api.test.com",
"order_id": "15646546545165651651",
"package": " DJIOSQPYWDxsjdldeuwhdodwxasd_dDiodnwjh9we "
}
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
500 | SYSTEM_ERROR | 系统错误 | 5开头的状态码都为系统问题,请使用相同参数稍后重新调用 |
400 | PARAM_ERROR | 参数错误 | 根据错误提示,传入正确参数 |
403 | NO_AUTH | 商户信息不合法 | 登录商户平台核对,传入正确信息 |
429 | FREQUENCY_LIMITED | 频率超限 | 请求量不要超过接口调用频率限制 |
400 | INVALID_REQUEST | 请求参数符合参数格式,但不符合业务规则 | 请确认相同单号是否使用了不同的参数 |
404 | ORDER_NOT_EXIST | 订单不存在 | 确认入参,传入正确单据 |
400 | INVALID_ORDER_STATE | 单据状态错误 | 确认操作是否符合流程 |
400 | ORDER_CANCELED | 单据已取消 | 当前状态无需操作 |
400 | ORDER_DONE | 订单已完成 | 当前状态无需操作 |