快递行业-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" : "预估金额","amount" : 1200}]
后付费项目金额 amount int 必填 1200 付费项目金额,单位为分 "post_payments" : [{"name" : "预估金额","amount" : 1200}]
后付费项目说明 description string [1, 30] 不填 - 请勿传该字段 "post_payments" : [{"name" : "预估金额","amount" : 1200}]
后付费项目的数量 count int 不填 - 请勿传该字段 "post_payments" : [{"name" : "预估金额","amount" : 1200}]

后付费项目明细在支付分订单页面的实际展示效果(以下两种呈现形式为版本差异,均符合预期):

示例图

# 2.2 完结支付分订单接口

当服务结束后,商户调用完结支付分订单接口,需通过post_payments【后付费项目】参数回传订单实际的付费项目,在快递行业中,只允许回传“首重费、续重费、包装费、保价费”这4类付费项目

post_payments必须包含一笔“首重费”的后付费项目;若实际收费中,还有“续重费”“包装费”“保价费”,请按照实际情况添加后付费项目明细。

例如:如果只有一笔后付费项目,只能传“首重费”,如果有多笔后付费项目,则必须包含一笔“首重费”,其他费用按照实际填写,详见传值示例。

post_payments参数传值要求:

字段简称 字段名 类型[长度限制] 是否必填 示例值 描述 传值示例(只有首重费) 传值示例(含有首重费、续重费)
后付费项目名称 name string [1, 20] 必填 首重费 付费项目名称,只可填写如下取值
可选取值:
首重费、续重费、包装费、保价费
"post_payments" : [{"name" : "首重费","amount" : 1200}] "post_payments" : [{"name" : "首重费","amount" : 1200},{"name" : "续重费","amount" : 1200}]
后付费项目金额 amount int 必填 1200 付费项目金额,单位为分 "post_payments" : [{"name" : "首重费","amount" : 1200}] "post_payments" : [{"name" : "首重费","amount" : 1200},{"name" : "续重费","amount" : 1200}]
后付费项目说明 description string [1, 30] 不填 - 请勿传该字段 "post_payments" : [{"name" : "首重费","amount" : 1200}] "post_payments" : [{"name" : "首重费","amount" : 1200},{"name" : "续重费","amount" : 1200}]
后付费项目的数量 count int 不填 - 请勿传该字段 "post_payments" : [{"name" : "首重费","amount" : 1200}] "post_payments" : [{"name" : "首重费","amount" : 1200},{"name" : "续重费","amount" : 1200}]

后付费项目明细在支付分订单页面的实际展示效果(以下两种呈现形式为版本差异,均符合预期):

示例图

# 2.3 修改订单金额接口

完结支付分订单后,且订单还处于“待支付(USER_PAYING)”状态时,可调用修改订单金额接口“下调”订单的金额,传值要求与完结支付分订单接口传值要求一致。