共享单车-post_payments传参说明
更新时间:2024.09.19# 1. 概述
接入微信支付分的商户需在创建、完结、修改订单金额时,通过API接口中的post_payments参数回传详细的后付费项目明细。该明细将在支付分订单详情页面展示,减少用户对订单金额的疑问。
post_payments为数组类型参数,该参数可包含多条“后付费项目明细”,至少传1条明细,最多可传100条明细,每条“后付费项目明细”包含name、amount、description、count四个参数。
# 2. 后付费项目参数传值要求
# 2.1 创建支付分订单接口
共享单车行业的商户在创建支付分订单时,需通过post_payments【后付费项目】参数回传订单的计费规则,以便于在支付分订单明细中向用户展示。
post_payments参数传值要求:
字段简称 | 字段名 | 类型[长度限制] | 是否必填 | 示例值 | 描述 | 传值示例 |
---|---|---|---|---|---|---|
后付费项目名称 | name | string [1, 20] | 必填 | 计费规则 | 付费项目名称,请填写“计费规则”四个字 | "post_payments" : [{"name" : "计费规则","description" : "骑行费用1.5元/30分钟"}] |
后付费项目金额 | amount | int | 不填 | - | 请勿传该字段 | "post_payments" : [{"name" : "计费规则","description" : "骑行费用1.5元/30分钟"}] |
后付费项目说明 | description | string [1, 30] | 必填 | 骑行费用1.5元/30分钟 | 请填写计费规则的详细说明 | "post_payments" : [{"name" : "计费规则","description" : "骑行费用1.5元/30分钟"}] |
后付费项目的数量 | count | int | 不填 | - | 请勿传该字段 | "post_payments" : [{"name" : "计费规则","description" : "骑行费用1.5元/30分钟"}] |
后付费项目明细在支付分订单页面的实际展示效果(以下两种呈现形式为版本差异,均符合预期):
# 2.2 完结支付分订单接口
当服务结束后,商户调用完结支付分订单接口,需通过post_payments【后付费项目】参数回传订单实际的付费项目,在共享单车行业中,只允许回传“计费规则、骑行时长、骑行费用、调度费用、头盔费用、罚款”这6类付费项目。
post_payments必须包含一项“计费规则”和一项“骑行时长”的后付费项目明细;若实际收费中,还有“骑行费用”“调度费用”“头盔费用”“罚款”,请按照实际情况添加后付费项目明细。
例:如果订单没有“骑行费用、调度费用、头盔费用、罚款”这些付费项目,传参时只需传“计费规则”“骑行时长”两项后付费项目明细,如果有“骑行费用”,则需要传“计费规则”“骑行时长”“骑行费用”三项后付费项目明细。
post_payments参数传值要求:
字段简称 | 字段名 | 类型[长度限制] | 是否必填 | 示例值 | 描述 | 传值示例(只有必填的项目明细) | 传值示例(含选填的项目明细) |
---|---|---|---|---|---|---|---|
后付费项目名称 | name | string [1, 20] | 必填 | 计费规则 | 付费项目名称,只可填写如下取值 可选取值: 计费规则、骑行时长、骑行费用、调度费用、头盔费用、罚款 | "post_payments" : [{"name" : "计费规则","description" : "骑行费用1.5元/30分钟"},{"name" : "骑行时长","description" : "1小时38分20秒"}] | "post_payments" : [{"name" : "计费规则","description" : "骑行费用1.5元/30分钟"},{"name" : "骑行时长","description" : "1小时38分20秒"},{"name" : "骑行费用","amount" : 600}] |
后付费项目金额 | amount | int | 选填 | 1200 | 付费项目金额,单位为分 付费名称为“计费规则”“骑行时长”时请勿传该字段,其他付费名称必传该字段 | "post_payments" : [{"name" : "计费规则","description" : "骑行费用1.5元/30分钟"},{"name" : "骑行时长","description" : "1小时38分20秒"}] | "post_payments" : [{"name" : "计费规则","description" : "骑行费用1.5元/30分钟"},{"name" : "骑行时长","description" : "1小时38分20秒"},{"name" : "骑行费用","amount" : 600}] |
后付费项目说明 | description | string [1, 30] | 选填 | 骑行费用1.5元/30分钟 | 对付费项目的详细说明 付费名称为“计费规则”“骑行时长”时必传该字段,其他付费名称请勿传该字段 | "post_payments" : [{"name" : "计费规则","description" : "骑行费用1.5元/30分钟"},{"name" : "骑行时长","description" : "1小时38分20秒"}] | "post_payments" : [{"name" : "计费规则","description" : "骑行费用1.5元/30分钟"},{"name" : "骑行时长","description" : "1小时38分20秒"},{"name" : "骑行费用","amount" : 600}] |
后付费项目的数量 | count | int | 不填 | - | 请勿传该字段 | "post_payments" : [{"name" : "计费规则","description" : "骑行费用1.5元/30分钟"},{"name" : "骑行时长","description" : "1小时38分20秒"}] | "post_payments" : [{"name" : "计费规则","description" : "骑行费用1.5元/30分钟"},{"name" : "骑行时长","description" : "1小时38分20秒"},{"name" : "骑行费用","amount" : 600}] |
后付费项目明细在支付分订单页面的实际展示效果(以下两种呈现形式为版本差异,均符合预期):
# 2.3 修改订单金额接口
完结支付分订单后,且订单还处于“待支付(USER_PAYING)”状态时,可调用修改订单金额接口“下调”订单的金额,传值要求与完结支付分订单接口传值要求一致。