云支付
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 云支付 > 开发文档 > HTTPS API 说明 > 公共数据结构

公共数据结构

最近更新时间：2023-08-14 17:00:32

我的收藏

本页目录：

订单信息

OrderContent 结构（仅作为返回参数）

一级参数名
二级参数名
必填
类型
说明
out_trade_no
-
是
String(32)
子商户订单号。
transaction_id
-
否
String(32)
第三方支付平台的订单号。
trade_type
-
否
TradeType
交易类型枚举，详见 TradeType。
author_code
-
否
String(128)
刷卡支付时的授权码。
code_url
-
否
String(64)
扫码支付时，用于扫码支付时转换成支付二维码。
time_expire
-
否
Number(64)
订单失效时间（刷卡支付不需要该字段），时间戳（秒）。
time_end
-
否
Number(64)
支付完成时间，时间戳（秒）。
nonce_str
-
是
String(32)
随机字符串。
create_time
-
是
Number(64)
订单创建时间，时间戳（秒）。
last_update_time
-
是
Number(64)
订单最近更新时间，时间戳（秒）。
total_fee
-
否
Number(32)
订单总金额，单位分。
fee_type
-
否
String(3)
货币类型（目前只支持人民币，请填 CNY）。
cash_fee
-
否
Number(32)
现金支付金额，单位分。
cash_fee_type
-
否
String(3)
现金支付货币类型（目前只支持人民币，请填 CNY）。
settlement_total_fee
-
否
Number(32)
应结支付金额，单位分。
refunded_fee
-
否
Number(32)
已退款金额，单位分，只有接口 client_order_detail 返回这个字段，接口 query_order 不返回。
body
-
否
String(128)
商品或订单简要描述。
detail
-
否
String(6000)
商品详细列表，由 json 转化而来的 string，json 结构见本节 Detail。
remark
-
否
String(127)
支付备注信息。
coupon_infos
-
否
CouponInfo[]
代金券信息，详见 CouponInfo。
out_freeze_no
-
否
String(32)
此项在押金消费时使用。关联的押金冻结单号。
freeze_fee
-
否
Number(32)
此项在押金消费时使用。押金冻结金额，单位分。
is_confirm_unfreeze
-
否
Bool
此项在押金消费时使用。此项返回是否在消费时解冻用户金额。
manual_unfreeze_fee
-
否
Number(32)
此项在押金消费时使用。消费且解冻金额，单位分。
freeze_id
-
否
String(255)
此项在押金消费时使用。第三方支付授权单号。
wxpay_order_content_ext*
current_trade_state
是
Number(32)
订单当前状态，详见 WxpayOrderState。
attach
否
String(127)
附加数据，记录子商户自定义数据。
bank_type
否
String(16)
刷卡支付时特有，付款银行类型，遵守字符型银行编码规范。
goods_tag
否
String(32)
商品标记，代金券或立减优惠功能的参数。
product_id
否
String(32)
商品 ID，子商户自定义，扫码支付时必传。
prepare_id
否
String(64)
公众号或 App 支付时，下单后用于拉起支付的预支付会话标识。
trade_state_desc
否
String(255)
对当前查询订单状态的描述和下一步操作的指引。
limit_pay
否
String(32)
非刷卡支付时，指定支付方式，目前只能是 no_credit，指定不能使用信用卡支付。
alipay_order_content_ext*
current_trade_state
是
Number(32)
订单当前状态，详见 AlipayOrderState。
voucher_detail_list
否
AlipayVoucherDetail[]
代金券列表，支付宝回包的内容，详见 AlipayVoucherDetail，示例：
"voucher_detail_list": [
{ 
    "id": "20151026000", 
    "name": "XX超市5折优惠", 
    "type": "ALIPAY_FIX_VOUCHER", 
    "amount": 10, 
    "merchant_contribute": 9, 
    "other_contribute": 1, 
    "memo":"学生专用优惠", 
    "purchase_buyer_contribute": 2.01, 
    "purchase_merchant_contribute": 1.03, 
    "purchase_ant_contribute": 0.82 
}]
fund_bill_list
是
AlipayFundBill[]
支付渠道，支付宝回包的内容，详见 AlipayFundBill，示例：
"fund_bill_list": [ 
{ 
    "fund_channel":"ALIPAYACCOUNT", 
    "amount": 10, 
    "real_amount": 11.21 
}]
discountable_amount
否
Number(64)
参与优惠的金额。
undiscountable_amount
否
Number(64)
不参与优惠的金额。
point_amount
否
Number(64)
积分金额。
invoice_amount
否
Number(64)
可以开具发票的金额。
product_code
否
String(32)
产品码。
royalty_info
否
String(64)
json 的分账信息。
send_pay_date
否
Number(64)
该订单打款给卖家的时间。
extend_params
否
String(1024)
扩展信息，花呗相关的逻辑。
enable_pay_channels
否
String(1024)
可用渠道，多个渠道用“,”分割，如：pay_channels="credit_group,point"。
disable_pay_channels
否
String(1024)
不可用渠道，格式同 enable_pay_channels。
discount_goods_detail
是
String(1024)
打折相关信息，示例：
[{ 
    "goods_id":"STANDARD1026181538", 
    "goods_name":"雪碧", 
    "discount_amount":"100.00", 
    "voucher_id":"2015102600073002039000002D5O" 
}]
buyer_logon_id
是
String(100)
买家支付宝账号，回包的内容。
seller_id
否
String(100)
卖家支付宝用户号，回包的内容。
seller_email
否
String(64)
卖家支付宝账号，回包的内容。
gmt_refund
是
Number(64)
交易退款时间。
gmt_close
是
Number(64)
交易结束时间。
refund_fee
是
Number(64)
退款金额。
out_biz_no
否
String(64)
商户业务号，回包的内容。
record_order_content_ext*
current_trade_state
是
Number(32)
订单当前状态，详见 RecordOrderState。
带*项只会有一个。

AlipayFundBill 结构

参数名
必填
类型
说明
fund_channel
是
String(32)
是否发生了资金变化，示例 Y。
amount
是
Number(64)
支付金额。
real_amount
否
Number(64)
实际支付金额。

Detail 结构

参数名
必填
类型
说明
cost_price
否
Number(32)
订单原价，商户侧一张小票订单可能被分多次支付，订单原价用于记录整张小票的支付金额。当订单原价与支付金额不相等则被判定为拆单，无法享受优惠。
receipt_id
否
String(32)
商家小票 ID。
goods_detail
否
GoodsDetail[]
商品详情，详见 GoodsDetail。

GoodsDetail 结构

参数名
必填
类型
说明
goods_id
是
String(32)
商品的编号。
goods_name
否
String(256)
商品名称。支付宝必填，微信支付非必填。
quantity
是
Number(32)
商品数量。
price
是
Number(32)
商品单价（单位：分）。
如果商户有优惠，需传输商户优惠后的单价，单品总金额应 <= 订单总金额 total_fee，否则会无法享受优惠。

AlipayVoucherDetail 结构

参数名
必填
类型
说明
id
是
String(32)
券 ID。
name
是
String(64)
券名称。
type
是
String(32)
代金券类型。
amount
是
Number(64)
代金券金额。
merchant_amount
否
Number(64)
商户出资。
other_amount
否
Number(64)
其它出资。
memo
否
String(256)
备注。

退款单信息

RefundOrderContent 结构（仅作为返回参数）

一级参数名
二级参数名
必填
类型
说明
-
是
String(32)
子商户退款单号，云支付系统内全局唯一。
refund_id
-
否
String(32)
第三方支付平台的退款单号。
out_trade_no
-
是
String (32)
退款单对应的订单号。
trade_type
-
否
String(128)
TradeType 交易类型，详见 TradeType。
nonce_str
-
是
String(32)
随机字符串。
create_time
-
是
Number(64)
退款单创建时间，时间戳（秒）。
last_update_time
-
是
Number(64)
退款单最近更新时间，时间戳（秒）。
total_fee
-
是
Number(64)
订单总金额，单位：分。
refund_fee
-
是
Number(64)
本次退款总金额，单位：分。
refund_fee_type
-
是
String(3)
本次退款总金额货币类型（目前只支持人民币，请填 CNY）。
refund_reason
-
否
String(255)
退款原因。
coupon_infos
-
否
CouponInfo[]
退款代金券信息，详见 CouponInfo。
is_deposit_mode
-
否
Bool
是否是押金消费单。
out_freeze_no
-
否
String(32)
此项为押金消费使用。
押金冻结单号。
freeze_fee
-
否
Number(32)
此项为押金消费使用。
押金冻结金额。
wxpay_refund_order_content_ext*
state
是
Number(32)
退款状态，详见 WxpayRefundOrderState。
cash_refund_fee
否
Number(32)
现金退款金额，单位：分。
coupon_refund_fee
否
Number(32)
退款代金券金额，支持多张代金券，单位：分。
coupon_refund_count
否
Number(32)
退款代金券数量。
refund_account
否
String(30)
退款资金来源，仅针对老资金流子商户使用。默认使用未结算资金退款：
REFUND_SOURCE_UNSETTLED_FUNDS：未结算资金退款。
REFUND_SOURCE_RECHARGE_FUNDS：可用余额退款。
refund_channel
否
String(16)
退款渠道。
ORIGINAL：原路退款。
BALANCE：退回到余额。
refund_recv_account
否
String(64)
取当前退款单的退款入账方。
1. 退回银行卡：{银行名称}{卡类型}{卡尾号}。
2. 退回支付用户零钱：支付用户零钱。
alipay_refund_order_content_ext*
refund_status
是
Number(32)
支付宝退款状态，详见枚举类型 AlipayRefundOrderState。
fund_change
是
String(1)
是否发生了资金变化，示例 Y。
gmt_refund_pay
是
String(32)
退款时间。
refund_detail_item_list
否
AlipayFundBill
退款渠道，详见 AlipayFundBill。
record_refund_order_content_ext*
state
是
Number(32)
退款状态，详见枚举类型 RecordRefundOrderState。
?
带*项只会有一个。

押金单信息

FreezeOrderContent 结构（仅作为返回参数）

一级参数名
二级参数名
必填
类型
说明
-
是
String
冻结押金授权单号。
freeze_id
-
否
String(255)
此项在押金消费时使用。第三方支付授权单号。
trade_type
-
是
Number(64)
支付方式。
author_code
-
否
String
刷卡支付授权码。
time_expire
-
否
Number(64)
订单失效时间。
time_end
-
否
Number(64)
支付完成时间。
create_time
-
是
Number(64)
冻结单创建时间。　
last_update_time
-
是
Number(64)
冻结单创建时间。
is_transforming
-
是
Bool
系统是否正在处理。
freeze_fee
-
是
Number(32)
冻结金额，单位分。
fee_type
-
是
String
冻结货币类型。
cash_fee
-
是
Number(32)
现金支付金额（第三方支付平台返回）。
cash_fee_type
-
是
String
现金支付货币类型（第三方支付平台返回）。
settlement_total_fee
-
否
Number(32)
应结支付金额，单位分。
body
-
是
String(128)
商品或订单简要描述。
detail
-
否
String
商品详细列表，由 json 转化而来的 string，json 结构见本节 Detail。
remark
-
否
String(127)
支付备注信息。
total_consume_fee
-
否
Number(32)
冻结单消费金额，单位分。
total_manual_unfreeze_fee
-
否
Number(32)
冻结单解冻金额，单位分。
total_auto_unfreeze_fee
-
否
Number(32)
冻结单第三方自动解冻金额，单位分。
total_refund_fee
-
否
Number(32)
冻结消费后，退款金额，单位分。
wxpay_freeze_order_content_ext*
current_trade_state
是
Number(32)
当前微信支付冻结状态。
attach
否
String(127)
附加数据，记录子商户自定义数据。
bank_type
否
String(16)
付款银行类型，遵守字符型银行编码规范。
trade_state_desc
否
String(255)
对当前查询冻结单状态的描述和下一步操作的指引。
limit_pay
否
String(32)
限定支付方式，目前只能是：no_credit，指定不能使用信用卡支付。
goods_tag
否
String(32)
商品标记，代金券或立减优惠功能的参数。
alipay_freeze_order_content_ext*
current_trade_state
是
Number(32)
当前支付宝冻结状态。
product_code
是
String(32)
销售产品码。
enable_pay_channels
否
String
商户指定支付渠道。
settle_fee_type
否
String(3)
结算 fee_type。
带*项只会有一个。

UnfreezeOrderContent 结构（仅作为返回参数）

一级参数名
二级参数名
必填
类型
说明
-
是
String(32)
冻结单号。
out_unfreeze_no
-
是
String(32)
解冻单号。
unfreeze_id
-
否
String(32)
第三方解冻单信息。
trade_type
-
否
TradeType
交易类型，详见枚举 TradeType。
time_end
-
否
Number(64)
支付完成时间，时间戳（秒）。
nonce_str
-
否
Number(32)
随机字符串。
create_time
-
是
Number(64)
订单创建时间，时间戳（秒）。　
last_update_time
-
是
Number(64)
订单最近更新时间，时间戳。 　
is_transforming
-
是
Bool
系统是否正在处理中。
unfreeze_fee
-
是
Number(32)
订单总金额（分）。
fee_type
-
否
String(3)
货币类型。
remark
-
否
String(127)
备注信息。
freeze_id
-
否
String(32)
第三方冻结单信息。
wxpay_unfreeze_order_content_ext*
current_trade_state
否
Number(32)
微信解冻单状态，详见枚举 WxpayUnfreezeOrderState。
alipay_unfreeze_order_content_ext*
current_trade_state
是
Number(32)
支付宝解冻单状态，详见枚举 AlipayUnfreezeOrderState。
credit_amount
否
Number(64)
信用解冻金额。
fund_amount
否
Number(64)
自有资金解冻金额。
pre_auth_type
否
String(32)
预授权类型。
带*项只会有一个。

支付商户信息结构

PayMchKey 结构

一级参数名
二级参数名
必填
类型
说明
-
是
Number(32)
第三方支付类型，详见枚举 PayPlatform。
sub_pay_platform
-
是
Number(32)
第三方支付子类型，详见枚举 SubPayPlatform。
out_mch_id
-
是
String(32)
服务商对外账号。
out_sub_mch_id
-
是
String(32)
子商户对外账号。
out_shop_id
-
是
String(32)
门店对外账号。
wxpay_pay_mch_key_ext*
app_id
否
String(32)
微信分配给服务商的公众账号 ID。
sub_app_id
否
String(32)
微信分配给子商户的公众账号 ID。
alipay_pay_mch_key_ext*
user_id
否
String(32)
用户支付宝 user_id。
带*项只会有一个。

OrderClient 结构

参数名
必填
类型
说明
shop_id
否
String(64)
子商户自定义，门店编号。
device_id
否
String(64)
子商户自定义，终端设备号。
staff_id
否
String(64)
子商户自定义，店员 ID。
terminal_type
是
Number(32)
终端类型，1：Windows，2：Andriod，3：iOS，4：Linux，100：其他。
sub_terminal_type
是
Number(32)
用户自定义子终端类型。
machine_no
否
String(32)
刷卡支付和刷卡押金冻结特有，每个收银终端的唯一码（刷卡支付和刷卡押金冻结必填）。
sdk_version
是
String(10)
云支付 SDK 版本号。
spbill_create_ip
是
String(16)
调用云支付 API 的机器 IP。
sn_code
否
String(127)
设备 sn 号。

门店信息结构

ShopInfo 结构

参数名
必填
类型
说明
shop_id
是
Sting(64)
门店编号。
shop_name
是
String(32)
门店名称。
province
否
String(32)
门店所在省。
city
否
String(32)
门店所在市。
district
否
String(32)
门店所在区。
address
否
String(128)
门店详细地址。
coordinate_type
否
Number(32)
门店坐标类型。
longitude
否
String(16)
门店经度。
latitude
否
String(16)
门店维度。
height
否
String(16)
门店海拔。
phone
否
String(64)
门店联系电话。
out_shop_id
否
String(20)
外部可见的商户门店号，云支付内全局唯一，可用于生成门店固定二维码，仅返回时有该字段。
out_shop_id_url
否·
String(128)
门店二维码，仅返回时有该字段。
device_infos
否
DeviceInfo[]
门店设备信息列表，详见 DeviceInfo。
staff_infos
否
StaffInfo[]
门店店员信息列表，详见 StaffInfo。
fee_type
否
String(20)
门店支持的币种，如果不填，默认为 CNY。

DeviceInfo 结构

参数名
必填
类型
说明
device_id
是
String(64)
门店内终端编号。
remark
否
String(64)
子商户自定义备注信息。
device_name
是
String
设备名称。
device_shift_type
否
Number(32)
设备类型，1：移动收款机具，2：云支付收银台，3：智能 POS，4：其它。

StaffInfo 结构

参数名
必填
类型
说明
staff_id
是
String(64)
门店内店员编号。
staff_name
是
String(64)
店员名称。
remark
否
String(64)
子商户自定义备注信息。
shop_manager
是
Bool
是否是店长。
receive_one_code_pay_notify
否
Bool
是否接收一码支付的成功消息通知。

CouponInfo 结构

参数名
必填
类型
说明
coupon_id
否
String(20)
代金券或立减优惠 ID 使用微信支付代金券时有返回。
coupon_fee
否
Number(64)
单个代金券或立减优惠支付金额。
coupon_type
否
String(8)
代金券类型，CASH：充值代金券，NO_CASH：非充值代金券，使用代金券时有返回。
contribute_type
否
Number(32)
资金来源，1：商户，2：平台，3：其他。
?
中国站


http://www.vxiaotou.com