字段类型

必填

字段名

说明

opType

string

是

服务单操作类型

1-创建业务单

2-业务单查询

3-关闭业务单

4-创建分期单

5-用户授权协议查询

reqTraceNum

string

是

请求流水号

该笔交易的请求流水号，每次请求时不同

vspCusid

string

否

收银宝商户号

集团模式必填

serviceId

String

是

服务id

支付宝分配的服务id

bizParam

是

业务参数

各操作类型对应的业务参数

字段

字段类型

字段长度

必填

字段名称

说明

respTraceNum

String

40

是

通联订单号

respCode

String

是

业务返回码

respMsg

String

200

是

失败原因

上传失败时返回

bizsubcode

String

否

支付宝业务错误码

透传收银宝的bizsubcode字段

bizsubmsg

String

否

支付宝业务错误原因

透传收银宝的bizsubmsg字段

vspCusid

String

15

否

收银宝商户号

bizParam

String

否

业务响应参数

字段名

字段类型

必填

参数名称

说明

对应收银宝字段名

outOrderId

String

是

商户订单号

[描述]注意：

不可使用特殊字符，如 /，=，& 等。

[示例值]Iphone14 256G

out_order_id

title

String

是

订单标题

[描述]注意：

不可使用特殊字符，如 /，=，& 等。

[示例值]Iphone14 256G

title

notifyUrl

String

否

通知地址

用于接收“业务状态变更通知”、“服务开通/信用授权通知”

无

sourceId

String

是

追踪ID

[描述]追踪ID，公域分发场景必传,

会影响主播归因、分享员归因等；

通过调用

my.checkBeforeAddOrder 接口返回

[示例值]MjAfSVNfTlVMA==

source_id

merchantBizType

String

是

订单类型

[描述]订单类型

[枚举值]

电商购物:

KX_SHOPPING

团购劵:

GROUP_SECURITIES

虚拟商品:

VIRTUAL_RECHARGE

间联实物代扣:

INDIRECT_PHYSICAL_ITEM_WITHHOLD

酒店日历房:

HOTEL_BOOKING

演出票务:

·

PERFORMANCE_TICKET

实物间联:

INDIRECT

间联充电代扣:

INDIRECT_CHARGE_WITHHOLD

标准租赁: 

STANDARD_RENT

merchant_biz_type

path

String

是

商家小程序对应的订单详情页路径地址

[描述]商家小程序对应的订单

详情页路径地址value

仅需传入小程序页面路径即可

同一笔订单的链接必须与第一

次传入的地址相同且需是小程

序内部页面路径

[示例值]

/pages/index/index?orderId=1019060

path

orderDetail

object[order_detail]（对象）

是

订单信息

[描述]订单信息

详见本接口下方字段说明：

order_detail的明细字段

order_detail

sellerId

string[1,32]

否

卖家支付

宝用户ID

[描述]卖家支付宝用户ID。

收款账号优先级规则：

门店绑定的收款账户>

请求传入的seller_id>

商户签约账号对应的支付宝用户ID；

注：

直付通和机构间联场景下seller_id

无需传入或者保持跟pid一致

如果传入的seller_id与pid不一致

需要联系支付宝小二配置收款关系

本地商品无需填写

[必选条件]当需要指定收款账号时，

通过该参数传入，如果该值为空，

则默认为商户签约账号对应的支

付宝用户ID

本地商品无需填写。

[示例值]2088401374030307

seller_id

buyerId

string[1,128]

是

买家ID

[描述]买家支付宝用户id

新商户建议使用

buyer_open_id替代该字段。

对于新商户，

buyer_id字段未来计划逐步回收

存量商户可继续使用。

如使用buyer_open_id

请确认

应用-开发配置-openid配置管理已启用

无该配置项，可查看openid配置申请。

[注意事项]交易的买家与卖家不能相同

[示例值]2088102146225135

buyer_id

buyer_open_id

buyer_logon_id

三选一传入

buyer_id

buyerOpenId

string[1,128]

是

买家支付

宝用户唯

一标识

[描述]买家支付宝用户唯一标识

详情可查看openid简介

[示例值]074a1CcTG1LelxKe4xQC0zg

buyer_open_id

buyerLogonId

string[1,128]

是

买家支付

宝登录账

号

[描述]买家支付宝登录账号。

buyer_logon_id和buyer_id两者传其一

和buyer_id不能同时为空

建议通过buyer_id来传递买家信息。

[示例值]159********

buyer_logon_id

shopInfo

object[shop_info]

(条件必传)

（对象）

是

门店信息

[描述]门店信息

详见本接口下方“数组类字段说明：

shop_info的明细字段

[必选条件]当merchant_biz_type为

HOTEL_BOOKING类型时

shop_info信息必传

shop_info

creditInfo

object[credit_info]

(条件必传)

（对象）

是

芝麻信用

信息

[描述]芝麻信息

详见本接口下方“数组类字段说明：

credit_info的明细字段

[必选条件]使用芝麻先享能力时传入

credit_info

stagePayPlans

object[stage_pay_plans]

(条件必传)

（对象）

是

阶段付款

计划

[描述]阶段付款计划

租赁场景或分期代扣场景

该字段必填

详见本接口下方“数组类字段说明：

stage_pay_plans的明细字段

[必选条件]

当传入STANDARD_RENT订单类型时

该字段必填

stage_pay_plans

contactInfo

object[contact_info]

（对象）

否

买家联系

人信息

详见本接口下方“数组类字段说明：

contact_info的明细字段

contact_info

addressInfo

object[address_info]

（对象）

否

订单收货

地址

详见本接口下方“数组类字段说明：

address_info的明细字段

address_info

promoDetaiInfo

object

[promo_detail_info]

（对象）

否

订单优惠

信息

详见本接口下方“数组类字段说明：

promo_detail_info的明细字段

promo_detai_info

extInfo

object[ext_info]

（对象）

否

订单扩展

字段

详见本接口下方“数组类字段说明：

ext_info的明细字段

ext_info

deliveryDetail

object[delivery_detail]
（对象）

否

物流信息

详见本接口下方“数组类字段说明：

delivery_detail的明细字段

delivery_detail

defaultReceivingAddress

object

[default_receiving_address]

（对象）

否

默认退货

地址

详见本接口下方“数组类字段说明：

default_receiving_address的明细字段

default_receiving_address

字段名

类型

必填

字段名称

取值

收银宝字段名

orderId

String

是

交易组件订单号

【描述】交易组件订单号。

可以把获取到的order_id作为alipay.trade.create

（统一收单交易创建接口）

extend_params.trade_component_order_id的入参进行关联。

【示例值】2015042321001004720200028594

order_id

outOrderId

string

是

外部商户订单号

【描述】外部商户订单号

【示例值】20150423001001

out_order_id

customerDisplayText

string

否

建议对客

展示文案

【描述】建议对客展示文案。

当接口返回异常时，建议将当前字段对客进行展示。

【示例值】同一时间下单人数过多，请稍后重试

customer_display_text

payInfoResponse

否

创单扩展

"pay_info_response": { "no_pay_close_time": "121212212" }

pay_info_response

字段名

类型

必填

参数名称

说明

收银宝字段名）

itemInfos

object[item_infos]（对象）

是

商品详细信息

【描述】商品详细信息

item_infos

priceInfo

object[price_info]（对象）

是

价格详细信息

【描述】价格详细信息

price_info

payInfo

object[pay_info]（对象）

否

支付信息

【描述】支付信息

pay_info

字段名

字段类型

必填

参数名称

说明

收银宝字段名

goodsName

string[1,256]

是

商品名称

【描述】商品名称

【示例值】商品名称1

goods_name

itemCnt

string[1,10]

是

商品数量

【描述】商品数量

【示例值】5

item_cnt

salePrice

string[1,11]

是

商品单价

【描述】商品单价

单位：元,精确到小数点后两位

【示例值】88.88

sale_price

goodsId

string[1,32]

是

商品的编

号

【描述】提报支付券优惠时的商品id

用于关联使用支付券

需要和支付券上绑定商品goods_id相同。

如果不使用支付券，

该字段传入商品最小粒度的商品id

如:若商品有 sku 粒度,则传商品 sku 粒度的id

【示例值】1234567

goods_id

ouItemId

string[1,64]

否

商户商品

ID

【描述】商户侧商品id

用于公域场景结算

会影响主播归因

私域场景无需传入

公域场景未传入会影响后续结算

【必选条件】公域场景使用必传

（订单前置判断接口返回的sourceId不为空）

【示例值】123

out_item_id

outSkuId

string[1,64]

否

商户商品

sku_id

【描述】商户侧商品sku_id，

用于公域场景结算，

如果商品有多个sku，

需要传入准确的sku_id，

无sku时不需要传入

【必选条件】公域场景下，

商品提报过多个out_sku_id时必传

【示例值】34567576565656

out_sku_id

saleRealPrice

string[1,11]

否

商品实际

单价

【描述】商品真实单价，

单位：元,精确到小数点后两位,

有优惠信息时需要传入,

优惠方式sale_real_price与item_discount二选一

sale_real_price使用场景：

商品有单价优惠，

传入商品实际成交单价 item_discount使用场景：

同时购买多件商品时存在优惠，

传入优惠总额 优惠计算参考：

资金平衡校验 sale_real_price使用场景：

商品有单价优惠，

传入商品实际成交单价 item_discount使用场景：

同时购买多件商品时存在优惠，

传入优惠总额 优惠计算参考：

资金平衡校验

【必选条件】sale_real_price使用场景：

商品有单价优惠，传入商品实际成交单价

【示例值】68.88

sale_real_price

itemDiscount

string[0,10]

否

商家商品

优惠金额

【描述】单位元有优惠信息时需要传入，

优惠方式sale_real_price与item_discount二选一

sale_real_price使用场景：

商品有单价优惠，

传入商品实际成交单价item_discount使用场景：

同时购买多件商品时存在优惠，

传入优惠总额优惠计算参考：

文档中资金平衡校验

【必选条件】item_discount使用场景：

同时购买多件商品时存在优惠，传入优惠总额

【示例值】1.00

item_discount

imageMaterialId

string[1,256]

否

商家商品

素材ID

【描述】商品图片，用于小程序订单中心展示，

可通过alipay.merchant.item.file.upload

接口上传素材获取素材id。

默认使用已上报的商品库素材信息。

【必选条件】已上报的商品可不传入，

未上报商品库需传入。

为空会导致订单展示异常

image_material_id

itemInstallmentInfo

object[item_installment_info]（对象）

否

商品分期

信息

【描述】商品分期信息

【必选条件】分期代扣商品必填

item_installment_info

goodsType

string[1,36]

否

商品类型

【描述】商品类型

【枚举值】

票务本地商品:TICKET

虚拟商品:VIRTUAL

【示例值】VIRTUAL

goods_type

rentInfo

object[rent_info]（对象）

否

租金信息

租金信息，租赁商品特有

rent_info

body

string[1,1000]

否

商品描述

信息

【描述】商品描述信息

【示例值】商品是法国生产

body

effectiveDates

object[effective_dates]

（对象数组）

否

价格日历

【描述】价格日历

effective_dates

ticketInfo

object[ticket_info]（对象）

否

票务信息

【描述】演出票务信息

ticket_info

activityInfo

object[activity_info]（对象）

否

活动信息

【描述】活动信息

activity_info

字段名

字段名称

必填

字段类型

说明

备注

收银宝字段名

periodNum

总分期数

是

number[1,36]

【描述】分期商品对应的总分期数

【示例值】12

period_num

periodMaxPrice

每期最大

金额

是

price[0.1,999999]

【描述】分期商品每期金额不固定时

请填入该字段，

分期时分期金额会与该字段进行比较

单位为元。

【示例值】100.00

period_max_price和

period_price二选一传入

period_max_price

periodPrice

每期金额

是

price[0.1,999999]

【描述】分期商品每期金额固定时，

请填入该字段，

分期时分期金额会与该字段进行比较

单位为元

【示例值】50.00

period_price

字段名

类型

可空

字段名称

说明

收银宝字段名

rentStartTime

date

是

租期开始时间

【描述】租期开始时间

匹配格式yyyy-MM-dd HH:mm:ss的date类型

【必选条件】在创建订单接口的情况下，

订单模型类型为STANDARD_RENT必填

【示例值】2023-11-01 12:00:00

rent_start_time

rentEndTime

date

是

租期结束时间

【描述】租期结束时间

匹配格式yyyy-MM-dd HH:mm:ss的date类型

【必选条件】在创建订单接口的情况下，

订单模型类型为STANDARD_RENT必填

【示例值】2023-11-01 12:00:00

rent_end_time

buyoutPrice

string[1,100]

是

买断价

【描述】买断价，单位元

【示例值】2000.00

buyout_price

depositPrice

string[0,100]

是

押金金额

【描述】押金金额，单位元

【示例值】100.00

deposit_price

字段名

类型

必填

字段名称

说明

收银宝字段名

date

string[0,1024]

否

价格日期

【描述】价格日期 yyyyMMdd【示例值】20211101

date

price

string[0,256]

否

商品单价

【描述】商品单价，单位元

【示例值】20.00

price

字段名

类型

必填

字段名称

说明

收银宝字段名

ticketId

string[1,32]

是

票编码ID

【描述】票编码ID，票的唯一标识

【示例值】

20240222123058189321

ticket_id

ticketType

string[1,16]

是

票类型

【描述】票类型

【枚举值】

实体票: PHYSICAL

电子票: ELECTRONIC

【示例值】ELECTRONIC

ticket_type

eventId

string[1,32]

是

场次ID

【描述】场次唯一标识

【示例值】

202402221230581892322

event_id

eventName

string[1,64]

是

场次名称

【描述】场次名称

【示例值】2024年4月18日场次

event_name

eventStartTime

date

是

场次开始

时间

【描述】场次开始时间

匹配格式yyyy-MM-dd HH:mm:ss的date类型

【示例值】2021-11-23 20:30:00

event_start_time

locationName

string[1,64]

是

演出位置

【描述】演出位置

【示例值】杭州奥体中心体育场

location_name

city

string[1,64]

是

演出城市

【描述】演出地点所属的城市

【示例值】杭州市

city

ticketLink

string[1,512]

否

票据链接

【描述】票据链接，跳转到票核销链接的地址

【示例值】

alipays://platformapi/startApp?appId=xxx&page=xxx

ticket_link

eventEndTime

data

否

结束时间

【描述】场次结束时间

匹配格式yyyy-MM-dd HH:mm:ss的date类型

【示例值】2021-11-23 22:30:00

event_end_time

performanceSeats

string[1,32]

否

演出座位

号

【描述】演出座位号

【示例值】A区3排5座

performance_seats

字段名

类型

必填

字段名称

说明

收银宝字段名

activityId

string[1,32]

是

活动ID

【描述】活动编码ID，活动的唯一标识

【示例值】

20240222123058114335

activity_id

activityName

string[1,64]

是

活动名称

【描述】活动名称

【示例值】团建轰趴套餐

activity_name

locationName

string[1,64]

是

地点

【描述】活动地点

【示例值】万达广场

location_name

city

string[1,64]

是

演出城市

【描述】活动所在的城市名

【示例值】杭州市

city

startTime

date

否

开始时间

【描述】活动开始时间

匹配格式yyyy-MM-dd HH:mm:ss的date类型

【示例值】

2021-11-23 20:30:00

start_time

endTime

date

否

结束时间

【描述】活动结束时间

匹配格式yyyy-MM-dd HH:mm:ss的date类型

【示例值】

2021/11/23 22:30

end_time

link

string[1,512]

否

活动票链

接

【描述】活动票链接

[示例值

]alipays://platformapi/startApp?appId=xxx&page=xxx

link

字段名

类型

必填

字段名称

说明

收银宝字段名

orderPrice

string[1,11]

是

订单金额

【描述】订单总价

单位：元

精确到小数点后两位

【示例值】88.88

order_price

freight

string[1,9]

否

运费

【描述】运费

单位：元

精确到小数点后两位

【示例值】100

freight

discountedPrice

string[1,11]

否

商家优惠金额

【描述】商家优惠金额

单位：元

精确到小数点后两位

【示例值】88.88

discounted_price

merchantValuePrice

price[0,999999999)

否

商家储值金额

【描述】商家侧储蓄卡金额

单位为元

精确到小数点后两位

【示例值】100.00

merchant_value_price

字段名

字段名称

说明

收银宝字段名

paymentBizType

支付渠道

【描述】订单支付渠道，空值默认为支付宝支付

【枚举值】

免费订单: FREE

【示例值】FREE

payment_biz_type

paymentMethod

支付方式

【描述】支付方式，到付等特殊场景下传入

【枚举值】

到付: COUNTER

【示例值】COUNTER

payment_method

字段名

字段名称

取值

必填

类型

收银宝字段名

name

门店名称

【描述】门店名称

【示例值】门店名称

是

string[0,1024]

name

address

门店地址

【描述】门店地址

【示例值】门店地址

是

string[0,2048]

address

merchantShopId

商家侧门店id

【描述】商家侧门店id

【示例值】1000

否

string[0,255]

merchant_shop_id

alipayShopId

蚂蚁侧门店id

【描述】蚂蚁侧门店id

【示例值】

2018011900502000000005124744

否

string[0,255]

alipay_shop_id

字段名

字段类型

必填

字段名称

说明

收银宝字段名

zmServiceId

string[1,128]

是

信用服务ID

【描述】传smid在芝麻侧生成的信用服务id

使用芝麻先享能力必传

【示例值】

2015042321001004720200028594

zm_service_id

outAgreementNo

string[1,32]

是

商户外部协议号

【描述】商户外部协议号

不同的支付宝用户需要传递不同的外部单号

使用芝麻先享能力必传

【示例值】

6823789339978248

out_agreement_no

字段名

类型

必填

字段名称

说明

收银宝字段名

stageNo

number[1,36]

是

阶段编码

【描述】阶段付款计划阶段编号

标识当前计划处于第几阶段，起始值为1

多阶段需保证阶段编号递增

【示例值】1

stage_no

stagePayPlanInfos

object[stage_pay_plan_infos]

（对象）

是

计划信息列表

【描述】阶段付款计划详情列表

stage_pay_plan_infos

字段名

类型

必填

字段名称

说明

收银宝字段名

planPayNo

number[1,36]

是

计划付款编号

【描述】阶段计划付款编号

标识第几次或第几期付款

起始值为1，多个计划需保证编号递增

【示例值】1

plan_pay_no

planPayPrice

price[0,10000000]

是

计划付款金额

【描述】阶段付款计划付款金额

单位：元，精确到小数点后两位

【示例值】100.00

plan_pay_price

planPayTime

date

是

计划付款时间

【描述】阶段付款计划付款时间

多个计划需保证付款时间递增

匹配格式yyyy-MM-dd HH:mm:ss的date类型

【示例值】2024-04-10 12:00:00

plan_pay_time

字段名

类型

可空

字段名称

说明

收银宝字段名

phoneNumber

string[1,64]

是

手机号

【描述】联系人手机号

【示例值】132********

phone_number

contactName

string[1,64]

否

联系人姓

名

【描述】联系人姓名

【示例值】张三

contact_name

encryptionContent

string(512)

是

联系人信

息加密内

容

【描述】加密内容

创单时由团购插件上传

内容为手机号加密内容

encryption_content

字段名

类型

必填

字段名称

说明

收银宝字段名

receiverName

string[1,64]

是

收货人

【描述】收货人姓名

【注意事项】仅实物类电商订单需要回传收货信

【示例值】张三

receiver_name

detailedAddress

string[1,1024]

是

收货地址

【描述】收货地址信息

【注意事项】仅实物类电商订单需要回传收货信

【示例值】中国浙江省杭州市西湖区xx小区xx号

detailed_address

telNumber

string[1,64]

是

联系方式

【描述】收货人手机号

【注意事项】仅实物类电商订单需要回传收货信

【示例值】132********

tel_number

receiverZip

string[1,64]

否

收货邮编地址

【描述】收货邮编地址

【示例值】310006

receiver_zip

receiverDivisionCode

string[1,64]

否

标准城市域码

【描述】标准城市域码

【示例值】310006

receiver_division_code

字段名

类型

必填

字段名称

取值

收银宝字段名

activityConsultId

string[1,256]

否

优惠活动咨询ID

【描述】优惠前置咨询组件返回的优惠活动咨询ID

【示例值】c2d081e6ba4e485db41cbd55244031cb

activity_consult_id

字段名

类型

必填

字段名称

说明

收银宝字段名

doorTime

date

是

预约上门

取件时间

【描述】预约上门取件的时间,格式为 yyyy-MM-dd HH:mm:ss

匹配格式yyyy-MM-dd HH:mm:ss的date类型

【示例值】2024-12-16 15:00:00

door_time

orderStr

string[1,1024]

否

芝麻租赁

授权签名

【描述】芝麻免押冻结资金签名串

调用 alipay.fund.auth.order.app.freeze生成

用于租赁场景冻结授权资金

【必选条件】使用芝麻免押的租赁业务必传

order_str

orderTradeType

string[1,16]

否

订单交易

类型

【描述】订单的交易类型用于区分担保交易或者普通JSAPI支付

创支付单会对该类型进行校验

如果参入错误，创支付单会失败

【枚举值】

担保交易: ESCROW_TRADE

【必选条件】担保交易类型该字段必填

【示例值】ESCROW_TRADE

order_trade_type

tradeNo

string[1,32]

否

交易号

【描述】支付单交易号，用于信用下单不成功转普通支付。

【必选条件】间联实物代扣场景该字段必填

【示例值】2023122801600000112348****190031

trade_no

additionRebateBasePrice

price[0,99999999]

否

订单附加

返佣金额

基数

【描述】二方接入交易组件用于返佣计算的特殊参数，单位为元

【示例值】100.00

addition_rebate_base_price

deductSignScene

string[1,128]

否

代扣协议

签约场景

【描述】代扣协议签约场景值

商户可根据代扣产品常见场景值选择符合自身的行业场景

必须和合约中配置的一致。

【示例值】INDUSTRY|CARRENTAL

deduct_sign_scene

creditCode

string[1,18]

否

企业的统一社会信用代码

【描述】企业的统一社会信用代码，营业执照上有该信息，企业租赁业务需要传递该参数

credit_code

alipayAccount

string[1,128]

否

企业支付宝账号

【描述】商家登录支付宝的邮箱账号或手机号，企业租赁业务传递该参数。

alipay_account

字段名

类型

必填

字段名称

说明

收银宝字段名

deliveryType

string[1,64]

否

物流类型

【描述】物流类型

【枚举值】

平邮: POST

快递: EXPRESS

虚拟物品: VIRTUAL

EMS: EMS

自提: SELFPICK

【示例值】VIRTUAL

delivery_type

deliveryTime

date

否

配送时间

【描述】配送时间,格式为 yyyy-MM-dd HH:mm:ss

匹配格式yyyy-MM-dd HH:mm:ss的date类型

【示例值】2023-06-01 23:23:22 

delivery_time

字段名

类型

必填

字段名称

说明

收银宝字段名

receiverName

string[1,64]

是

收货人

【描述】收货人姓名

【注意事项】仅实物类电商订单需要回传收货信

【示例值】张三

receiver_name

detailedAddress

string[1,1024]

是

收货地址

【描述】收货地址信息

【注意事项】仅实物类电商订单需要回传收货信

【示例值】中国浙江省杭州市西湖区xx小区xx号

detailed_address

telNumber

string[1,64]

是

联系方式

【描述】收货人手机号

【注意事项】仅实物类电商订单需要回传收货信

【示例值】132********

tel_number

receiverZip

string[1,64]

否

收货邮编地址

【描述】收货邮编地址

【示例值】310006

receiver_zip

receiverDivisionCode

string[1,64]

否

标准城市域码

【描述】标准城市域码

【示例值】310006

receiver_division_code

字段名

类型

必填

参数名称

说明

收银宝字段名

outOrderId

String(32)

是

商户订单号

由商家自定义

64个字符以内

仅支持字母、数字、下划线且需保证在商户端不重复

out_order_id和order_id必填其一

建议优先使用order_id

out_order_id

orderId

String(128)

是

交易组件订单号

【描述】交易组件订单号；

order_id和out_order_id二选一

【示例值】2015042321001004720200028594

order_id

userId

String(32)

是

买家支付宝用户

user_id和open_id两者必填其一

user_id

openId

String(128)

是

支付宝用户open_id

open_id

字段名

类型

必填

字段名称

说明

收银宝字段名

orderId

String(128)

是

交易组件

订单号

【描述】平台订单号

【示例值】202305100150230000000152

order_id

createTime

string(64)

是

创建时间

【描述】创建时间，yyyy-MM-dd HH:mm:ss

【示例值】2023-03-23 12:00:00

create_time

outOrderId

string(32)

是

商家自定

义订单号

【描述】商家自定义订单ID

(字符仅支持下划线字母数字，长度小于128个字符）

【示例值】tqshajkk1163937ZZ

out_order_id

contactInfo

object[contactInfo]

（对象）

是

联系人信

息

【描述】买家联系人信息

本地生活商品使用

详见本接口下方数组类字段说明：

contact_info的明细字段

contact_info

stagePayPlans

object[stagePayPlans]

（对象）

是

阶段付款

计划

【描述】阶段付款计划列表

详见本接口下方数组类字段说明：

stage_pay_plans的明细字段

stage_pay_plans

userId

string(32)

是

蚂蚁统一

会员ID

user_id

openId

string(128)

是

用户

openId

open_id

tradeNo

string(64)

否

支付单号

【描述】支付单号，支付成功后会该字段会有值

【示例值】202304121231490902

trade_no

orderDetail

object[orderDetail]

（对象）

否

订单详细

数据

【描述】订单详细数据

详见本接口下方

数组类字段说明：

order_detail的明细字段”

order_detail

status

string(64)

是

订单状态

【描述】订单状态

【枚举值】

订单创建: TRADE_CREATED

等待支付: WAIT_PAY

超时取消: TIMEOUT_CLOSED

支付成功: PAID

部分发货: PARTIAL_DELIVERED

全部发货: DELIVERED

确认收货: RECEIVED_CONFIRM

全部退款: REFUND_CLOSED

CONFIRMED: 已确认

CANCELLED: 预约失败

TO_BE_CHK_IN: 待入住

CHECK_IN: 已EC入住

HAVE_STAY: 已续住

TO_CHECK_OUT: 待退房

CHECK_OUT: 已退房

FINISHED: 已完结

GIVE_BACK: 已归还

MERCHANT_CONFIRMED: 商户已确认

status

deliveryDetail

object[deliveryDetail]

（对象）

否

配送信息

【描述】配送信息

详见本接口下方

数组类字段说明：

delivery_detail的明细字段

delivery_detail

path

string(128)

否

订单详情

页路径

【描述】商家小程序对应的订单详情页路径地址

【示例值】/pages/index/index?orderId=10190608609185

path

refundInfo

object[refundInfo]

（对象）

否

退款信息

【描述】退款信息

详见本接口下方

数组类字段说明：

refund_info的明细字段

refund_info

defaultReceivingAddress

object[defaultReceivingAddress]

否

默认退货

地址

【描述】默认退货地址

详见本接口下方

数组类字段说明：

default_receiving_address的明细字段

default_receiving_address

addressInfo

object[addressInfo]

（对象）

否

收货地址

【描述】收货地址

详见本接口下方

数组类字段说明：

address_info的明细字段

address_info

merchantBizType

string(64)

否

订单类型

【枚举值】

电商购物: KX_SHOPPING

团购劵: GROUP_SECURITIES

虚拟商品: VIRTUAL_RECHARGE

merchant_biz_type

receiveTime

string(64)

否

确认收货

时间

【描述】确认收货时间

【示例值】2023-04-20 12:37:04

receive_time

settleType

string(64)

否

账期标识

【描述】结算方式

【枚举值】

即时到账: normal

账期结算: extended

【示例值】normal

settle_type

bookingInfo

object[bookingInfo]

（对象数组）

否

酒店预订

信息

【描述】酒店预订信息

详见本接口下方

数组类字段说明：

booking_info的明细字段

booking_info

shopInfo

object[shopInfo]

（）

否

门店信息

【描述】门店信息

详见本接口下方

数组类字段说明：

shop_info的明细字段

shop_info

字段名

类型

必填

字段名称

说明

收银宝字段名

phoneNumber

string[1,64]

否

手机号

【描述】联系人手机号

【示例值】132********

phone_number

contactName

string[1,64]

是

联系人姓名

【描述】联系人姓名

【示例值】张三

contact_name

encryptionContent

string(512)

否

联系人信息加密内容

【描述】加密内容

创单时由团购插件上传

内容为手机号加密内容

encryption_content

字段名

类型

必填

字段名称

说明

收银宝字段名

stageNo

number[1,36]

是

阶段编码

【描述】阶段付款计划阶段编号

标识当前计划处于第几阶段

起始值为1

多阶段需保证阶段编号递增

【示例值】1

stage_no

stagePayPlanInfos

object[stagePayPlanInfos]（对象）

是

计划信息列表

【描述】阶段付款计划详情列表

stage_pay_plan_infos

字段名

类型

必填

字段名称

说明

收银宝字段名

planPayNo

number[1,36]

是

计划付款编号

【描述】阶段计划付款编号

标识第几次或第几期付款

起始值为1

多个计划需保证编号递增

【示例值】1

plan_pay_no

planPayPrice

price[0,10000000]

是

计划付款金额

【描述】阶段付款计划付款金额

单位：元

精确到小数点后两位

【示例值】100.00

plan_pay_price

planPayTime

date

是

计划付款时间

【描述】阶段付款计划付款时间

多个计划需保证付款时间递增

匹配格式yyyy-MM-dd HH:mm:ss的date类型

【示例值】2024-04-10 12:00:00

plan_pay_time

字段名

类型

必填

参数名称

说明

收银宝字段名

itemInfos

array[object]（对象）

是

商品详细信息

【描述】商品详细信息

item_infos

priceInfo

object[priceInfo]（对象）

是

价格详细信息

【描述】价格详细信息

price_info

payInfo

object[payInfo]（对象）

否

支付信息

【描述】支付信息

pay_info

promoApplyInfo

object[promoApplyInfo]（对象）

否

优惠申领信息

promo_apply_info

字段名

类型

必填

参数名称

说明

收银宝字段名

goodsName

string[1,256]

是

商品名称

【描述】商品名称

【示例值】商品名称1

goods_name

itemCnt

string[1,10]

是

商品数量

【描述】商品数量

【示例值】5

item_cnt

salePrice

string[1,11]

是

商品单价

【描述】商品单价

单位：元,

精确到小数点后两位

【示例值】88.88

sale_price

goodsId

string[1,32]

是

商品的编

号

【描述】提报支付券优惠时的商品id

用于关联使用支付券

需要和支付券上绑定商品goods_id相同

如果不使用支付券

该字段传入商品最小粒度的商品id

如:若商品有 sku 粒度，则传商品 sku 粒度的id

【示例值】1234567

goods_id

outItemId

string[1,64]

否

商户商品

ID

【描述】商户侧商品id

用于公域场景结算

会影响主播归因。

私域场景无需传入

公域场景未传入会影响后续结算

【必选条件】公域场景使用必传

订单前置判断接口返回的sourceId不为空

【示例值】123

out_item_id

outSkuId

string[1,64]

否

商户商品

sku_id

【描述】商户侧商品sku_id

用于公域场景结算

如果商品有多个sku

需要传入准确的sku_id

无sku时不需要传入

【必选条件】

公域场景下

商品提报过多个out_sku_id时必传

【示例值】34567576565656

out_sku_id

saleRealPrice

string[1,11]

否

商品实际

单价

【描述】商品真实单价

单位：元

精确到小数点后两位,

有优惠信息时需要传入

优惠方式sale_real_price与item_discount二选一

sale_real_price使用场景：商品有单价优惠

传入商品实际成交单价 item_discount

使用场景：

同时购买多件商品时存在优惠

传入优惠总额

优惠计算参考：

资金平衡校验 sale_real_price

使用场景：

商品有单价优惠

传入商品实际成交单价 item_discount

使用场景：

同时购买多件商品时存在优惠

传入优惠总额

优惠计算参考：

资金平衡校验

【必选条件】sale_real_price使用场景：

商品有单价优惠，传入商品实际成交单价

【示例值】68.88

sale_real_price

itemDiscount

string[0,10]

否

商家商品

优惠金额

【描述】单位元有优惠信息时需要传入

优惠方式sale_real_price与item_discount二选一

sale_real_price使用场景：

商品有单价优惠

传入商品实际成交单价

item_discount使用场景：

同时购买多件商品时存在优惠

传入优惠总额优惠

计算参考：文档中资金平衡校验

【必选条件】item_discount使用场景：

同时购买多件商品时存在优惠

传入优惠总额

【示例值】1.00

item_discount

imageMaterialId

string[1,256]

否

商家商品

素材ID

【描述】商品图片

用于小程序订单中心展示

可通过 alipay.merchant.item.file.upload 

接口上传素材获取素材id

默认使用已上报的商品库素材信息

【必选条件】已上报的商品可不传入

未上报商品库需传入

为空会导致订单展示异常

【示例值】201901010050220000000000

image_material_id

itemInstallmentInfo

object[itemInstallmentInfo]（对象）

否

商品分期

信息

【描述】商品分期信息

【必选条件】分期代扣商品必填

item_installment_info

goodsType

string[1,36]

否

商品类型

【描述】商品类型

【枚举值】

票务本地商品: TICKET

虚拟商品: VIRTUAL

【示例值】VIRTUAL

goods_type

rentInfo

object[rentInfo]（对象）

否

租金信息

租金信息，租赁商品特有

rent_info

body

string[1,1000]

否

商品描述

信息

【描述】商品描述信息

【示例值】商品是法国生产

body

effectiveDates

object[effectiveDates]（对象数组）

否

价格日历

【描述】价格日历

effective_dates

ticketInfo

object[ticketInfo]（对象）

否

票务信息

【描述】演出票务信息

ticket_info

activityInfo

object[activityInfo]（对象）

否

活动信息

【描述】活动信息

activity_info

字段名

类型

字段名称

必填

说明

备注

收银宝字段名

periodNum

number[1,36]

总分期数

是

【描述】分期商品对应的总分期数

【示例值】12

period_num

periodMaxPrice

price[0.1,999999]

每期最大

金额

是

【描述】分期商品每期金额不固定时

请填入该字段

分期时分期金额会与该字段进行比较

单位为元

【示例值】100.00

period_max_price

period_price

二选一传入

period_max_price

periodPrice

price[0.1,999999]

每期金额

是

【描述】分期商品每期金额固定时

请填入该字段

分期时分期金额会与该字段进行比较

单位为元

【示例值】50.00

period_price

periodNum

number[1,36]

总分期数

是

【描述】分期商品对应的总分期数

【示例值】12

period_num

periodMaxPrice

price[0.1,999999]

每期最大

金额

是

【描述】分期商品每期金额不固定时

请填入该字段

分期时分期金额会与该字段进行比较

单位为元

【示例值】100.00

period_max_price

periodPrice

price[0.1,999999]

每期金额

是

【描述】分期商品每期金额固定时

请填入该字段

分期时分期金额会与该字段进行比较

单位为元

【示例值】50.00

period_price

字段名

类型

必填

字段名称

说明

收银宝字段名

rentStartTime

date

否

租期开始时间

【描述】租期开始时间

匹配格式yyyy-MM-dd HH:mm:ss的date类型

【必选条件】在创建订单接口的情况下

订单模型类型为STANDARD_RENT必填

【示例值】2023-11-01 12:00:00

rent_start_time

rentEndTime

date

否

租期结束时间

【描述】租期结束时间

匹配格式yyyy-MM-dd HH:mm:ss的date类型

【必选条件】在创建订单接口的情况下

订单模型类型为STANDARD_RENT必填

【示例值】2023-11-01 12:00:00

rent_end_time

buyoutPrice

string[1,100]

否

买断价

【描述】买断价，单位元

【示例值】2000.00

buyout_price

depositPrice

string[0,100]

否

押金金额

【描述】押金金额，单位元

【示例值】100.00

deposit_price

字段名

类型

必填

字段名称

说明

云商通对外字段名

date

string[0,1024]

否

价格日期

【描述】价格日期 yyyyMMdd

【示例值】20211101

date

price

string[0,256]

否

商品单价

【描述】商品单价，单位元

【示例值】20.00

price

字段名

类型

必填

字段名称

说明

收银宝字段名

ticketId

string[1,32]

是

票编码ID

【描述】票编码ID，票的唯一标识

【示例值】

20240222123058189321

ticket_id

ticketType

string[1,16]

是

票类型

【描述】票类型

【枚举值】

实体票: PHYSICAL

电子票: ELECTRONIC

【示例值】ELECTRONIC

ticket_type

eventId

string[1,32]

否

场次ID

【描述】场次唯一标识

【示例值】

202402221230581892322

event_id

eventName

string[1,64]

否

场次名称

【描述】场次名称

【示例值】2024年4月18日场次

event_name

eventStartTime

date

否

场次开始时间

【描述】场次开始时间

匹配格式yyyy-MM-dd HH:mm:ss的date类型

【示例值】2021-11-23 20:30:00

event_start_time

locationName

string[1,64]

否

演出位置

【描述】演出位置

【示例值】杭州奥体中心体育场

location_name

city

string[1,64]

否

演出城市

【描述】演出地点所属的城市

【示例值】杭州市

city

ticket_link

string[1,512]

是

票据链接

【描述】票据链接

跳转到票核销链接的地址

alipays://plapp?appId=xxx&page=xxx

ticket_link

event_end_time

data

是

结束时间

【描述】场次结束时间

匹配格式yyyy-MM-dd HH:mm:ss的date类型

【示例值】2021-11-23 22:30:00

event_end_time

performance_seats

string[1,32]

是

演出座位号

【描述】演出座位号

【示例值】A区3排5座

performance_seats

字段名

类型

必填

字段名称

说明

收银宝字段名

activityId

string[1,32]

是

活动ID

【描述】活动编码ID，活动的唯一标识

【示例值】

20240222123058114335

activity_id

activityName

string[1,64]

是

活动名称

【描述】活动名称

【示例值】团建轰趴套餐

activity_name

locationName

string[1,64]

是

地点

【描述】活动地点

【示例值】万达广场

location_name

city

string[1,64]

是

演出城市

【描述】活动所在的城市名

【示例值】杭州市

city

startTime

date

否

开始时间

【描述】活动开始时间

匹配格式yyyy-MM-dd HH:mm:ss的date类型

【示例值】

2021/11/23 20:30

start_time

endTime

date

否

结束时间

【描述】活动结束时间

匹配格式yyyy-MM-dd HH:mm:ss的date类型

【示例值】

2021/11/23 22:30

end_time

link

string[1,512]

否

活动票链接

【描述】活动票链接

【示例值】

alipays://plapp?appId=xxx&page=xxx

link

字段名

类型

必填

字段名称

说明

收银宝字段名

orderPrice

string[1,11]

是

订单金额

【描述】订单总价

单位：元,精确到小数点后两位

【示例值】88.88

order_price

freight

string[1,9]

否

运费

【描述】运费

单位：元

精确到小数点后两位

【示例值】100

freight

discountedPrice

string[1,11]

否

商家优惠金额

【描述】商家优惠金额

单位：元

精确到小数点后两位

【示例值】88.88

discounted_price

merchantValuePrice

price[0,999999999)

否

商家储值金额

【描述】商家侧储蓄卡金额

单位为元

精确到小数点后两位

【示例值】100.00

merchant_value_price

字段名

类型

必填

字段名称

说明

收银宝字段名

paymentBizType

string[1,64]

否

支付渠道

【描述】订单支付渠道

空值默认为支付宝支付

【枚举值】

免费订单: FREE

【示例值】FREE

payment_biz_type

paymentMethod

string[1,64]

否

支付方式

【描述】支付方式

到付等特殊场景下传入

【枚举值】

到付: COUNTER

【示例值】COUNTER

payment_method

字段名

类型

必填

字段名称

说明

收银宝字段名

promoApplySummaryInfos

object[promoApplySummaryInfos]（对象）

否

营销申领汇总

promo_apply_summary_infos

promoApplyItemInfos

object[promoApplyItemInfos]（对象）

否

营销申领商品明细

【描述】支付方式

到付等特殊场景下传入

【枚举值】

到付: COUNTER

【示例值】COUNTER

promo_apply_item_infos

字段名

类型

必填

字段名称

说明

收银宝字段名

promotionType

string(128)

否

优惠类型

【描述】营销优惠类型

【枚举值】

商品券: EXTERNAL_MERCHANT_VOUCHER

支付券/平台优惠券/红包: PROMO_VOUCHER

专享价: DISCOUNT

支付宝会员: ANT_MEMBER

消费金: CONSUME_GOLD

promotion_type

promotionSubType

string(128)

否

优惠子类型

【描述】营销优惠子类型

【枚举值】

会员积分: MEMBER_POINTS

等级价: LEVEL_PRICE

promotion_sub_type

applyAmount

string(64)

否

优惠申领数量

【描述】优惠申领金额或者数量

金额时单位：分

需要根据budget_type字段区分金额和数量

【示例值】1000

apply_amount

budgetType

string(64)

否

预算类型

【描述】优惠申领的预算类型

【枚举值】

数量预算: COUNT

金额预算: MONEY

【示例值】COUNT

budget_type

memberLevel

string(16)

否

会员等级

【枚举值】

大众会员: primary

黄金会员: golden

铂金会员: platinum

钻石会员: diamond

【示例值】primary

member_level

subPromoInfos

object[sub_promo_infos]

（对象）

否

子营销申领明细

【描述】子营销申领明细

包含子营销申领消耗的名称和数量

sub_promo_infos

字段名

字段名称

类型

必填

说明

收银宝字段名

subTypeName

消耗的子代币类型名称

string(128)

否

【描述】订单消耗的子代币类型名称

【示例值】爱国福

sub_type_name

costCount

消耗的子代币数量

string(16)

否

【描述】订单消耗的子代币数量

【示例值】2

cost_count

字段名

类型

必填

字段名称

说明

收银宝字段名

itemId

string(64)

否

支付宝平台侧商品ID

【描述】支付宝平台侧商品ID

【示例值】12200000

item_id

skuId

string(64)

否

支付宝侧商品skuid

【描述】支付宝侧商品skuid

【示例值】123412

sku_id

promoApplyItemDetailInfos

object[promo_apply_item_detail_infos]

（对象）

否

商品申领明细

promo_apply_item_detail_infos

字段名

类型

必填

字段名称

取值

收银宝字段名

promotionType

string(128)

否

优惠类型

【描述】营销优惠类型

【枚举值】

商品券: EXTERNAL_MERCHANT_VOUCHER

支付券、平台优惠券、红包: PROMO_VOUCHER

专享价: DISCOUNT

支付宝会员: ANT_MEMBER

消费金: CONSUME_GOLD

【示例值】DISCOUNT

promotion_type

promotionSubType

string(128)

否

优惠子类型

【描述】营销优惠子类型

【枚举值】

会员积分: MEMBER_POINTS

等级价: LEVEL_PRICE

【示例值】MEMBER_POINTS

promotion_sub_type

applyAmount

string(64)

否

优惠申领数量

【描述】优惠申领金额或者数量

金额时单位：分

需要根据budget_type字段区分金额和数量

【示例值】1000

apply_amount

budgetType

string(64)

否

预算类型

【描述】优惠申领的预算类型

【枚举值】

数量预算: COUNT

金额预算: MONEY

【示例值】COUNT

budget_type

memberLevel

string(16)

否

会员等级

【枚举值】

大众会员: primary

黄金会员: golden

铂金会员: platinum

钻石会员: diamond

member_level

subPromoInfos

object[sub_promo_infos]

（对象）

是

子营销申领明细

【描述】子营销申领明细

包含子营销申领消耗的名称和数量

sub_promo_infos

promotionType

string(128)

否

优惠类型

【描述】营销优惠类型

【枚举值】

商品券: EXTERNAL_MERCHANT_VOUCHER

支付券、平台优惠券、红包: PROMO_VOUCHER

专享价: DISCOUNT

支付宝会员: ANT_MEMBER

消费金: CONSUME_GOLD

【示例值】DISCOUNT

promotion_type

promotionSubType

string(128)

否

优惠子类型

【描述】营销优惠子类型

【枚举值】

会员积分: MEMBER_POINTS

等级价: LEVEL_PRICE

【示例值】MEMBER_POINTS

promotion_sub_type

applyAmount

string(64)

否

优惠申领数量

【描述】优惠申领金额或者数量

金额时单位：分

需要根据budget_type字段区分金额和数量

apply_amount

budgetType

string(64)

否

预算类型

【描述】优惠申领的预算类型

【枚举值】

数量预算: COUNT

金额预算: MONEY

【示例值】COUNT

budget_type

memberLevel

string(16)

否

会员等级

【枚举值】

大众会员: primary

黄金会员: golden

铂金会员: platinum

钻石会员: diamond

member_level

subPromoInfos

object[sub_promo_infos]

（对象）

是

子营销申领明细

【描述】子营销申领明细

包含子营销申领消耗的名称和数量

sub_promo_infos

字段名

类型

必填

字段名称

说明

收银宝字段名

finishAllDelivery

string(64)

否

发货完成标志位

【描述】发货完成标志位

false:未发完 

true:已发完

【枚举值】

未发完: false

已发完: true

【示例值】true

finish_all_delivery

deliveryList

object[delivery_list]

（对象数组）

否

物流信息

delivery_list

字段名

类型

必填

字段名称

说明

收银宝字段名

deliveryId

string(64)

否

快递公司ID

【描述】快递公司ID

delivery_id

waybillId

string(32)

否

快递单号

waybill_id

itemInfoList

object[item_info_list]

（对象数组）

否

商品信息

item_info_list

字段名

类型

必填

字段名称

收银宝字段名

outItemId

string(64)

否

商户商品ID

out_item_id

outSkuId

string(64)

否

商户商品sku_id

out_sku_id

字段名

类型

必填

字段名称

收银宝字段名

refundList

object[refund_list]
（对象数组）

否

退款记录

refund_list

字段名

类型

必填

字段名称

说明

收银宝字段名

status

string(64)

是

退款记录状态

【描述】退款记录状态

【枚举值】

退款成功: SUCCESS

退款中: PROCESS

退款失败: FAIL

status

amount

string(64)

否

退款金额

【描述】退款金额

单位：元

精确到小数点后两位

【示例值】10.0

amount

refundId

string(64)

否

支付系统退款单号

【描述】支付系统退款单号

【示例值】1214412

refund_id

outRefunId

string(128)

否

外部退款流水号

【描述】外部退款流水号

【示例值】202303250019936

out_refund_id

字段名

类型

必填

字段名称

说明

收银宝字段名

receiverName

string[1,64]

是

收货人

【描述】收货人姓名

【注意事项】仅实物类电商订单需要回传收货信

【示例值】张三

receiver_name

detailedAddress

string[1,1024]

是

收货地址

【描述】收货地址信息

【注意事项】仅实物类电商订单需要回传收货信

【示例值】中国浙江省杭州市西湖区xx小区xx号

detailed_address

telNumber

string[1,64]

是

联系方式

【描述】收货人手机号

【注意事项】仅实物类电商订单需要回传收货信

【示例值】132********

tel_number

receiverZip

string[1,64]

否

收货邮编地址

【描述】收货邮编地址

【示例值】310006

receiver_zip

receiverDivisionCode

string[1,64]

否

标准城市域码

【描述】标准城市域码

【示例值】310006

receiver_division_code

字段名

必填

类型

字段名称

说明

收银宝字段名

receiverName

是

string(64)

收件人

【描述】收件人姓名

【注意事项】仅实物类电商订单需要回传收货信

【示例值】张三

receiver_name

detailedAddress

是

string(1024)

收货地址

【描述】详细收货地址信息

【注意事项】仅实物类电商订单需要回传收货信

【示例值】中国浙江省杭州市西湖区xx小区xx号

detailed_address

telNumber

是

string(64)

联系方式

【描述】收件人手机号码

【注意事项】仅实物类电商订单需要回传收货信

【示例值】137***23

tel_number

字段名

字段名称

类型

必填

说明

收银宝字段名

confirmBookingTime

确认预约时间

string(64)

否

【描述】商户确认买家的预约

【必选条件】商户确认买家的预约

已确认 状态下必选；

【示例值】2023-01-11 11:00:00

confirm_booking_time

checkInDate

入住日期

string(64)

否

【描述】入住日期

【必选条件】

已入住、已续住、待退房、已退房状态下必选

【示例值】2023-01-11

check_in_date

checkInTime

入住时间

string(64)

否

【描述】入住时间

【必选条件】

已入住、已续住、待退房、已退房状态下必选

【示例值】2013-12-24 11:43:23

check_in_time

checkOutDate

离店日期

string(64)

否

【必选条件】

已入住、已续住、待退房、已退房状态下必选

check_out_date

checkOutTime

离店时间

string(64)

否

【必选条件】

已入住、已续住、待退房、已退房状态下必选

check_out_time

bookingTime

预约入住时间

string(64)

否

【描述】预约入住时间

【必选条件】

订单创建、已确认、待入住 状态下必传

【示例值】2013-12-24 11:43:23

booking_time

haveStayTime

续住时间

string(64)

否

【描述】商户为买家办理续住的时间

【必选条件】

已续住 状态下必选

【示例值】2013-12-24 11:43:23

have_stay_time

roomNum

房间号

string(64)

否

【描述】入住酒店房间号

【必选条件】

酒店日历房商品 已入住、待退房、已续住、已退房状态下必选

【示例值】204

room_num

deadline

最晚到店时间

string(64)

否

【描述】最晚到店时间

【示例值】2013-12-24 11:43:23

deadline

customerServiceMobile

客服电话

string(64)

否

【描述】客服电话

包含区号+电话号码的座机号码格式，以及手机号码格式

【示例值】0571-88888888

customer_service_mobile

refundRule

退改规则

string(2048)

否

【描述】退改规则

【示例值】阶梯退：入住前x天的x点

收取手续费：0%、30%、10%、100%

refund_rule

字段名

类型

必填

字段名称

说明

收银宝字段名

name

string[0,1024]

是

门店名称

描述】门店名称

【示例值】门店名称

name

address

string[0,2048]

是

门店地址

【描述】门店地址

【示例值】门店地址

address

merchantShopId

string[0,255]

否

商家侧门店id

【描述】商家侧门店id

【示例值】1000

merchant_shop_id

alipayShopId

string[0,255]

否

蚂蚁侧门店id

【描述】蚂蚁侧门店id

【示例值】

2232320180127

alipay_shop_id

字段名

类型

必填

参数名称

说明

收银宝字段名

outOrderId

String(32)

是

商户订单号

由商家自定义，64个字符以内，

仅支持字母、数字、下划线且需保证在商户端不重复

out_order_id和order_id必填其一

建议优先使用order_id

out_order_id

orderId

String(128)

是

交易组件订单号

【描述】交易组件订单号；

order_id和out_order_id二选一

【示例值】20150423210010047202000285

order_id

userId

String(32)

是

买家支付宝用户

user_id和open_id两者必填其一

user_id

openId

String(128)

是

支付宝用户open_id

open_id

错误码

错误描述

解决方案

INVALID_PARAMETER

参数有误

请根据接口返回的参数非法的具体错误信息，修改参数后进行重试

CLOSE_ORDER_IS_ERROR

订单关闭异常

订单关闭异常，请确认参数是否正确

CLOSE_ORDER_IS_REPEAT

重复关单

重复关单，请不要重复关单

MERCHANT_ID_IS_NULL

商户ID为空

请填写正确的商户ID

ORDER_AND_OUT_ORDER_NULL

订单号或者外部订单号为空

请填写正确的订单号

ORDER_ID_IS_NULL

订单号为空

请填写正确的订单号

ORDER_ID_NOT_EXIST

订单号不存在

请填写正确的订单号

ORDER_USER_ID_INVALIDATE

订单用户ID不匹配

请传入正确的user_id

OUT_ORDER_ID_IS_NULL

外部订单号为空

请填写正确的外部订单号

PARAM_IS_NULL

参数为空

请填写正确的参数

PARSE_JSON_ERROR

参数JSON解析失败

请传入正常参数

USER_ID_IS_NULL

用户信息为空

请填写正确的用户ID

字段名

类型

必填

参数名称

说明

备注

收银宝字段名

outInstallmentOrderId

string

是

外部分期

单号

【描述】分期单外部请求号

由商家自定义，64个字符以内

仅支持字母、数字、下划线且需保证在商户端不重复

其他请求参数不变时重复请求会幂等返回分期单号

out_installment_order_id

type

string

是

分期类型

【描述】分期类型

【枚举值】

租金: RENT

买断: BUYOUT

续租: RELET

代扣: WITHHOLD

运费: FREIGHT

保险费: INSURANCE

违约金: LATE_FEE

赔付金: INDEMNITY

追加扣款: ADDITION

【注意事项】

创建订单如果传入阶段付款计划

改类型不允许传入RELET

如果是租金类型请传入RENT

【示例值】WITHHOLD

type

orderId

string

是

交易组件

订单号

【描述】交易组件订单号

order_id

outOrderId

string

是

外部商户

订单号

【描述】外部商户订单号

out_order_id

userId

string

是

买家ID

【描述】2088开头的16位纯数字

user_id

open_id

两者任选其一传入

必传

user_id

openId

string

支付宝用

户唯一标

识

【描述】支付宝用户唯一标识

open_id

installmentPrice

Long

否

分期金额

【描述】当分期类型为RENT

期数为1时，分期金额=首期金额

期数非1时，分期金额=每期金额

如果有尾期金额，最后一期分期金额=尾期金额

当分期类型为BUYOUT

分期金额=买断价 buyout_price

当分期类型为RELET

分期金额即续租金额

【必选条件】

当交易组件订单类型为STANDARD_RENT时必传

【示例值】10.00

installment_price

installmentNoType

string

否

分期号类

型

【描述】分期数类型

【枚举值】

期数: PERIOD

【必选条件】

当传入installment_no字段时，该字段必填

【示例值】PERIOD

installment_no_type

installmentNo

string

否

本次分期

号

【描述】当前分期数

【必选条件】

当分期单类型type=RENT或type=WITHHOLD时

该字段必填

【示例值】1

installment_no

tradeNo

string

否

交易号

【描述】支付宝收单交易号

trade_no

isFinishPerformance

boolean

否

分期是否

完结

【描述】分期是否已经完结

false:未完结

true:已完结

is_finish_performance

payChannel

string

否

分期单支付

渠道

【描述】用户分期扣款的支付方式

【枚举值】

支付宝支付: ALIPAY

微信支付: WECHAT

其他: OTHER

pay_channel

stageNo

number

否

分期阶段

编码

【描述】分期的阶段编码

与创建时的阶段付款计划里的阶段编码对应

【示例值】1

stage_no

isSyncPay

boolean

否

是否同步

主动支付

【描述】分期单同步模式请传入true

该模式会直接推进分期单进入结算阶段

【示例值】true

is_sync_pay

字段名

类型

必填

参数名称

说明

收银宝字段名

installmentorderid

string(34)

否

分期单号

在代扣等场景下使用

installment_order_id

错误码

错误描述

解决方案

SYSTEM_ERROR

系统繁忙

服务器异常 可能发生了网络或者系统异常，导致服务调用失败，商户可以用同样的请求发起重试

INVALID_PARAMETER

参数有误

请根据接口返回的参数非法的具体错误信息，修改参数后进行重试

ADDON_PERIOD_NUM_INVALID

续租期数参数无效

续期租期范围1-12，请填写正确的续租总期数

ADDON_PERIOD_NUM_IS_NULL

续租期数参数为空

续租场景，请填写正确的续租总期数

INSTALLMENT_FINISH_INVALID

分期是否完成传参错误

请传入正确的分期是否完成

INSTALLMENT_PERIOD_NUM_INVALID

期数无效

请传入正确的期数

INSTALLMENT_PERIOD_NUM_IS_NULL

期数为空

请传入正确的期数

INSTALLMENT_TYPE_INVALID

分期类型不正确

请传入正确的分期类型

MRCH_ORDER_ERROR

订单处理错误

创建订单分期

ORDER_AND_OUT_ORDER_NULL

外部订单号与交易组件订单号二者选一

外部订单号与交易组件订单号二者选一

ORDER_ID_NOT_EXIST

订单不存在

请传入正确的订单号

ORDER_MERCHANT_MISMATCH

商家订单不匹配

当前订单对应的商家ID与小程序不匹配，请传入正确的订单号

ORDER_USER_ID_INVALIDATE

订单UID不匹配

请传入正确的用户ID

OUT_ORDER_ID_INVALIDATE

商户订单号无效

请确认传入的商家订单号是否正确

PARAMS_VALID_ERROR

参数非法

参数非法

PARAM_IS_NULL

参数为空

请传入正确的参数

PAY_CHANNEL_TYPE_INVALID

支付渠道类型非法

支付渠道类型非法，请传入正确的支付渠道类型

PAY_CHANNEL_TYPE_IS_NULL

支付渠道为空

支付渠道为空，请传入支付渠道

RENT_ITEM_QUANTITY_INVALID

租赁商品数量非法

租赁商品数量非法

STATUS_INVALID

订单状态不正确

该订单不支持分期

TRADE_NO_IS_NULL

交易号为空

交易号为空，请传入交易号

USER_ID_IS_NULL

用户ID不能为空

请传入正确的用户

字段名

类型

必填

参数名称

取值

备注

收银宝字段名

outAgreementNo

string(32)

是

商户外部协议号

【描述】商户外部协议号

out_agreement_no

credit_agreement_id

必填一个

推荐使用credit_agreement_id

out_agreement_no

creditAgreementId

string(128)

是

开通/授权协议号

【描述】芝麻开通/授权协议号

credit_agreement_id

字段名

类型

必填

参数名称

说明

备注

收银宝字段名

agreementStatus

string(16)

是

开通/授权

状态

【描述】开通/授权状态

VALID：有效

INVALID：无效

agreement_status

creditAgreementId

string(128)

是

开通/授权

协议号

【描述】芝麻开通/授权协议号

credit_agreement_id

outAgreementNo

string(32)

否

商户外部

协议号

【描述】商户外部协议号

out_agreement_no

bizTime

string(64)

否

开通/授权

状态变更

的时间

【示例值】2021-01-19 00:00:00

biz_time

alipayUserId

string(64)

是

用户ID

【描述】蚂蚁统一会员ID

alipay_user_id和open_id任选其一传入，必传

alipay_user_id

openId

string(128)

是

开放ID

【描述】开放ID

open_id

extInfo

string(1024)

否

扩展字段

【描述】该字段只在特殊业务场景下

根据业务方约定返回

一般业务场景下不需要消费该字段

【示例值】{"key":"value"}

分期单协议号获取:

ext_info.deductAgreement.GENERAL_WITHHOLDING_P

ext_info

错误码

错误描述

解决方案

SYSTEM_ERROR

系统繁忙

服务器异常 可能发生了网络或者系统异常，导致服务调用失败，商户可以用同样的请求发起重试

INVALID_PARAMETER

参数有误

请根据接口返回的参数非法的具体错误信息，修改参数后进行重试

BIZ_ERROR

业务异常业务异常

稍后重试，或联系技术支持

CREDIT_AGREEMENT_NOT_EXIST

信用服务开通信息不存在

请检查参数是否正确

CREDIT_AUTH_NOT_EXIST

信用服务开通授权信息不存在

请检查请求参数

DEPEND_FAILURE

系统异常

系统异常，请重试

EXTRA_PARAM_FORMAT_ERROR

扩展参数格式错误

请检查扩展参数格式

ILLEGAL_QUERY

查询商户与开通授权信息关联商户不匹配

仅支持查询商户相关的开通授权信息

字段

类型

必填

字段名称

说明

vspCusid

String

是

收银宝子商户号

eventType

String

是

通知类型

alipay.open.mini.order.changed——业务状态变更通知

zhima.credit.payafteruse.creditagreement.changed——服务开通/信用授权通知

bizParam

JSONObject

是

业务参数

 各通知类型的业务参数见下方

字段名

字段类型

必填

字段名称

说明

outOrderId

String

是

商户订单号

由商家自定义

64个字符以内

仅支持字母、数字、下划线且需保证在商户端不重复

orderId

String

是

交易组件订单号

【描述】交易组件订单号

order_id和out_order_id二选一

【示例值】2015042321001004720200028594

tradeNo

String

是

支付宝交易号

string

是

交易状态

【描述】交易状态

【枚举值】

支付成功: PAID

售后退款: REFUND_CLOSED

已发货: DELIVERED

已使用: DELIVERED_USED

确认收货: RECEIVED_CONFIRM

待支付: WAIT_PAY

超时关闭: TIMEOUT_CLOSED

交易撤销: CANCEL_CLOSED

operateAppId

string

是

开发者应用ID

authAppId

string

是

授权方应用ID

totalAmount

string

是

订单金额

【描述】订单金额

单位：元

精确到小数点后两位

【示例值】12.12

receiptAmount

string

是

实收金额

【描述】实收金额

单位：元

精确到小数点后两位

该金额为本笔交易

商户账户能够实际收到的金额

【示例值】88.88

secureReason

string

是

安全处置原因

【描述】平台处置退款原因

【示例值】投诉退款

groupBuyInfo

object[group_buy_info]

（对象）

是

拼团信息

【描述】拼团信息

详见本接口下方

数组类字段说明：

group_buy_info的明细字段

userId

string

是

买家支付宝用户ID

openId

string

是

用户openId

settleType

string

否

账期标识

【描述】账期标识

【枚举值】

即时到账: normal

账期结算: extended

【示例值】normal

voucherDetailList

object[voucher_detail_list]

（对象数组）

否

券明细

【描述】券明细

详见本接口下方

数组类字段说明：

voucher_detail_list的明细字段

字段名

类型

必填

字段名称

说明

groupId

string

是

团ID

groupStatus

string

是

团状态

【描述】拼团状态

【枚举值】

拼团失败:0

拼团中:1

拼团成功:3

待成团:4

字段名

类型

必填

字段名称

说明

id

string

否

券id

【描述】券id

name

string

否

券名称

【描述】券名称

type

string

否

优惠券类

型

【描述】券类型

【枚举值】

全场代金券: ALIPAY_FIX_VOUCHER

折扣券: ALIPAY_DISCOUNT_VOUCHER

单品优惠券: ALIPAY_ITEM_VOUCHER

现金抵价券: ALIPAY_CASH_VOUCHER

商家全场券: ALIPAY_BIZ_VOUCHER

amount

string

否

优惠券金

额

【描述】优惠券金额

单位：元

精确到小数点后两位

【示例值】10.00

merchantContribute

string

否

商户出资

金额

【描述】商户出资

单位为元

精确到小数点后两位

【示例值】9.00

otherContribute

string

否

其他出资

【描述】其他出资，非交易商家

单位为元

【示例值】88.88

memo

string

否

备注信息

【描述】备注信息

templateId

string

否

券模板id

【描述】券模板id

purchaseMerchantContribute

string

否

商户出资

【描述】

购买该张券的资金中商户出资的部分

单位：元

精确到小数点后两位

【示例值】1.03

purchaseAntContribute

string

否

内部出资

【描述】

购买该张券时内部出资的部分

（包含支付宝/口碑出资的部分）

单位：元

精确到小数点后两位

【示例值】1.03

purchase_buyerContribute

string

否

买家出资

【描述】

购买该张券的资金中买家自己出资的部分

单位：元

精确到小数点后两位

【示例值】1.03

otherContributeDetail

object[other_contribute_detail]

（对象）

否

其他出资

方明细

【描述】其他出资方明细

字段名

类型

必填

字段名称

说明

contributeType

string

否

其它出资方类型

【描述】出资方类型

如品牌商出资、支付宝平台出资

【枚举值】

支付宝: PLATFORM

商户: MERCHANT

用户出资: USER

第三方机构: OTHER

contributeAmount

string

否

其它出资方金额

【描述】其它出资方金额

单位：元

精确到小数点后两位

【示例值】8.00

字段名

字段类型

必填

字段名称

说明

creditAgreementId

string

是

开通/授权协议号

agreementStatus

string

是

开通/授权状态

【描述】开通/授权状态

VALID：有效

INVALID：无效

outAgreementNo

string

是

商户外部协议号

bizTime

string

是

开通/授权状态变更的时间

【示例值】2021-01-19 00:00:00

openChannel

string

是

开通渠道

【描述】开通渠道

区分是商家侧推荐开通/支付后推荐开通

【示例值】ALIPAY_RECOMMEND

alipayUserId

string

是

用户ID

 alipay_user_id和open_id任选其一传入

必传

openId

string

是

开放ID

extInfo

string

否

扩展字段

【描述】该字段只在特殊业务场景下

根据业务方约定返回

一般业务场景下不需要消费该字段

【示例值】{"key":"value"}协议号获取：

ext_info.deductAgreement.agreement_no