创建支付分订单API

创建支付分订单API

用户申请使用服务时，商户可通过此接口申请创建微信支付分订单。

接口说明

请求URL：https://api.mch.weixin.payyj.cn/v3/payscore/serviceorder

请求方式：POST

接口规则：https://wechatpay-api.gitbook.io/wechatpay-api-v3


path 指该参数为路径参数

query 指该参数需在请求URL传参

body 指该参数需在请求JSON传参


请求参数

参数名变量类型[长度限制]必填描述
商户服务订单号out_order_nostring[1,32]是body 商户系统内部服务订单号（不是交易单号），要求此参数只能由数字、大小写字母_-|*组成，且在同一个商户号下唯一。详见[商户订单号]。
示例值：1234323JKHDFE1243252
公众账号IDappidstring[1,32]是body 微信公众平台分配的与传入的商户号建立了支付绑定关系的appid，可在公众平台查看绑定关系，此参数需在本系统先进行配置。
示例值：wxd678efh567hg6787
服务IDservice_idstring[1,32]是body该服务ID有本接口对应产品的权限 ，使用默认值0000 。
示例值：500001
服务信息service_introductionstring[1,20]是body 服务信息，用于介绍本订单所提供的服务 ，当参数长度超过20个字符时，报错处理。
示例值：某某酒店
+后付费项目post_paymentsarray否body后付费项目列表，最多包含100条付费项目。
如果传入，用户侧则显示此参数。
+后付费商户优惠post_discountsarray否body后付费商户优惠列表，最多包含30条商户优惠。
如果传入，用户侧则显示此参数。
+服务时间段time_rangeobject是body 服务时间范围
+服务位置locationobject否body服务位置信息
如果传入，用户侧则显示此参数。
+订单风险金risk_fundobject是body订单风险金信息
商户数据包attachstring[1,256]否body商户数据包可存放本订单所需信息，需要先urlencode后传入。 当商户数据包总长度超出256字符时，报错处理。
示例值：Easdfowealsdkjfnlaksjdlfkwqoi&wl3l2sald
商户回调地址notify_urlstring[1,255]是body商户接收用户确认订单和付款成功回调通知的地址。
示例值：https://api.test.com
用户标识openidstring[1,128]条件选填body微信用户在商户对应appid下的唯一标识。
免确认订单：必填
需确认订单：不填
示例值：oUpF8uMuAJO_M2pxb1Q9zNjWeS6o
是否需要用户确认need_user_confirmbool是body枚举值：
false：免确认订单
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,
}

返回参数

参数名变量类型[长度限制]必填描述
公众账号IDappidstring[1,32]是调用接口提交的公众账号ID。
示例值：wxd678efh567hg6787
商户号mchidstring[1,32]是调用接口提交的商户号。
示例值：1230000109
商户服务订单号out_order_nostring[1,32]是调用接口提交的商户服务订单号。
示例值：1234323JKHDFE1243252
服务IDservice_idstring[1,32]是调用该接口提交的服务ID。
示例值：500001
服务信息service_introductionstring[1,20]是服务信息，用于介绍本订单所提供的服务。
示例值：某某酒店
服务订单状态statestring[1,32]是

表示当前单据状态。

枚举值：
1、CREATED：商户已创建服务订单
2、DOING：服务订单进行中
3、DONE：服务订单完成
4、REVOKED：商户取消服务订单
5、EXPIRED：服务订单已失效
示例值：CREATED

订单状态说明state_descriptionstring (32)否对服务订单"进行中"状态的附加说明。
1、USER_CONFIRM：用户确认
2、MCH_COMPLETE：商户完结
示例值：MCH_COMPLETE
+后付费项目post_paymentsarray否后付费项目列表，最多包含100条付费项目。
如果传入，用户侧则显示此参数。
+后付费商户优惠post_discountsarray否后付费商户优惠，最多包含30条付费项目。
如果传入，用户侧则显示此参数。
+订单风险金risk_fundobject是订单风险金信息
+服务时间段time_rangeobject是服务时间范围
+服务位置locationobject否服务使用信息。
如果传入，用户侧则显示此参数。
商户数据包attachstring[1,256]否商户数据包,可存放本订单所需信息，需要先urlencode后传入，总长度不大于256字符,超出报错处理。
示例值：Easdfowealsdkjfnlaksjdlfkwqoi&wl3l2sald
商户回调地址notify_urlstring[1,255]否商户接收用户确认订单或扣款成功回调通知的地址。
示例值：https://api.test.com
微信支付服务订单号order_idstring[1,64]是微信支付服务订单号，每个微信支付服务订单号与商户号下对应的商户服务订单号一一对应。
示例值：15646546545165651651
跳转微信侧小程序订单数据packagestring[1,300]是用于跳转到微信侧小程序订单数据,跳转到微信侧小程序传入。该数据1小时内有效。
示例值：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 "
}

错误码公共错误码

状态码错误码描述解决方案
500SYSTEM_ERROR系统错误5开头的状态码都为系统问题，请使用相同参数稍后重新调用
400PARAM_ERROR参数错误根据错误提示，传入正确参数
403NO_AUTH商户信息不合法登录商户平台核对，传入正确信息
429FREQUENCY_LIMITED频率超限请求量不要超过接口调用频率限制
400INVALID_REQUEST请求参数符合参数格式，但不符合业务规则请确认相同单号是否使用了不同的参数
404ORDER_NOT_ EXIST订单不存在确认入参，传入正确单据
400INVALID_ORDER_STATE单据状态错误确认操作是否符合流程
400ORDER_CANCELED单据已取消当前状态无需操作
400ORDER_DONE订单已完成当前状态无需操作


上一篇 授权/解除授权服务回调通知API
nextDoc 查询支付分订单API
本文档使用易文档编写, 更新时间: 2020-09-10 20:37