查询支付分订单API

查询支付分订单API

用于查询单笔微信支付分订单详细信息。

接口说明

适用对象:直连商户

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

请求方式:GET

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

前置条件:商户下单已受理后


path 指该参数为路径参数

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

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


请求参数

参数名变量类型[长度限制]必填描述
商户服务订单号out_order_nostring[1,32]二选一query 商户系统内部服务订单号(不是交易单号),与创建订单时一致
示例值:1234323JKHDFE1243252
回跳查询IDquery_idstring[1,64]query 微信侧回跳到商户前端时用于查单的单据查询id。详见章节“小程序跳转接口,回跳商户接口”。
商户单号与回跳查询id必填其中一个.不允许都填写或都不填写。
示例值:15646546545165651651
服务IDservice_idstring[1,32]query 该服务ID有本接口对应产品的权限 ,使用默认值0000  
示例值:500001
公众账号IDappidstring[1,32]query 微信公众平台分配的与传入的商户号建立了支付绑定关系的appid,可在公众平台查看绑定关系,此参数需在本系统先进行配置。
示例值:wxd678efh567hg6787

请求示例


URL: “https://api.mch.weixin.payyj.cn/v3/payscore/serviceorder?service_id=500001
&out_order_no=8416518464133&appid=wxd678efh567hg6787” 或 URL: “https://api.mch.weixin.payyj.cn/v3/payscore/serviceorder?service_id=500001
&query_id=brnbonve1465wq3q2&appid=wxd678efh567hg6787” ;

返回参数

参数名变量类型[长度限制]必填描述
公众账号IDappidstring[1,32]调用接口提交的公众账号ID
示例值:wxd678efh567hg6787
商户号mchidstring[1,32]调用接口提交的商户号
示例值:1230000109
服务IDservice_idstring[1,32]调用该接口提交的服务ID
示例值:500001
商户服务订单号out_order_nostring[1,32]调用接口提交的商户服务订单号
示例值:1234323JKHDFE1243252
服务信息service_introductionstring[1,20]服务信息用于介绍本订单所提供的服务,当参数长度超过20个字符时,报错处理。
示例值:某某酒店
服务订单状态statestring[1,32]表示当前单据状态
枚举值:
CREATED:商户已创建服务订单;
DOING:服务订单进行中;
DONE:服务订单完成;
REVOKED:商户取消服务订单; 
EXPIRED:服务订单已失效,"商户已创建服务订单"状态超过30天未变动,则订单失效
示例值:CREATED
订单状态说明state_descriptionstring[1,32]对服务订单"进行中"状态的附加说明:
USER_CONFIRM:用户确认
MCH_COMPLETE:商户完结
示例值:MCH_COMPLETE
商户收款总金额total_amountint64总金额,大于等于0的数字,单位为分,只能为整数,详见支付金额
此参数需满足:总金额=后付费项目金额之和-后付费商户优惠项目金额之和,且小于等于订单风险金额。取消订单时,该字段必须为0。
示例值:40000
+后付费项目post_paymentsarray后付费项目列表,最多包含100条付费项目
+后付费商户优惠post_discountsarray后付费商户优惠,最多包含30条付费项目
+订单风险金risk_fund

object

订单风险金信息
+服务时间段time_range

object

服务时间范围
+服务位置location

object

服务使用信息
商户数据包attachstring[1,256]商户数据包可存放本订单所需信息,需要先urlencode后传入。
当商户数据包总长度超出256字符时,报错处理。商户接收回包是根据场景,决定是否需要做安全过滤(XSS/CSRF)。
示例值:Easdfowealsdkjfnlaksjdlfkwqoi&wl3l2sald
商户回调地址notify_urlstring[1,255]商户接收用户确认订单和扣款成功回调通知的地址
示例值:https://api.test.com
微信支付服务订单号order_idstring[1,64]微信支付服务订单号,每个微信支付服务订单号与商户号下对应的商户服务订单号一一对应
示例值:15646546545165651651
是否需要收款need_collectionbool条件选填是否需要收款,非0元完结后返回
true:微信支付分代收款
false:无需微信支付分代收款
示例值:true
+收款信息collectionobject条件选填收款信息,非0元完结后返回
用户标识openidstring[1,128]微信用户在商户对应appid下的唯一标识
示例值:oUpF8uMuAJO_M2pxb1Q9zNjWeS6o

返回示例


{
  "appid": "wxd678efh567hg6787",
  "mchid": "1230000109",
  "service_id": "500001",
  "out_order_no": "1234323JKHDFE1243252",
  "service_introduction": "某某酒店",
  "state": "DOING",
  "state_description": "MCH_COMPLETE",
  "total_amount": 3900,
  "post_payments": [
    {
      "name": "就餐费用服务费",
      "amount": 4000,
      "description": "就餐人均100元服务费:100/小时",
      "count": 1
    }
  ],
  "post_discounts": [
    {
      "name": "满20减1元",
      "description": "不与其他优惠叠加",
      "amount": 100
    }
  ],
  "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",
  "need_collection": true,
  "collection": {
    "state": "USER_PAID",
    "total_amount": 3900,
    "paying_amount": 3000,
    "paid_amount": 900,
    "details": [
      {
        "seq": 1,
        "amount": 900,
        "paid_type": "NEWTON",
        "paid_time": "20091225091210",
        "transaction_id": "15646546545165651651"
      }
    ]
  }
}
                                

错误码公共错误码

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