使用场景:查询服务单
接口编号:serviceorderget
请求参数(bizdata):
参数 | 参数名称 | 取值 | 可空 | 类型 | 备注 |
---|---|---|---|---|---|
out_order_no | 商户订单号 |
商户系统内部服务订单号(不是交易单号) 要求32个字符内,只能是数字、大小写字母 且在同一个商户号下唯一 |
否 | String(32) | |
query_id | 单据查询ID |
确认订单流程 微信侧回跳到商户前端时, 携带的用于单据查询的ID。 商户订单号与单据查单ID必填其一 示例值:15646546545165651651 |
否 | String(512) |
响应参数(bizrsp):
参数 | 参数名称 | 取值 | 可空 | 类型 | 备注 |
---|---|---|---|---|---|
out_order_no |
商户订单 号 |
商户系统内部服务订单号(不是交易单号) 要求32个字符内,只能是数字、大小写字母 且在同一个商户号下唯一 |
否 | String(32) | |
chnl_order_no |
渠道服务 单号 |
渠道服务单号(不是交易单号)对应微信端的商户单号 | 否 | String(32) | |
service_introduction | 服务信息 | 服务信息,用于介绍本订单所提供的服务 | 否 | String(20) | |
sub_appid |
子商户公 众号ID |
子商户公众号AppID | 是 | String(32) | |
sub_mchid |
子商户商 户号 |
否 | String(32) | ||
sub_openid |
子商户的 用户标识 |
子商户的AppID下的用户标识 | 是 | String(128) | |
channel_id |
渠道商商 户号 |
否 | String(32) | ||
state |
服务订单 状态 |
CREATED: 服务订单已创建 DOING: 服务订单进行中 DONE: 服务订单已完成 REVOKED: 商户取消服务订单 EXPIRED: 服务订单已失效 "CREATED"状态超过1小时未变动,则订单失效 示例值:CREATED |
否 | String(32) | |
state_description |
订单状态 说明 |
对服务订单"DOING"状态的附加说明. USER_CONFIRM: 用户确认 MCH_COMPLETE:商户完结 示例值:MCH_COMPLETE |
是 | String(32) | |
post_payments |
后付费项 目 |
后付费项目列表,最多包含100条付费项目 用于用户侧展示与完结订单时的总金额计算创建订单接口 1.name是选填; 2.若name非空: amount和description 二者必须填其一,也可同时填写 完结订单接口: 1. name和amount是必填; |
否 | array | |
post_discounts | 商户优惠 |
body商户优惠列表,最多包含30条商户优惠 用于用户侧展示与完结订单时的总金额计算创建订单接口 1.name和description是选填 但是要填写的话,须同时填写; 完结订单接口: 1.若name和description非空,amount金额必填; 2.优惠项目名称可以重复 3. 订单优惠项目,均以完结订单传入的信息为准; |
是 | array | |
risk_fund |
服务风险 金 |
用于微信支付分对本次服务进行风险评估 | 否 | object | |
total_amount | 总金额 | 调用接口传入的总金额 | 是 | int | 示例值:40000 |
need_collection |
是否需要 收款 |
调用接口传入的是否需要收款 | 是 | boolean | 示例值:true |
collection | 收款信息 | 收款成功后,展示具体的收款信息 | 是 | object | |
time_range | 服务时间 | 服务时间,用于用户侧展示 | 否 | object | |
location | 服务位置 | 服务位置,用于用户侧展示 | 是 | object | |
order_id |
微信支付 服务订单 号 |
微信支付服务订单号 每个微信支付服务订单号与商户号下 对应的商户订单号一一对应 |
是 | String(64) | |
need_user_confirm |
是否需要 用户确认 |
false: 不需要; true: 需要确认(默认false) |
是 | boolean | |
notify_url | 通知地址 | 回调通知地址 | 否 | String(100) | |
attach | 附加数据 |
附加数据 可作为自定义参数使用 需要先urlencode后传入 |
否 | String(128) |
其中收款信息(collection)明细字段:
变量 | 参数名 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
state | 收款状态 | string[1,32] | 是 |
USER_PAYING:待支付 USER_PAID:已支付 示例值:USER_PAID |
total_amount | 总收款金额 | int64 | 否 |
总金额,大于等于0的数字,单位为分,只能为整数,详见支付金额。 此参数需满足:总金额=付费项目金额之和-商户优惠项目金额之和,且小于等于订单风险金额 。未使用服务、取消订单时,该字段必须为0。 示例值:50000 |
paying_amount | 待收金额 | int64 | 否 |
等待用户付款金额,只能为整数,详见支付金额。 示例值:40000 |
paid_amount | 已收金额 | int64 | 否 |
用户已付款的金额,只能为整数,详见支付金额。 示例值:10000 |
details | +收款明细列表 | array | 否 | 收款明细列表 |
收款明细列表(details)明细字段
变量 | 参数名 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
seq | 收款序号 | int | 否 |
从1开始递增 示例值:1 |
amount | 单笔收款金额 | int64 | 否 |
单笔收款动作的金额,只能为整数,详见支付金额。 示例值:10000 |
paid_type | 收款成功渠道 | string[1,32] | 否 |
NEWTON:微信支付分 MCH:商户渠道 示例值:NEWTON |
paid_time | 收款成功时间 | string[1,14] | 否 |
支付成功时间,支持两种格式:yyyyMMddHHmmss和yyyyMMdd 1、传入20091225091010表示2009年12月25日9点10分10秒 2、传入20091225默认时间为2009年12月25日0点0分0秒 示例值:20091225091210 |
transaction_id | 微信支付交易单号 | string[1,200] | 否 |
结单交易单号, 等于普通支付接口中的transaction_id 只有单据状态为USER_PAID且收款成功渠道为支付分渠道 收款金额大于0,才会返回结单交易单号。 示例值:15646546545165651651 |
promotion_detail | +优惠功能 | array | 否 |
优惠功能 注:针对2020年5月27日10:00:00以后完结的订单生效 |
openid | 用户标识 | string[1,128] | 否 |
微信用户在商户对应appid下的唯一标识 示例值:oUpF8uMuAJO_M2pxb1Q9zNjWeS6o |
优惠功能(promotion_detail)明细字段
变量 | 参数名 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
coupon_id | 券ID | string[1,32] | 是 |
券ID 示例值:123456 |
name | 优惠名称 | string[1,64] | 否 |
优惠名称 示例值:单品优惠-6 |
scope | 优惠范围 | string[1,12] | 否 |
GLOBAL:全场代金券; SINGLE:单品优惠 示例值:GLOBAL |
type | 优惠类型 | string[1,12] | 否 |
枚举值:CASH:充值; NOCASH:免充值。 示例值:CASH |
amount | 优惠券面额 | int | 是 |
优惠券面额 示例值:100 |
stock_id | 活动ID | string[1,32] | 否 |
活动ID,批次ID 示例值:activity_id |
wechatpay_contribute | 微信出资 | int | 否 |
微信出资 示例值:100 |
merchant_contribute | 商户出资 | int64 | 否 |
商户出资 示例值:100 |
other_contribute | 其他出资 | int64 | 否 |
其他出资 示例值:0 |
currency | 优惠币种 | string | 否 |
CNY:人民币,境内商户号仅支持人民币 示例值:CNY |
goods_detail | +单品列表 | array | 否 | 单品列表 |
单品列表(goods_detail)明细字段
变量 | 参数名 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
goods_id | 商品编码 | string[1,32] | 是 |
商品编码 示例值:M1006 |
quantity | 商品数量 | uint32 | 否 |
商品数量 示例值:1 |
unit_price | 商品价格 | int64 | 否 |
商品价格 示例值:1 |
discount_amount | 商品优惠金额 | int64 | 否 |
商品优惠金额 示例值:0 |
goods_remark | 商品备注 | string[1,128] | 否 |
商品备注 示例值:商品备注信息 |
错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
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 | 订单已完成 | 当前状态无需操作 |