数据字典

2023-12-04 07:35

模型

Address

字段名	数据类型	是否为必填字段	描述
region	字符串	否	代表所在国家/地区的二字母ISO-3166 代码更多信息：字段最大长度：2
state	字符串	否	省/州/郡更多信息：字段最大长度：64
city	字符串	否	城市/地区/郊/镇/村更多信息：字段最大长度：64
address1	字符串	否	地址第一行更多信息：字段最大长度：256
address2	字符串	否	地址第二行更多信息：字段最大长度：256
zipCode	字符串	否	邮编更多信息：字段最大长度：32

Amount

字段名

数据类型

是否为必填字段

描述

currency

字符串

是

符合ISO-4217规范的三字母货币代码

更多信息：

字段最大长度：3

value

整数

是

数额，基于当前货币最小单位的数额。例如：当currency 为 USD时，100 = $1.00。当currency 为 JPY时，100 = ¥100

更多信息：

创建订单时，集成商宜使用整数类型。万里汇返回值参数固定为字符串类型。
字段最大长度：16

Buyer

字段名	数据类型	是否为必填字段	描述
referenceBuyerId	字符串	是	商户在平台侧的ID

FeeDetailSummary

字段名	数据类型	是否为必填字段	描述
feeType	字符串	是	费用对象无费用的时候此字段值为空
paymentMethodType	字符串	是	支付方法取值为固定值： `WALLET_WF`
feeAmount	Amount 对象	是	费用金额

Order

字段名	数据类型	是否为必填字段	描述
referenceOrderId	字符串	是	商户端的订单ID，用于用户消费记录展示，支付后续操作如客诉、争议等追踪使用更多信息：字段最大长度：64
transactionTime	DateTime 对象	是	电商端订单创建时间此字段采用ISO 8601 标准时间戳，并精确到毫秒。如：`2022-06-17T08:43:58.588Z`
orderDescription	字符串	是	订单概要描述，用于用户消费记录展示等。更多信息：字段最大长度：256
orderTotalAmount	Amount 对象	是	支付总金额。在支付成功页面需要给商户展示此金额
orderFeeAmount	Amount 对象	否	总费用。在支付成功页面给商户展示此金额
shippingInfo	Shipping 对象	否	物流信息

OrderGroup

字段名	数据类型	是否为必填字段	描述
orderGroupId	字符串	是	订单组ID 更多信息：字段最大长度：64
orderGroupDescription	字符串	否	订单组描述信息，如：`收银支付`。此信息将在支付页面上展示。更多信息：字段最大长度：64
orderBuyer	Buyer 对象	是	买家信息，用于风控
orders	数组<Order 对象>	是	订单信息

OrderResult

字段名

数据类型

是否为必填字段

描述

status

字符串

是

单据状态

取值范围：

SUCCESS：单据成功
PROCESS_FAIL：单据处理失败
BANK_REFUSE_PAYMENT：银行拒付

statusMsg

字符串

是（有条件）

状态相关信息

无相关信息时返回 null

PaymentDetailSummary

字段名	数据类型	是否为必填字段	描述
customerId	字符串	是（有条件）	用户ID 由WorldFirst分配给合作商的唯一用户ID。此字段仅在notifyPayment接口里返回给集成商，在inquirePayment毋需传输更多信息：字段最大长度：32
customerName	UserName对象	是（有条件）	付款方名称，即买家名称。若付款方为企业，使用`customerName.fullName`字段传送企业名称；若付款方为个人用户，使用`customerName.fullname`字段传送个人姓名。注：使用此字段传输付款方名称的能力仍处于白名单开量阶段，尚未完全开放。如果需要使用该能力，请提前联系您的BD负责人或SA。
paymentAmount	Amount 对象	是	本次支付中，付款执行人应收支付金额
paymentMethodType	字符串	是	支付方法取值为固定值： `WALLET_WF`
paymentMethodMetadata	字符串	否	关于平台商WorldFirst登录账号的扩展信息。
extendInfo	字符串	是（有条件）	扩展信息。仅在支付手续费场景下，万里汇返回此字段。

PaymentMethod

字段名

数据类型

是否为必填字段

描述

paymentMethodType

字符串

是

支付方式。默认值为：WALLET_WF

取值范围：

WALLET_WF
MIXEDCARD

PayToDetail

字段名	数据类型	是否为必填字段	描述
payToRequestId	字符串	是	由商户生成的唯一的对应一笔WorldFirst应付明细的支付请求号此字段为幂等字段更多信息：字段最大长度：64
referenceOrderId	字符串	是	商户端的订单ID，用于用户消费记录展示，支付后续操作如客诉、争议等追踪使用更多信息：字段最大长度：64
payToAmount	Amount 对象	是	本次支付中，付款执行人应付支付金额
payToMethod	PayToMethod 对象	是	本次支付中，付款执行人应付支付工具详情，表达支付工具对象及支付工具账号标志
paymentNotifyUrl	字符串	是	支付通知地址。集成商可自定义支付通知地址更多信息：字段最大长度：1024
extendInfo	字符串	否	扩展信息更多信息：字段最大长度：2048
paymentExpiryTime	DateTime	否	订单绝对超时时间。注：当paymentExpiryTime和paymentTimeoutExpress两者同时传送时，默认使用paymentExpiryTime。更多信息：此字段采用ISO 8601 标准时间戳。如：2018-09-03T00:00:00+08:00，或2019-01-01T01:01:01Z（UTC时间）此字段仍处于白名单开量阶段，尚未完全开放。如需使用，请提前联系您的BD负责人或SA。
paymentTimeoutExpress	字符串	否	订单相对超时时间。从交易创建时间开始计算。该笔订单允许的最晚付款时间，逾期将关闭订单。注：当paymentExpiryTime和paymentTimeoutExpress两者同时传送时，默认使用paymentExpiryTime。该字段的时间单位为：m（分钟），h（小时），d（天）。该参数数值必须为整数，如 1.5 h必须转换为 90 m。此字段仍处于白名单开量阶段，尚未完全开放。如需使用，请提前联系您的BD负责人或SA。

PayToMethod

字段名	数据类型	是否为必填字段	描述
paymentMethodType	字符串	是	支付方法取值为固定值： `WALLET_WF`
paymentMethodDataType	字符串	是	支付方法数据类型取值为固定值： `PAYMENT_ACCOUNT_NO`: 用户账号
customerId	字符串	是	用户ID 由WorldFirst分配给合作商的唯一用户ID 更多信息：字段最大长度：32

PayToSummary

字段名	数据类型	是否为必填字段	描述
orderResult	OrderResult 对象	是（有条件）	单据状态更多信息：在inquirePayment接口中字段为有条件必须传输在createCashierPayment接口中字段不传输
payToAmount	Amount 对象	是	本次支付中，付款执行人应付支付金额
payToCreateTime	DateTime 对象	是	支付单创建时间更多信息：此字段采用ISO 8601 标准时间戳。如：`2018-09-03T00:00:00+08:00`
payToId	字符串	是	针对每笔支付的细节，WorldFirst返回的唯一单号更多信息：字段最大长度：64
payToRequestId	字符串	是	由商户生成的唯一的对应一笔WorldFirst应付明细的支付请求号更多信息：此字段为幂等字段更多信息：字段最大长度：64

RedirectActionForm

字段名	数据类型	是否为必填字段	描述
actionFormType	字符串	是	ActionForm对象取值范围: `RedirectActionForm`：跳转类ActionForm
method	字符串	是	HTTP方法更多信息：字段最大长度：64
parameters	字符串	否	HTTP方法中调用value关键字所需参数更多信息：字段最大长度：2048
redirectUrl	字符串	是	跳转URL 更多信息：字段最大长度：1024
extendInfo	字符串	否	更多信息更多信息：字段最大长度：2048

RefundOrder

字段名

数据类型

是否为必填字段

描述

refundFeeAmount

Amount 对象

否

退款费用

referenceRefundId

字符串

否

由集成商定义的唯一退款ID

更多信息：

字段最大长度：64

RefundToDetail

字段名	数据类型	是否为必填字段	描述
refundMethod	PaymentMethod 对象	是	本次退款所使用的支付方式
refundAmount	Amount 对象	是	本次退款应付金额
refundToAmount	Amount 对象	否	本次退款支付方收到金额
extendInfo	字符串	否	本次退款更多信息更多信息：字段最大长度：2048

RefundDetail

字段名	数据类型	是否为必填字段	描述
refundMethod	PaymentMethod 对象	是	本次退款所使用的支付方式
refundAmount	Amount 对象	是	本次退款应付金额

Result

字段名	数据类型	是否为必填字段	描述
resultCode	字符串	是	结果代码更多信息：字段最大长度：64
resultStatus	字符串	是	结果状态对象取值范围: `S`：成功 `F`：失败 `U`：未知
resultMessage	字符串	否	结果信息更多信息：字段最大长度：256

Shipping

字段名	数据类型	是否为必填字段	描述
shippingName	UserName 对象	否	发货人姓名
shippingAddress	Address 对象	否	发货地址
shippingFee	Amount 对象	否	运费
shippingCarrier	字符串	否	运输公司名更多信息：字段最大长度：128

UserName

字段名	数据类型	是否为必填字段	描述
firstName	字符串	否	用户名字更多信息：字段最大长度：32
middleName	字符串	否	用户中间名更多信息：字段最大长度：32
lastName	字符串	否	用户姓氏更多信息：字段最大长度：32
fullName	字符串	否	用户全名更多信息：字段最大长度：128

refundInfo

字段名	数据类型	是否必填	描述
refundId	字符串	是	退款单号更多信息：字段最大长度：64字符
refundRequestId	字符串	是	退款请求号更多信息：字段最大长度：64字符
payToId	字符串	是	针对每笔支付的细节，WorldFirst返回的唯一单号更多信息：字段最大长度：64字符
refundReason	字符串	否	退款原因更多信息：字段最大长度：256字符
refundAmount	Amount 对象	是	退款金额
refundTime	DateTime	是	退款时间更多信息：此字段采用ISO 8601 标准时间戳。如：`2018-09-03T00:00:00+08:00`，或`2019-01-01T01:01:01Z`（UTC时间）
refundStatus	字符串	是	退款状态可取值有： `SUCCESS` 退款成功
refundOrderDetail	数组<RefundOrderDetail>对象	是	退款详情

refundOrderDetail

字段名	数据类型	是否必填	描述
refundActualAmount	Amount 对象	是	实际退款金额
fundType	字符串	有条件返回	退款类型注：该字段取值固定为`FEE` 手续费
paymentMethodType	字符串	是	支付类型注：该字段目前取值固定为`WALLET_WF`

枚举值

枚举值类型均为字符串

PaymentMethodType

枚举值	描述
WALLET_WF	使用WorldFirst支付
MIXEDCARD	使用卡支付
BALANCE	支付到AB钱包余额