完结先享后付订单
接口说明
接口url | https://api.mch.weixin.qq.com/v3/payscore/payafter-orders/{out_order_no}/complete |
---|---|
请求方式 |
POST |
前置条件
用户确认订单成功后。
请求参数
变量名 | 类型 | 必填 | 示例值 | 描述 |
---|---|---|---|---|
appid | string(32) | 是 | wxd678efh567hg6787 | 微信公众平台分配的与传入的商户号建立了支付绑定关系的appid,可在公众平台查看绑定关系.需要在本系统先进行配置. |
out_order_no | string(32) | 是 | 1234323JKHDFE1243252 | 仅从URL中传 商户系统内部服务订单号(不是交易单号),要求32个字符内,只能是数字、大小写字母_-|* 且在同一个商户号下唯一。详见[商户订单号] |
service_id | string(32) | 是 | 500001 | 该服务ID有本接口对应产品的权限 |
finish_type | int | 是 | 2 | 标识用户订单使用情况: 1 未使用服务,取消订单; 2 完成服务使用,结束订单 |
cancel_reason | string(30) | 否 | 用户取消订单 | 取消原因,不超过30个字符,超出报错处理;取消订单时必填,说明取消订单的原因 |
real_service_start_time | string(14) | 否 | 20091225091010 | 实际服务开始时间 支持两种格式:yyyyMMddHHmmss和yyyyMMdd 传入20091225091010表示2009年12月25日9点10分10秒 传入20091225表示2009年12月25日00点00分00秒 【实际服务开始时间】与【服务开始时间】一致时,不可填写,否则报错 【实际服务开始时间】不能比商户调用创建订单接口时间早 完结类型为取消时,不可填写 |
real_service_end_time | string(14) | 否 | 20091225091010 | 服务结束时间 支持两种格式:yyyyMMddHHmmss和yyyyMMdd 传入20091225091010表示2009年12月25日9点10分10秒 传入20091225默认时间为2009年12月25日23点59分59秒 【服务结束时间】和创建订单时填写的【预计服务结束时间】一致时,不可填写,否则报错 【服务结束时间】需要超过创建订单时填写的【服务开始时间】 【服务结束时间】需要超过完结订单时填写的【实际服务开始时间】 未使用服务,取消订单时,不可填写该字段 使用服务且未填写预计服务结束时间时,必填 |
real_service_end_location | string(20) | 否 | 嗨客时尚主题展餐厅 | 服务结束地点,不超过20个字符,超出报错处理 实际结束使用服务的地点 1.服务开始地点与结束地点一致时:不可填写,否则报错 2.服务开始地点与结束地点不一致时: 1)用户下单时未填写预计服务结束地点:需填写 2)用户下单时已填写预计服务结束地点 与预计服务结束地点一致时:不可填写 与预计服务结束地点不一致时:需填写 未使用服务,取消订单时,不可填写该字段 |
+fees | array | 否 | none | 后付费,描述付费项目列表,最多包含100条付费项目(含创建订单已传入的付费项目)。 1)可以增加付费项目; 2)修改原有付费项目时,计费说明和数量以创建订单时为准,不能修改(不能传参数),改的新金额必须小于等于创建订单时此付费项目金额。 未使用服务,取消订单时,不可填写该字段 完结类型为结束订单时,此订单至少存在一个付费项目 参见Fee表格说明 |
+discounts | array | 否 | none | 商户优惠,最多包含5条商户优惠 (含创建订单已传入的商户优惠) 1.创建订单接口传入了商户优惠: 1)可以增加优惠项目。 2)需要传入创建订单时的优惠项目及其对应的金额,优惠说明不能填写。 2.创建订单未传入优惠项目: 1)直接通过此接口传入优惠项目 未使用服务,取消订单时,不可填写该字段 参见Discount表格说明 |
total_amount | int | 是 | 40000 | 大于等于0的数字,单位为分 需满足:总金额=付费项目金额之和-商户优惠项目金额之和<=服务风险金额 未使用服务,取消订单时,该字段必须填0. |
finish_ticket | string(512) | 是 | finish_ticket | 完结凭证,用于完结订单时传入(每次获取到的字段内容可能变化,但之前获取的字段始终有效,可一直使用),请确保数据完整性,无需对字段再做处理。需对字段再做处理。 (注意:该字段可通过查询订单或者用户确认使用服务回调里获取finish_ticket,finish_ticket是支付分用来校验的参数,商户不可自定义) 总长度不大于512字符,超出报错处理. |
profit_sharing | Bool | 否 | true | 完结订单分账接口标记,true-分账,false-不分账 |
FEE
变量名 | 类型 | 必填 | 示例值 | 描述 |
---|---|---|---|---|
fee_name | string(20) | 是 | 阿萨姆瓶装奶茶 | 付费项目名称,不超过20个字符,超出报错处理,各付费项目名称不能重复 |
fee_count | int | 否 | 2 | 数量,付费项目数量,大于等于1且小于等于100,不填默认为1 |
fee_amount | int | 否 | 40000 | 此付费项目总金额,大于等于0,单位为分,等于0时代表不需要扣费 |
fee_desc | string(30) | 否 | 每分钟1元 | 计费说明,描述计费规则,不超过30个字符,超出报错处理 |
Discount
变量名 | 类型 | 必填 | 示例值 | 描述 |
---|---|---|---|---|
discount_name | string(20) | 是 | 满20减1元 | 不超过20个字符,超出报错处理,各优惠项目名称不能重复 |
discount_amount | int | 否 | 1 | 优惠金额,大于0的数字,单位为分 |
discount_desc | string(30) | 否 | 可与其他优惠叠加 | 优惠说明,不超过30个字符,超出报错处理 在填写【优惠名称】的情况下,【优惠金额】和【优惠说明】至少填写一项,下单时未确定优惠项目金额时,填写【优惠说明】,否则填写【优惠金额】 |
请求包体样例:
{
"appid": "wxd678efh567hg6787",
"service_id": "500001",
"finish_type": 2,
"real_service_start_time": "20091225091010",
"real_service_end_time": "20091225091210",
"real_service_end_location": "嗨客时尚主题展餐厅",
"fees": [{
"fee_name": "服务费",
"fee_amount": 40000,
"fee_desc": "每分钟1元"
}],
"discounts": [{
"discount_name": "满20减1元",
"discount_amount": 1,
"discount_desc": "不与其他优惠叠加"
}],
"total_amount": 40000,
"finish_ticket": "finish_ticket"
}
"appid": "wxd678efh567hg6787",
"service_id": "500001",
"finish_type": 2,
"real_service_start_time": "20091225091010",
"real_service_end_time": "20091225091210",
"real_service_end_location": "嗨客时尚主题展餐厅",
"fees": [{
"fee_name": "服务费",
"fee_amount": 40000,
"fee_desc": "每分钟1元"
}],
"discounts": [{
"discount_name": "满20减1元",
"discount_amount": 1,
"discount_desc": "不与其他优惠叠加"
}],
"total_amount": 40000,
"finish_ticket": "finish_ticket"
}
返回结果
状态码 | 含义 | 描述 |
---|---|---|
200 | OK | 处理成功 |
其它 | 异常应答 | 处理失败,详见 接口规则 |
状态码为 200 时 返回以下信息
变量名 | 类型 | 必填 | 示例值 | 描述 |
---|---|---|---|---|
appid | string(32) | 是 | wxd678efh567hg6787 | 调用接口提交的公众账号ID |
mchid | string(32) | 是 | 1230000109 | 微信支付分配的商户号 |
out_order_no | string(32) | 是 | 1234323JKHDFE1243252 | 调用接口提交的商户服务订单号 |
service_id | string(32) | 是 | 500001 | 调用该接口提交的服务ID |
order_id | string(128) | 是 | 164646465165651 | 微信支付服务订单号 每个微信支付服务订单号与商户号下对应的商户服务订单号一一对应 |
应答样例:
200 Response{
"appid": "wxd678efh567hg6787",
"mchid": 1230000109,
"out_order_no": "1234323JKHDFE1243252",
"service_id": 500001,
"order_id": 164646465165651
}
"appid": "wxd678efh567hg6787",
"mchid": 1230000109,
"out_order_no": "1234323JKHDFE1243252",
"service_id": 500001,
"order_id": 164646465165651
}
错误码
参见错误码列表