更新时间:2024-10-23 18:07:11配置项检测工具收藏订阅更新我的文档设置接入检测(即可查看检测结果)若有未通过的接入检测项,接口将无法调通去登录返回文档商家需通过 alipay.merchant.order.sync(订单数据同步接口) 订单扩展字段 ext_info#merchant_order_status 参数更新订单状态,充值专用状态如下。订单状态流转说明订单状态流转图说明:左侧表示起始状态,右侧表示允许的后置状态。订单状态说明●支持跨状态传递,如:pay_waiting(待付款)可直接跳转至 recharge_s(充值成功)。●不要求首次同步订单状态必须为 pay_waiting(待付款)。●当前场景定义的订单状态(中文和英文名)如下:状态中文名状态英文名是否发送服务消息待付款pay_waiting是支付成功paid否充值成功recharge_s是充值失败recharge_f是已退款refunded是已取消cancelled否不同状态参数使用说明待付款 (pay_waiting)本文详细介绍通过接口 alipay.merchant.order.sync 同步订单状态-待付款 (pay_waiting)时需传入的商品信息及扩展字段参数信息。接口参数 bizcontent 示例 参数说明参数参数说明是否必填能否更新是否消息使用字段参数说明out_biz_nostring是否是外部订单号。由商家自定义。注意:同一笔订单更新状态时,需与首次同步入参一致。buyer_id(buyer_open_id)string是否否支付宝用户唯一标识。新商户建议使用open_id替代该字段。对于新商户,user_id字段未来计划逐步回收,存量商户可继续使用。如使用open_id,请确认 应用-开发配置-openid配置管理 已启用。无该配置项,可查看 。order_typestring是否否订单类型。固定为 service_order(服务订单)。order_create_timestring是否是订单创建时间,即该笔订单真实的创建时间。时间格式为 yyyy-mm-dd hh:mm:ss。order_modified_timestring是是否订单修改时间,时间格式为 yyyy-mm-dd hh:mm:ss.sss。用于订单状态或数据变化较快的顺序控制,防止乱序。order_modified_time 较晚的同步会被最终存储,order_modified_time 相同的两次同步会被幂等处理。source_appstring否否否订单来源,默认 alipay(支付宝小程序)。枚举支持:dingtalk:钉钉;alipay:支付宝小程序。说明:其它来源枚举值定义可联系支付宝运营人员添加。item_order_listitemorderinfo是否否商品信息列表,详情可查看下文 商品信息列表。ext_infoorderextinfo是是否订单扩展字段。详情可查看下文 订单扩展字段。trade_nostring否否否支付宝交易号。amountprice是是否订单总金额:某笔交易订单优惠前的总金额,单位为【元】注意事项service_order且不涉及金额可不传入该字段,其他场景必传pay_amountprice选填,建议传入该参数否否用户应付金额 :用户最终结算时需要支付金额(不包含选择支付宝付款时,支付宝给予的优惠减免金额),单位为【元】注意事项service_order且不涉及金额可不传入该字段,其他场景必传discount_amountprice否否否商户总计优惠金额:代表商户侧给予用户的总计优惠金额 (不包含选择支付宝付款时,支付宝给予的优惠减免金额),单位为【元】。订单扩展字段开发者需通过订单扩展字段(ext_info)更新订单状态,订单业务信息,订单类型等数据,入参为 ext_key(对应参数的key)、ext_value(对应参数的value) 配合使用。参数说明如下:参数参数说明是否必填能否更新是否消息使用字段参数说明l ext_keystring是否否订单状态 key。固定为 merchant_order_status。l ext_valuestring是是否订单状态,如: pay_waiting。l ext_keystring是否否订单类型 key。固定为 merchant_biz_type。l ext_valuestring是否否订单类型 value。本业务场景为 recharge。l ext_keystring是否是订单详情地址 key。固定为 merchant_order_link_page。l ext_valuestring是否是商家小程序对应的订单详情页路径地址 value。仅需传入小程序页面路径即可。同一笔订单的链接必须与第一次传入的地址相同,且需是小程序内部页面路径,例如:/pages/index/index?orderid=10190608609185。l ext_keystring是否否商家小程序 appid key。固定为 tiny_app_id。l ext_valuestring是否否商家小程序 appid value。传入订单归属的小程序 appid。商品信息列表开发者需通过商品信息列表字段(item_order_list)传入商品图片、商品详情页等信息。参数说明如下:参数参数说明是否必填能否更新是否消息使用字段参数说明item_namestring是否是商品名称。建议商品名称格式为:{商家名称} {商品名称} ext_infoorderextinfo是否否商品扩展参数。该参数用于传入用户购买商品图片及商家商品详情页地址等信息。l ext_keystring是否否商品图片 key。固定为 image_material_id。l ext_valuestring是否否商品图片 value。需传入 上传商品文件 获取的 material_id。支付成功 (paid)本文详细介绍通过接口 alipay.merchant.order.sync 同步订单状态-支付成功 (paid)时需传入的商品信息及扩展字段参数信息。接口参数 bizcontent 示例 参数说明参数参数说明是否必填能否更新是否消息使用字段参数说明out_biz_nostring是否否外部订单号。由商家自定义。注意:同一笔订单更新状态时,需与首次同步入参一致。buyer_id(buyer_open_id)string是否否支付宝用户唯一标识。新商户建议使用open_id替代该字段。对于新商户,user_id字段未来计划逐步回收,存量商户可继续使用。如使用open_id,请确认 应用-开发配置-openid配置管理 已启用。无该配置项,可查看 。order_typestring是否否订单类型。固定为 service_order(服务订单)。order_create_timestring是否否订单创建时间,即该笔订单真实的创建时间。时间格式为 yyyy-mm-dd hh:mm:ss。order_modified_timestring是是否订单修改时间,时间格式为 yyyy-mm-dd hh:mm:ss.sss。用于订单状态或数据变化较快的顺序控制,防止乱序。order_modified_time 较晚的同步会被最终存储,order_modified_time 相同的两次同步会被幂等处理。source_appstring否否否订单来源,默认 alipay(支付宝小程序)。枚举支持:dingtalk:钉钉;alipay:支付宝小程序。说明:其它来源枚举值定义可联系支付宝运营人员添加。item_order_listitemorderinfo是否否商品信息列表,详情可查看下文 商品信息列表。ext_infoorderextinfo是是否订单扩展字段。详情可查看下文 订单扩展字段。trade_nostring是否否支付宝交易号。amountprice是是否订单总金额:某笔交易订单优惠前的总金额,单位为【元】注意事项service_order且不涉及金额可不传入该字段,其他场景必传pay_amountprice是否否用户应付金额 :用户最终结算时需要支付金额(不包含选择支付宝付款时,支付宝给予的优惠减免金额),单位为【元】注意事项service_order且不涉及金额可不传入该字段,其他场景必传discount_amountprice否否否商户总计优惠金额:代表商户侧给予用户的总计优惠金额 (不包含选择支付宝付款时,支付宝给予的优惠减免金额),单位为【元】。订单扩展字段开发者需通过订单扩展字段(ext_info)更新订单状态,订单业务信息,订单类型等数据,入参为 ext_key(对应参数的key)、ext_value(对应参数的value) 配合使用。参数说明如下:参数参数说明是否必填能否更新是否消息使用字段参数说明l ext_keystring是否否订单状态 key。固定为 merchant_order_status。l ext_valuestring是是否订单状态,如: paid。l ext_keystring是否否订单类型 key。固定为 merchant_biz_type。l ext_valuestring是否否订单类型 value。本业务场景为 recharge。l ext_keystring是否否订单详情地址 key。固定为 merchant_order_link_page。l ext_valuestring是否否商家小程序对应的订单详情页路径地址 value。仅需传入小程序页面路径即可。同一笔订单的链接必须与第一次传入的地址相同,且需是小程序内部页面路径,例如:/pages/index/index?orderid=10190608609185。l ext_keystring是否否商家小程序 appid key。固定为 tiny_app_id。l ext_valuestring是否否商家小程序 appid value。传入订单归属的小程序 appid。商品信息列表开发者需通过商品信息列表字段(item_order_list)传入商品图片、商品详情页等信息。参数说明如下:参数参数说明是否必填能否更新是否消息使用字段参数说明item_namestring是否否商品名称。建议商品名称格式为:{商家名称} {商品名称} ext_infoorderextinfo是否否商品扩展参数。该参数用于传入用户购买商品图片及商家商品详情页地址等信息。l ext_keystring是否否商品图片 key。固定为 image_material_id。l ext_valuestring是否否商品图片 value。需传入 上传商品文件 获取的 material_id。充值成功 (recharge_s)本文详细介绍通过接口 alipay.merchant.order.sync 同步订单状态-充值成功 (recharge_s)时需传入的商品信息及扩展字段参数信息。接口参数 bizcontent 示例 参数说明参数参数说明是否必填能否更新是否消息使用字段参数说明out_biz_nostring是否是外部订单号。由商家自定义。注意:同一笔订单更新状态时,需与首次同步入参一致。buyer_id(buyer_open_id)string是否否支付宝用户唯一标识。新商户建议使用open_id替代该字段。对于新商户,user_id字段未来计划逐步回收,存量商户可继续使用。如使用open_id,请确认 应用-开发配置-openid配置管理 已启用。无该配置项,可查看 。order_typestring是否否订单类型。固定为 service_order(服务订单)。order_create_timestring是否否订单创建时间,即该笔订单真实的创建时间。时间格式为 yyyy-mm-dd hh:mm:ss。order_modified_timestring是是否订单修改时间,时间格式为 yyyy-mm-dd hh:mm:ss.sss。用于订单状态或数据变化较快的顺序控制,防止乱序。order_modified_time 较晚的同步会被最终存储,order_modified_time 相同的两次同步会被幂等处理。source_appstring否否否订单来源,默认 alipay(支付宝小程序)。枚举支持:dingtalk:钉钉;alipay:支付宝小程序。说明:其它来源枚举值定义可联系支付宝运营人员添加。item_order_listitemorderinfo是否否商品信息列表,详情可查看下文 商品信息列表。ext_infoorderextinfo是是否订单扩展字段。详情可查看下文 订单扩展字段。trade_nostring是否否支付宝交易号。amountprice是是否订单总金额:某笔交易订单优惠前的总金额,单位为【元】注意事项service_order且不涉及金额可不传入该字段,其他场景必传pay_amountprice是否否用户应付金额 :用户最终结算时需要支付金额(不包含选择支付宝付款时,支付宝给予的优惠减免金额),单位为【元】注意事项service_order且不涉及金额可不传入该字段,其他场景必传discount_amountprice否否否商户总计优惠金额:代表商户侧给予用户的总计优惠金额 (不包含选择支付宝付款时,支付宝给予的优惠减免金额),单位为【元】。订单扩展字段开发者需通过订单扩展字段(ext_info)更新订单状态,订单业务信息,订单类型等数据,入参为 ext_key(对应参数的key)、ext_value(对应参数的value) 配合使用。参数说明如下:参数参数说明是否必填能否更新是否消息使用字段参数说明l ext_keystring是否否订单状态 key。固定为 merchant_order_status。l ext_valuestring是是否订单状态,如: recharge_s。l ext_keystring是否否订单类型 key。固定为 merchant_biz_type。l ext_valuestring是否否订单类型 value。本业务场景为 recharge。l ext_keystring是否是订单详情地址 key。固定为 merchant_order_link_page。l ext_valuestring是否是商家小程序对应的订单详情页路径地址 value。仅需传入小程序页面路径即可。同一笔订单的链接必须与第一次传入的地址相同,且需是小程序内部页面路径,例如:/pages/index/index?orderid=10190608609185。l ext_keystring是否否商家小程序 appid key。固定为 tiny_app_id。l ext_valuestring是否否商家小程序 appid value。传入订单归属的小程序 appid。商品信息列表开发者需通过商品信息列表字段(item_order_list)传入商品图片、商品详情页等信息。参数说明如下:参数参数说明是否必填能否更新是否消息使用字段参数说明item_namestring是否是商品名称。建议商品名称格式为:{商家名称} {商品名称} ext_infoorderextinfo是否否商品扩展参数。该参数用于传入用户购买商品图片及商家商品详情页地址等信息。l ext_keystring是否否商品图片 key。固定为 image_material_id。l ext_valuestring是否否商品图片 value。需传入 上传商品文件 获取的 material_id。充值失败 (recharge_f)本文详细介绍通过接口 alipay.merchant.order.sync 同步订单状态-充值失败 (recharge_f)时需传入的商品信息及扩展字段参数信息。接口参数 bizcontent 示例 参数说明参数参数说明是否必填能否更新是否消息使用字段参数说明out_biz_nostring是否是外部订单号。由商家自定义。注意:同一笔订单更新状态时,需与首次同步入参一致。buyer_id(buyer_open_id)string是否否支付宝用户唯一标识。新商户建议使用open_id替代该字段。对于新商户,user_id字段未来计划逐步回收,存量商户可继续使用。如使用open_id,请确认 应用-开发配置-openid配置管理 已启用。无该配置项,可查看 。order_typestring是否否订单类型。固定为 service_order(服务订单)。order_create_timestring是否否订单创建时间,即该笔订单真实的创建时间。时间格式为 yyyy-mm-dd hh:mm:ss。order_modified_timestring是是否订单修改时间,时间格式为 yyyy-mm-dd hh:mm:ss.sss。用于订单状态或数据变化较快的顺序控制,防止乱序。order_modified_time 较晚的同步会被最终存储,order_modified_time 相同的两次同步会被幂等处理。source_appstring否否否订单来源,默认 alipay(支付宝小程序)。枚举支持:dingtalk:钉钉;alipay:支付宝小程序。说明:其它来源枚举值定义可联系支付宝运营人员添加。item_order_listitemorderinfo是否否商品信息列表,详情可查看下文 商品信息列表。ext_infoorderextinfo是是否订单扩展字段。详情可查看下文 订单扩展字段。trade_nostring是否否支付宝交易号。amountprice是是否订单总金额:某笔交易订单优惠前的总金额,单位为【元】注意事项service_order且不涉及金额可不传入该字段,其他场景必传pay_amountprice是否否用户应付金额 :用户最终结算时需要支付金额(不包含选择支付宝付款时,支付宝给予的优惠减免金额),单位为【元】注意事项service_order且不涉及金额可不传入该字段,其他场景必传discount_amountprice否否否商户总计优惠金额:代表商户侧给予用户的总计优惠金额 (不包含选择支付宝付款时,支付宝给予的优惠减免金额),单位为【元】。订单扩展字段开发者需通过订单扩展字段(ext_info)更新订单状态,订单业务信息,订单类型等数据,入参为 ext_key(对应参数的key)、ext_value(对应参数的value) 配合使用。参数说明如下:参数参数说明是否必填能否更新是否消息使用字段参数说明l ext_keystring是否否订单状态 key。固定为 merchant_order_status。l ext_valuestring是是否订单状态,如: recharge_f。l ext_keystring是否否订单类型 key。固定为 merchant_biz_type。l ext_valuestring是否否订单类型 value。本业务场景为 recharge。l ext_keystring是否是订单详情地址 key。固定为 merchant_order_link_page。l ext_valuestring是否是商家小程序对应的订单详情页路径地址 value。仅需传入小程序页面路径即可。同一笔订单的链接必须与第一次传入的地址相同,且需是小程序内部页面路径,例如:/pages/index/index?orderid=10190608609185。l ext_keystring是否否商家小程序 appid key。固定为 tiny_app_id。l ext_valuestring是否否商家小程序 appid value。传入订单归属的小程序 appid。商品信息列表开发者需通过商品信息列表字段(item_order_list)传入商品图片、商品详情页等信息。参数说明如下:参数参数说明是否必填能否更新是否消息使用字段参数说明item_namestring是否是商品名称。建议商品名称格式为:{商家名称} {商品名称} ext_infoorderextinfo是否否商品扩展参数。该参数用于传入用户购买商品图片及商家商品详情页地址等信息。l ext_keystring是否否商品图片 key。固定为 image_material_id。l ext_valuestring是否否商品图片 value。需传入 上传商品文件 获取的 material_id。已退款 (refunded)本文详细介绍通过接口 alipay.merchant.order.sync 同步订单状态-已退款 (refunded)时需传入的商品信息及扩展字段参数信息。接口参数 bizcontent 示例 参数说明参数参数说明是否必填能否更新是否消息使用字段参数说明out_biz_nostring是否是外部订单号。由商家自定义。注意:同一笔订单更新状态时,需与首次同步入参一致。buyer_id(buyer_open_id)string是否否支付宝用户唯一标识。新商户建议使用open_id替代该字段。对于新商户,user_id字段未来计划逐步回收,存量商户可继续使用。如使用open_id,请确认 应用-开发配置-openid配置管理 已启用。无该配置项,可查看 。order_typestring是否否订单类型。固定为 service_order(服务订单)。order_create_timestring是否是订单创建时间,即该笔订单真实的创建时间。时间格式为 yyyy-mm-dd hh:mm:ss。order_modified_timestring是是否订单修改时间,时间格式为 yyyy-mm-dd hh:mm:ss.sss。用于订单状态或数据变化较快的顺序控制,防止乱序。order_modified_time 较晚的同步会被最终存储,order_modified_time 相同的两次同步会被幂等处理。source_appstring否否否订单来源,默认 alipay(支付宝小程序)。枚举支持:dingtalk:钉钉;alipay:支付宝小程序。说明:其它来源枚举值定义可联系支付宝运营人员添加。item_order_listitemorderinfo是否否商品信息列表,详情可查看下文 商品信息列表。ext_infoorderextinfo是是否订单扩展字段。详情可查看下文 订单扩展字段。trade_nostring是否否支付宝交易号。amountprice是是否订单总金额:某笔交易订单优惠前的总金额,单位为【元】注意事项service_order且不涉及金额可不传入该字段,其他场景必传pay_amountprice是否否用户应付金额 :用户最终结算时需要支付金额(不包含选择支付宝付款时,支付宝给予的优惠减免金额),单位为【元】注意事项service_order且不涉及金额可不传入该字段,其他场景必传discount_amountprice否否否商户总计优惠金额:代表商户侧给予用户的总计优惠金额 (不包含选择支付宝付款时,支付宝给予的优惠减免金额),单位为【元】。订单扩展字段开发者需通过订单扩展字段(ext_info)更新订单状态,订单业务信息,订单类型等数据,入参为 ext_key(对应参数的key)、ext_value(对应参数的value) 配合使用。参数说明如下:参数参数说明是否必填能否更新是否消息使用字段参数说明l ext_keystring是否否订单状态 key。固定为 merchant_order_status。l ext_valuestring是是否订单状态,如: refunded。l ext_keystring是否否订单类型 key。固定为 merchant_biz_type。l ext_valuestring是否否订单类型 value。本业务场景为 recharge。l ext_keystring是否是订单详情地址 key。固定为 merchant_order_link_page。l ext_valuestring是否是商家小程序对应的订单详情页路径地址 value。仅需传入小程序页面路径即可。同一笔订单的链接必须与第一次传入的地址相同,且需是小程序内部页面路径,例如:/pages/index/index?orderid=10190608609185。l ext_keystring是否否商家小程序 appid key。固定为 tiny_app_id。l ext_valuestring是否否商家小程序 appid value。传入订单归属的小程序 appid。商品信息列表开发者需通过商品信息列表字段(item_order_list)传入商品图片、商品详情页等信息。参数说明如下:参数参数说明是否必填能否更新是否消息使用字段参数说明item_namestring是否是商品名称。建议商品名称格式为:{商家名称} {商品名称} ext_infoorderextinfo是否否商品扩展参数。该参数用于传入用户购买商品图片及商家商品详情页地址等信息。l ext_keystring是否否商品图片 key。固定为 image_material_id。l ext_valuestring是否否商品图片 value。需传入 上传商品文件 获取的 material_id。已取消 (cancelled)本文详细介绍通过接口 alipay.merchant.order.sync 同步订单状态-已取消 (cancelled)时需传入的商品信息及扩展字段参数信息。接口参数 bizcontent 示例 参数说明参数参数说明是否必填能否更新是否消息使用字段参数说明out_biz_nostring是否否外部订单号。由商家自定义。注意:同一笔订单更新状态时,需与首次同步入参一致。buyer_id(buyer_open_id)string是否否支付宝用户唯一标识。新商户建议使用open_id替代该字段。对于新商户,user_id字段未来计划逐步回收,存量商户可继续使用。如使用open_id,请确认 应用-开发配置-openid配置管理 已启用。无该配置项,可查看 。order_typestring是否否订单类型。固定为 service_order(服务订单)。order_create_timestring是否否订单创建时间,即该笔订单真实的创建时间。时间格式为 yyyy-mm-dd hh:mm:ss。order_modified_timestring是是否订单修改时间,时间格式为 yyyy-mm-dd hh:mm:ss.sss。用于订单状态或数据变化较快的顺序控制,防止乱序。order_modified_time 较晚的同步会被最终存储,order_modified_time 相同的两次同步会被幂等处理。source_appstring否否否订单来源,默认 alipay(支付宝小程序)。枚举支持:dingtalk:钉钉;alipay:支付宝小程序。说明:其它来源枚举值定义可联系支付宝运营人员添加。item_order_listitemorderinfo是否否商品信息列表,详情可查看下文 商品信息列表。ext_infoorderextinfo是是否订单扩展字段。详情可查看下文 订单扩展字段。trade_nostring否否否支付宝交易号。amountprice是是否订单总金额:某笔交易订单优惠前的总金额,单位为【元】注意事项service_order且不涉及金额可不传入该字段,其他场景必传pay_amountprice选填,建议传入该参数否否用户应付金额 :用户最终结算时需要支付金额(不包含选择支付宝付款时,支付宝给予的优惠减免金额),单位为【元】注意事项service_order且不涉及金额可不传入该字段,其他场景必传discount_amountprice否否否商户总计优惠金额:代表商户侧给予用户的总计优惠金额 (不包含选择支付宝付款时,支付宝给予的优惠减免金额),单位为【元】。订单扩展字段开发者需通过订单扩展字段(ext_info)更新订单状态,订单业务信息,订单类型等数据,入参为 ext_key(对应参数的key)、ext_value(对应参数的value) 配合使用。参数说明如下:参数参数说明是否必填能否更新是否消息使用字段参数说明l ext_keystring是否否订单状态 key。固定为 merchant_order_status。l ext_valuestring是是否订单状态,如: cancelled。l ext_keystring是否否订单类型 key。固定为 merchant_biz_type。l ext_valuestring是否否订单类型 value。本业务场景为 recharge。l ext_keystring是否否订单详情地址 key。固定为 merchant_order_link_page。l ext_valuestring是否否商家小程序对应的订单详情页路径地址 value。仅需传入小程序页面路径即可。同一笔订单的链接必须与第一次传入的地址相同,且需是小程序内部页面路径,例如:/pages/index/index?orderid=10190608609185。l ext_keystring是否否商家小程序 appid key。固定为 tiny_app_id。l ext_valuestring是否否商家小程序 appid value。传入订单归属的小程序 appid。商品信息列表开发者需通过商品信息列表字段(item_order_list)传入商品图片、商品详情页等信息。参数说明如下:参数参数说明是否必填能否更新是否消息使用字段参数说明item_namestring是否否商品名称。建议商品名称格式为:{商家名称} {商品名称} ext_infoorderextinfo是否否商品扩展参数。该参数用于传入用户购买商品图片及商家商品详情页地址等信息。l ext_keystring是否否商品图片 key。固定为 image_material_id。l ext_valuestring是否否商品图片 value。需传入 上传商品文件 获取的 material_id。