修改订单金额

更新时间:2024.12.10

订单collection.state为USER_PAYING待支付状态时,商户可调用该接口下调收款金额。

注:

1.先免模式,用户确认订单评估不通过时交了押金/预付款/保证金来使用服务的情况,不支持修改金额。

2.待支付状态的订单,若用户正在通过支付分订单页拉起收银台主动支付或者支付分正在进行自动扣款时,调用修改支付分订单金额API可能会出现"单据正在扣款中,请稍后再试"的报错,可等待3min后重试。

3.已支付的订单,不支持修改订单金额,商户只能通过退款接口将差价退回用户。

接口说明

支持商户:【普通商户】

请求方式:【POST】/v3/payscore/serviceorder/{out_order_no}/modify

请求域名:【主域名】https://api.mch.weixin.qq.com 使用该域名将访问就近的接入点

     【备域名】https://api2.mch.weixin.qq.com 使用该域名将访问异地的接入点 ,指引点击查看

请求参数

Header HTTP头参数

Authorization  必填 string

请参考签名认证生成认证信息


Accept  必填 string

请设置为application/json


Content-Type  必填 string

请设置为application/json


path 路径参数

out_order_no  必填 string(32)

【商户服务订单号】商户系统内部服务订单号,商户在创建支付分接口中填入的out_order_no参数。


body 包体参数

appid  必填 string(32)

【公众账号ID】是微信开放平台和微信公众平台为开发者的应用程序(APP、小程序、公众号)提供的一个唯一标识。 开发者需要先在微信开放平台或微信公众平台中申请ID,然后在商户平台中绑定,详见直连商户与AppID账号关联管理。完结订单和取消订单需要和创单传入的appid保持一致。


service_id  必填 string(32)

【服务ID】商户支付分服务的唯一标识,由32位数字组成。支付分产品权限审核通过后,微信支付运营会向商户提供该ID。


post_payments  必填 array[Payment]

【后付费项目】用于展示订单后付费项目明细,商户需要按照所属行业规程传参,详见post_payments(后付费项目)字段传参说明

属性

post_discounts  选填 array[ServiceOrderCoupon]

【后付费商户优惠】用于展示订单优惠项目明细,最多30条,完结订单时传的收款总金额需满足计算条件(收款总金额=后付费项目amount和-优惠项目amount和)

属性

total_amount  必填 integer

【总金额】订单最终收款总金额,整型,单位为分,商户调用完结订单接口和修改订单金额接口传入,受服务ID风险金额上限影响,服务ID风险金额上限具体请与BD确认。 先免模式:total_amount<=创单risk_fund.amount(押金金额)<=服务ID风险金额上限。 先享模式:total_amount<=服务ID风险金额上限。
需满足计算条件:total_amount = 后付费项目金额(post_payments.amount总和) - 优惠项目金额(post_discounts.amount总和),例如商户后付费项目金额总和为10元,优惠项目金额总和为2元,则订单收款总金额为8元。


reason  必填 string(50)

【修改原因】支付分修改订单原因,长度不能超过50个字符。

请求示例

1curl -X POST \
2  https://api.mch.weixin.qq.com/v3/payscore/serviceorder/1234323JKHDFE1243252/modify \
3  -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \
4  -H "Accept: application/json" \
5  -H "Content-Type: application/json" \
6  -d '{
7    "appid" : "wxd678efh567hg6787",
8    "service_id" : "2002000000000558128851361561536",
9    "post_payments" : [
10      {
11        "name" : "就餐费用",
12        "amount" : 40000,
13        "description" : "就餐人均100元",
14        "count" : 4
15      }
16    ],
17    "post_discounts" : [
18      {
19        "name" : "满20减1元",
20        "description" : "不与其他优惠叠加",
21        "amount" : 100,
22        "count" : 2
23      }
24    ],
25    "total_amount" : 50000,
26    "reason" : "用户投诉"
27  }'
28

应答参数

200 OK

out_order_no  必填 string(32)

【商户服务订单号】商户系统内部服务订单号,商户在创建支付分接口中填入的out_order_no参数。


service_id  必填 string(32)

【服务ID】商户支付分服务的唯一标识,由32位数字组成。支付分产品权限审核通过后,微信支付运营会向商户提供该ID。


appid  必填 string(32)

【服务商公众号ID】是微信开放平台和微信公众平台为开发者的应用程序(APP、小程序、公众号)提供的一个唯一标识。 开发者需要先在微信开放平台或微信公众平台中申请ID,然后在商户平台中绑定,详见直连商户与AppID账号关联管理。完结订单和取消订单需要和创单传入的appid保持一致。


mchid  必填 string(32)

【服务商商户号】调用支付分创单接口提交的商户号,商户号需开通支付分产品权限,且与appid有绑定关系,详见直连商户与AppID账号关联管理


service_introduction  必填 string(20)

【服务信息】用于介绍本订单所提供的服务 ,长度不能超过20个字符(汉字、数字、字母、特殊符号都按照1个字符计算)。


state  必填 string(32)

【服务订单状态】表示支付分订单状态
CREATED:商户已创建服务订单
DOING:服务订单进行中
DONE:服务订单完成(终态)
REVOKED:商户取消服务订单(终态)
EXPIRED:服务订单已失效,"商户已创建服务订单"状态超过30天未变动,则订单失效(终态)
该状态需结合collection.state字段和state_description字段一起判断,具体可参考支付分订单状态流转图


state_description  选填 string(32)

【订单状态说明】此参数用于对服务订单处于DOING状态时的附加说明,非DOIING状态将不会返回该参数。具体状态如下:
USER_CONFIRM:用户已确认状态,表示用户成功确认订单后所处状态。
MCH_COMPLETE:商户已完结状态,指商户调用完结接口成功后至扣款成功前的状态。
该状态需结合collection.state字段和state字段一起判断,具体可参考支付分订单状态流转图


post_payments  必填 array[object]

【后付费项目】用于展示订单后付费项目明细,商户需要按照所属行业规程传参,详见post_payments(后付费项目)字段传参说明

属性

post_discounts  选填 array[object]

【商户优惠】用于展示订单优惠项目明细,最多30条,完结订单时传的收款总金额需满足计算条件(收款总金额=后付费项目amount和-优惠项目amount和)

属性

risk_fund  选填 object

【服务风险金】本笔订单的风险金额描述

属性

total_amount  选填 integer

【总金额】订单最终收款总金额,整型,单位为分,商户调用完结订单接口和修改订单金额接口传入,受服务ID风险金额上限影响,服务ID风险金额上限具体请与BD确认。
先免模式:total_amount<=创单risk_fund.amount(押金金额)<=服务ID风险金额上限。
先享模式:total_amount<=服务ID风险金额上限。
需满足计算条件:total_amount = 后付费项目金额(post_payments.amount总和) - 优惠项目金额(post_discounts.amount总和),例如商户后付费项目金额总和为10元,优惠项目金额总和为2元,则订单收款总金额为8元。


need_collection  选填 boolean

【是否需要收款】订单是否需要收款,固定返回true需收款。


collection  选填 object

【收款信息】订单收款信息,仅在调用完结订单后返回(若完结订单 total_amount 等于 0 元,则不返回此字段)。

属性

time_range  选填 object

【服务时间】用于描述订单的服务开始和结束时间。

属性

location  选填 object

【服务位置】服务使用的开始位置和结束位置

属性

attach  选填 string(256)

【附加数据】商户在创建订单时传入的自定义数据包,用户不可见。用于存放订单的商户自定义数据,需要先进行urlencode编码,总长度不超过256字符。确认订单回调和支付成功回调时会回传该字段给商户。


notify_url  选填 string(256)

【商户回调地址】商户接收确认订单回调通知支付成功回调通知的地址,创单时传入,需按照notify-url填写注意事项规范填写。


order_id  选填 string(64)

【微信支付服务订单号】支付分订单在微信侧的唯一标识,31位数字,开头由1000000000+年月日组成。

应答示例

200 OK

1{
2  "out_order_no" : "1234323JKHDFE1243252",
3  "service_id" : "2002000000000558128851361561536",
4  "appid" : "wxd678efh567hg6787",
5  "mchid" : "1230000109",
6  "service_introduction" : "XX充电宝",
7  "state" : "CREATED",
8  "state_description" : "MCH_COMPLETE",
9  "post_payments" : [
10    {
11      "name" : "就餐费用",
12      "amount" : 40000,
13      "description" : "就餐人均100元",
14      "count" : 4
15    }
16  ],
17  "post_discounts" : [
18    {
19      "name" : "满20减1元",
20      "description" : "不与其他优惠叠加",
21      "amount" : 100,
22      "count" : 2
23    }
24  ],
25  "risk_fund" : {
26    "name" : "DEPOSIT",
27    "amount" : 10000,
28    "description" : "就餐的预估费用"
29  },
30  "total_amount" : 40000,
31  "need_collection" : true,
32  "collection" : {
33    "state" : "USER_PAID",
34    "total_amount" : 50000,
35    "paying_amount" : 40000,
36    "paid_amount" : 10000,
37    "details" : [
38      {
39        "seq" : 1,
40        "amount" : 10000,
41        "paid_type" : "NEWTON",
42        "paid_time" : "20091225091210",
43        "transaction_id" : "15646546545165651651",
44        "promotion_detail" : [
45          {
46            "coupon_id" : "123456",
47            "name" : "单品优惠-6",
48            "scope" : "GLOBAL",
49            "type" : "CASH",
50            "amount" : 100,
51            "stock_id" : "activity_id",
52            "wechatpay_contribute" : 100,
53            "merchant_contribute" : 100,
54            "other_contribute" : 100,
55            "currency" : "CNY",
56            "goods_detail" : [
57              {
58                "goods_id" : "M1006",
59                "quantity" : 1,
60                "unit_price" : 1,
61                "discount_amount" : 100,
62                "goods_remark" : "商品备注信息"
63              }
64            ]
65          }
66        ]
67      }
68    ]
69  },
70  "time_range" : {
71    "start_time" : "20091225091010",
72    "end_time" : "20091225121010",
73    "start_time_remark" : "备注1",
74    "end_time_remark" : "备注2"
75  },
76  "location" : {
77    "start_location" : "嗨客时尚主题展餐厅",
78    "end_location" : "嗨客时尚主题展餐厅"
79  },
80  "attach" : "Easdfowealsdkjfnlaksjdlfkwqoi&wl3l2sald",
81  "notify_url" : "https://api.test.com",
82  "order_id" : "0000300001201908301055157220022"
83}
84

 

错误码

公共错误码

状态码

错误码

描述

解决方案

400

PARAM_ERROR

参数错误

请根据错误提示正确传入参数

400

INVALID_REQUEST

HTTP 请求不符合微信支付 APIv3 接口规则

请参阅 接口规则

401

SIGN_ERROR

验证不通过

请参阅 签名常见问题

500

SYSTEM_ERROR

系统异常,请稍后重试

请稍后重试

业务错误码

状态码

错误码

描述

解决方案

400

INVALID_ORDER_STATE

单据状态错误

确认操作是否符合流程

400

INVALID_REQUEST

请求参数符合参数格式,但不符合业务规则

请确认相同单号是否使用了不同的参数

400

ORDER_CANCELED

单据已取消

当前状态无需操作

400

ORDER_DONE

订单已完成

当前状态无需操作

403

NO_AUTH

商户信息不合法

登录商户平台核对,传入正确信息

404

ORDER_NOT_ EXIST

订单不存在

确认入参,传入正确单据

429

FREQUENCY_LIMITED

频率超限

请求量不要超过接口调用频率限制

500

SYSTEM_ERROR

系统错误

5开头的状态码都为系统问题,请使用相同参数稍后重新调用

 

 

反馈
咨询
目录
置顶