完结订单总金额与实际金额不符时,可通过该接口修改订单金额。
注意:
• 若此笔订单已收款成功,商户直接使用退款能力,将差价退回用户即可。
• 修改次数>=1,第n次修改后金额 <第n-1次修改后金额
特别注意:待支付(USER_PAYING)状态下,当用户正在尝试通过收银台主动支付订单金额时,修改订单金额API无法调用成功,可等待3min后重试
请求方法
参数名 | 参数描述 | 类型[长度限制] | 必填 | 备注 |
---|---|---|---|---|
method | 方法名 | string[1,32] | 是 | SERVICEORDER_UPDATE |
requestDate | 交易日期 | string[1,14] | 是 | 格式[yyyyMMddHHmmss], 如:20190101140908 |
version | 版本 | string[1,16] | 是 | 接口版本:1.0 |
format | 请求格式 | string[1,16] | 是 | 业务请求参数格式,支持:JSON |
merchantNo | 商户号 | string[1,16] | 是 | 商户在慧收钱的商户号,由慧收钱生成并下发 |
signType | 加密类型 | string[1,16] | 是 | RSA2:签名机制查看说明 |
signContent | 业务数据 | string | 是 | 业务请求参数 |
sign | 签名数据 | string[1,128] | 否 | 签名数据 |
加密参数
参数名 | 参数描述 | 类型[长度限制] | 必填 | 备注 |
---|---|---|---|---|
transNo | 商户订单号 | string[1,64] | 是 | 商户系统内部订单号保证不重复 |
totalAmount | 总金额 | int64 | 是 | 总金额,单位为分,不能超过完结订单时候的总金额,只能为整数 |
serviceId | 服务ID | string[1,32] | 是 | 调用该接口提交的服务ID。 示例值:500001 |
appid | 应用ID | string[1,32] | 是 | 调用接口提交的公众账号ID。 示例值:wxd678efh567hg6787 |
reason | 修改原因 | string[1,50] | 是 | 最多50个字符,每个汉字/数字/英语都按1个字符计算超过长度报错处理。 |
postPayments | 后付费项目 | array | 否 | 后付费项目列表,最多包含100条付费项目 |
postDiscounts | 后付费商户优惠 | array | 否 | 后付费商户优惠,最多包含30条付费项目。如果传入,用户侧则显示此参数。 |
后付费项目参数域
参数名 | 参数描述 | 类型[长度限制] | 必填 | 备注 |
---|---|---|---|---|
name | 付费项目名称 | string[1,20] | 否 | 不超过20个字符,超出报错处理。 示例值:就餐费用, 服务费 |
amount | 金额 | int64 | 条件选填 | 此付费项目总金额,大于等于0,单位为分,等于0时代表不需要扣费,只能为整数,详见支付金额。 如果填写了“付费项目名称”,则amount或description必须填写其一,或都填。 示例值:40000 |
description | 计费说明 | string[1,30] | 条件选填 | 描述计费规则,不超过30个字符,超出报错处理。 示例值:就餐人均100元,服务费:100/小时 |
count | 付费数量 | int32 | 否 | 付费项目的数量。 示例值:4 |
后付费商户优惠参数域
参数名 | 参数描述 | 类型[长度限制] | 必填 | 备注 |
---|---|---|---|---|
name | 优惠名称 | string[1,20] | 否 | 优惠名称说明。 |
amount | 优惠金额 | int | 否 | 优惠金额,只能为整数,详见支付金额。示例值:100 |
description | 优惠说明 | string[1,30] | 否 | 优惠使用条件说明。 如果填写了name(优惠名称)和description(优惠说明)其中一个字段内容,则另一个字段也必须填写。示例值:不与其他优惠叠加 |
count | 优惠数量 | int32 | 否 | 优惠的数量。 特殊规则:数量限制100,不填时默认1。 示例值:2 |
加密数据模板
公共响应参数
变量 | 参数名 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
success | 响应状态 | string[1,32] | 是 | 服务端响应状态,如果为true,则可以调用result;如果为false,则调用errorCode来获取出错信息 |
errorCode | 错误码 | string[1,32] | 否 | 响应码 |
errorMsg | 错误描述 | string[1,128] | 否 | 响应描述 |
result | 响应内容 | string | 否 | 业务响应参数 |
sign | 签名数据 | string[1,128] | 否 | 响应验签数据 |
业务响应参数
参数名 | 参数描述 | 类型[长度限制] | 必填 | 备注 |
---|---|---|---|---|
transNo | 商户订单号 | string[1,64] | 是 | 商户系统内部订单号保证不重复 |
tradeNo | 交易订单号 | string[1,32] | 是 | 支付平台交易订单号 |
serviceId | 服务ID | string[1,32] | 是 | 调用该接口提交的服务ID。 示例值:500001 |
appid | 应用ID | string[1,32] | 是 | 调用接口提交的公众账号ID。 示例值:wxd678efh567hg6787 |
goodsInfo | 服务信息 | string[1,20] | 是 | 服务信息,用于介绍本订单所提供的服务不超过20个字符,超出报错处理。 示例值:嗨客餐厅用餐 |
state | 服务订单状态 | string[1,32] | 是 | 表示当前单据状态。枚举值: 1、CREATED:商户已创建服务订单 2、DOING:服务订单进行中 3、DONE:服务订单完成 4、REVOKED:商户取消服务订单 5、EXPIRED:服务订单已失效 示例值:CREATED |
stateDescription | 订单状态说明 | string[1,32] | 否 | 对服务订单”进行中”状态的附加说明。 1、USER_CONFIRM:用户确认 2、MCH_COMPLETE:商户完结 示例值:MCH_COMPLETE |
totalAmount | 收款总金额 | int64 | 否 | 总金额,大于等于0的数字,单位为分,只能为整数 |
respCode | 错误码 | string[1,32] | 是 | 详见错误码 |
respMsg | 错误信息 | string[1,128] | 是 | 详见错误码 |
needCollection | 是否需要收款 | bool | 是 | true:微信支付分代收款 false:无需微信支付分代收款 |
postPayments | 后付费项目 | array | 是 | 后付费项目列表,最多包含100条付费项目 |
postDiscounts | 后付费商户优惠 | array | 否 | 后付费商户优惠,最多包含30条付费项目。如果传入,用户侧则显示此参数。 |
riskFund | 订单风险金 | object | 是 | 订单风险金信息 |
timeRange | 服务时间段 | object | 否 | 服务时间范围 |
location | 服务位置 | object | 否 | 服务使用信息。如果传入,用户侧则显示此参数。 |
collection | 收款信息 | object | 否 | 服务使用信息 |
后付费项目参数域
参数名 | 参数描述 | 类型[长度限制] | 必填 | 备注 |
---|---|---|---|---|
name | 付费项目名称 | string[1,20] | 否 | 不超过20个字符,超出报错处理。 示例值:就餐费用, 服务费 |
amount | 金额 | int64 | 条件选填 | 此付费项目总金额,大于等于0,单位为分,等于0时代表不需要扣费,只能为整数,详见支付金额。 如果填写了“付费项目名称”,则amount或description必须填写其一,或都填。示例值:40000 |
description | 计费说明 | string[1,30] | 条件选填 | 描述计费规则,不超过30个字符,超出报错处理。 |
count | 付费数量 | int32 | 否 | 付费项目的数量。 示例值:4 |
后付费商户优惠参数域
参数名 | 参数描述 | 类型[长度限制] | 必填 | 备注 |
---|---|---|---|---|
name | 优惠名称 | string[1,20] | 否 | 优惠名称说明。 |
amount | 优惠金额 | int | 否 | 优惠金额,只能为整数,详见支付金额。示例值:100 |
description | 优惠说明 | string[1,30] | 否 | 优惠使用条件说明。 如果填写了name(优惠名称)和description(优惠说明)其中一个字段内容,则另一个字段也必须填写。示例值:不与其他优惠叠加 |
count | 优惠数量 | int32 | 否 | 优惠的数量。特殊规则:数量限制100,不填时默认1。 示例值:2 |
订单风险金参数域
参数名 | 参数描述 | 类型[长度限制] | 必填 | 备注 |
---|---|---|---|---|
name | 风险金名称 | string[1,64] | 是 | 枚举值: 【先免模式】(评估不通过可交押金)可填名称为 DEPOSIT:押金ADVANCE:预付款 CASH_DEPOSIT:保证金 【先享模式】(评估不通过不可使用服务)可填名称为 ESTIMATE_ORDER_COST:预估订单费用 示例值:DEPOSIT |
amount | 风险金额 | int32 | 是 | 1、数字,必须>0(单位分)。 2、风险金额≤服务ID的风险金额上限。 3、当商户优惠字段为空时,付费项目总金额≤服务ID的风险金额上限 (未填写金额的付费项目,视为该付费项目金额为0)。 4、完结订单的总金额和风险金额的关系。 1)【评估不通过:交押金】模式:总金额≤创单时填写的“订单风险金额” 2)【评估不通过:拒绝】模式:总金额≤“每个服务ID的风险金额上限”示例值:10000 |
description | 风险说明 | string[1,30] | 否 | 优惠使用条件说明。 如果填写了name(优惠名称)和description(优惠说明)其中一个字段内容,则另一个字段也必须填写。示例值:不与其他优惠叠加 |
服务时间段参数域
参数名 | 参数描述 | 类型[长度限制] | 必填 | 备注 |
---|---|---|---|---|
startTime | 服务开始时间 | string[1,14] | 是 | 用户端展示用途。格式:yyyyMMddHHmmss、yyyyMMdd和 OnAccept |
startTimeRemark | 服务开始时间备注 | string[1,20] | 否 | 服务开始时间备注说明 |
endTime | 预计服务结束时间 | string[1,14] | 是 | 用户端展示用途。格式:yyyyMMddHHmmss或yyyyMMdd |
endTimeRemark | 预计服务结束时间备注 | string[1,20] | 否 | 预计服务结束时间备注说明,预计服务结束时间有填时可填写 |
服务位置参数域
参数名 | 参数描述 | 类型[长度限制] | 必填 | 备注 |
---|---|---|---|---|
startLocation | 服务开始地点 | string[1,50] | 否 | 开始使用服务的地点,不超过50个字符,超出报错处理。 |
endLocation | 服务结束位置 | string[1,50] | 否 | 结束使用服务的地点,不超过50个字符,超出报错处理。 示例值:嗨客时尚主题展餐厅 |
收款信息参数域
参数名 | 参数描述 | 类型[长度限制] | 必填 | 备注 |
---|---|---|---|---|
state | 收款状态 | string[1,50] | 是 | USER_PAYING:待支付 USER_PAID:已支付 |
totalAmount | 总收款金额 | int64 | 否 | 总金额,大于等于0的数字,单位为分,只能为整数,详见支付金额。此参数需满足:总金额=付费项目金额之和-商户优惠项目金额之和,且小于等于订单风险金额 。未使用服务、取消订单时,该字段必须为0。 |
payingAmount | 待收金额 | int64 | 否 | 等待用户付款金额,只能为整数 |
paidAmount | 已收金额 | int64 | 否 | 用户已付款的金额,只能为整数 |
details | 收款明细列表 | array | 否 | 收款明细列表 |
收款明细列表参数域
参数名 | 参数描述 | 类型[长度限制] | 必填 | 备注 |
---|---|---|---|---|
seq | 收款序号 | uint64 | 否 | 从1开始递增 示例值:1 |
amount | 单笔收款金额 | int64 | 否 | 单笔收款动作的金额,只能为整数,详见支付金额。 示例值:10000 |
paidType | 收款成功渠道 | string[1,32] | 否 | NEWTON:微信支付分 MCH:商户渠道 示例值:NEWTON |
paidTime | 收款成功时间 | string[1,14] | 否 | 支付成功时间,支持两种格式:yyyyMMddHHmmss和yyyyMMdd ● 传入20091225091010表示2009年12月25日9点10分10秒 ● 传入20091225默认认为时间为2009年12月25日0点0分0秒 示例值:20091225091210 |
transactionId | 微信支付交易单号 | string[1,200] | 否 | 结单交易单号,等于普通支付接口中的transaction_id,可以使用该订单号在APP支付->API列表->查询订单、申请退款。只有单据状态为USER_PAID,且收款成功渠道为支付分渠道,收款金额大于0,才会返回结单交易单号。 示例值:15646546545165651651 |
响应格式
{
"success": true,
"result": "88faca1f2511cc194367ffd96aa78a4cdf25a8284b0cd74b75e331b37c642b26aaeb46f2e4be38080eeb2b78575abd715d58fd30bbf59e167d64d0b714487f9462381e499a48524b1704694f256fa8f6e917d33cd413e365872ef2c7eede37ab4b23f67dcf6f34ec0daf65a34502123f792a646bea6447c126a612087825b17b91e585f74e56220328b198982e62a734387cd8556927e6881878b821969b6e784a20771cf55fad70a4368b8650c0ece0a7903678e1ad6134f6c711329a3e3e456c28ffbfc607fa6bf1f969a4d38b35ca3bf9ad81f71b2d2ad816502d579c0c4fc1f1fccec74a861c4679c5217be0176bf1eebcb57aea381f922fcf920aa471198be972f0c4f9fab10f7885b9c09eda977351b40e9058247ec30da55dd4c0be4a9de7d996e186e9f9ff2693f564f0eaddca9d7ff9f3b813d0c70bdba75b2a1bf9bd4ddf28ff66c45d6ce31e188d8606c82078d842008a9a1b4c1b64b7b2d3632087e46bbc4322181a9832cecd852682fdb72d336b32512bde94e81ba322fe9d2d",
"errorCode": null,
"errorMsg": null
}
密文解密参数
作者:xiaochen 创建时间:2023-05-24 14:41
最后编辑:admin 更新时间:2025-01-09 17:41
最后编辑:admin 更新时间:2025-01-09 17:41