账户更新器元素
以下每个章节都定义了一个特定元素、它与其他元素(父元素和子元素)的关系,以及与该元素相关联的任何属性。
accountUpdater
accountUpdate
元素是所有账户更新器请求交易的父元素。您只能将其用于批量交易。
父元素:
属性:
属性名称 | 类型 | 必需? | 描述 |
---|---|---|---|
id | 字符串 | 是 | 由出示者分配并在响应中镜像映射回来的独特识别码。 最小长度 = 不适用 最大长度 = 25 |
customerId | 字符串 | 否 | 由商户分配用于识别消费者的值。 最小长度 = 不适用 最大长度 = 50 |
reportGroup | 字符串 | 是 | 在将显示该交易的用户界面中定义商户子组的必需属性。 最小长度 = 1 最大长度 = 25 |
子元素:(必需)
orderId
cardOrToken
card
或 token
元素)
accountUpdateFileRequestData
accountUpdateFileRequestData
元素是 RFRRequest
元素的子元素,在请求账户更新器提交的响应文件时为必需。
父元素:
属性:
无
子元素:
必需:
可选:
accountUpdateFileRequestData Structure
<accountUpdateFileRequestData>
<merchantId>Merchant ID</merchantId>
<postDay>Post Date</postDay>
</accountUpdateFileRequestData>
<accountUpdateFileRequestData> <merchantId>Merchant ID</merchantId> <postDay>Post Date</postDay> </accountUpdateFileRequestData>
accountUpdateResponse
accountUpdaterResponse
元素是所有账户更新器响应交易的父元素。您只能将其用于批量交易。
父元素:
属性:
属性名称 | 类型 | 必需? | 描述 |
---|---|---|---|
id | 字符串 | 是 | 该响应会返回与 accountUpdate 交易中提交的相同值。 最小长度 = 不适用 最大长度 = 25 |
customerId | 字符串 | 无 | 该响应会返回与 accountUpdate 交易中提交的相同值。 最小长度 = 不适用 最大长度 = 50 |
reportGroup | 字符串 | 是 | 该响应会返回与 accountUpdate 交易中提交的相同值。 最小长度 = 1 最大长度 = 25 |
子元素:(必需)
cnpTxnId
orderId
response
responseTime
message
子元素:(可选)
authenticatedShopperID
authenticatedShopperID
元素是 accountUpdate
元素的选填项子元素,它定义了已验证身份的购物者识别码的值。该值只适用于在 WPG 平台上提交账户更新请求的商户。
Type= String; minLength=1; maxLength=64
父元素(可选)
Token
属性:
无
子元素
无
身份验证
authentication
元素同时是 cnpOnlineRequest
和 batchRequest
元素的必需元素。它包含用于验证 XML 消息是否源自有效用户的子元素。
父元素:
属性:
无
子元素:
身份验证结构
<authentication>
<user>User Name</user>
<password>Password</password>
</authentication>
<authentication> <user>User Name</user> <password>Password</password> </authentication>
batchRequest
这是所有 cnpAPI 批量请求的根元素。
父元素:
属性:
该元素的架构中列出了许多附加属性,但账户更新器交易不需要这些属性。
属性名称 | 类型 | 必需? | 描述 |
---|---|---|---|
id | 字符串 | 否 | 用于识别系统内该 batchRequest 的独特字符串。 最小长度 = 不适用 最大长度 = 50 |
numAccountUpdates | 整数 | 无 | 定义了 batchRequest 中账户更新交易的总计数。 最小长度 = 不适用 最大长度 = 不适用 |
merchantId | 字符串 | 是 | 用于识别系统内商户的独特字符串。 最小长度 = 不适用 最大长度 = 50 |
子元素:
batchResponse
batchResponse
元素是在响应您提交处理的某个批量时返回给您的信息的父元素。它是 cnpResponse
元素的子元素。
父元素:
属性:
属性名称 | 类型 | 必需? | 描述 |
---|---|---|---|
Id | 字符串 | 否 | 在确认消息中,该响应会返回与在 batchRequest 中提交的相同的值。该属性并未在 AU 完成响应消息中返回。 最小长度 = 不适用 最大长度 = 25 |
cnpBatchId | 长 | 是 | 由我们分配用于识别批量的独特值。 最小长度 = 不适用 最大长度 = 19 |
merchantId | 字符串 | 是 | 该响应会返回与授权交易中提交的相同的值。 最小长度 = 1 最大长度 = 50 |
子元素:
bin
bin
元素提供了发卡银行的 6 位数银行(或发卡机构)识别号。当发出新的 token 以替换 Visa 或 MasterCard 账号时,系统会在 XML 响应中返回此值。对于 Discover 和 American Express 卡,此元素为空。
Type = String; minLength = 0; maxLength = 6
父元素:
bin
元素是每个所列父元素的可选子元素。
属性:
无
子元素:
无
卡
card
元素通过其子元素定义了支付卡信息。
父元素:
属性:
无
子元素:
卡结构 - 账户更新器
<card>
<type>Card Type Abbreviation</type>
<number>Account Number</number>
<expDate>Expiration Date</expDate>
</card>
<card> <type>Card Type Abbreviation</type> <number>Account Number</number> <expDate>Expiration Date</expDate> </card>
cardOrToken
cardOrToken
元素是允许替换卡或 token 元素的抽象值。您必须指定两个替换元素之一作为 accounupdate 元素的子元素。
父元素:
替换选填项:
cnpRequest
这是所有 cnpAPI 批量请求的根元素。
父元素:
无
属性:
属性名称 | 类型 | 必需? | 描述 |
---|---|---|---|
version | 字符串 | 是 | 定义了作为 XML 验证依据的 cnpAPI 架构版本。当前版本为 7.3,但您可以使用较低版本。 最小长度 = 不适用 最大长度 = 10 |
xmlns | 字符串 | 是 | 定义了架构定义的 URI。这是一个固定位置,必须按照如下进行指定:http://www.vantivcnp.com/schema。 最小长度 = 不适用 最大长度 = 38 |
id | 字符串 | 否 | 用于识别系统内会话的独特字符串。 最小长度 = 不适用 最大长度 = 25 |
numBatchRequests | 整数 | 是 | 定义了 cnpRequest 中包括的 batchRequest 子元素的总数。如果 cnpRequest 只包含 RFRRequest,则将该属性设为“0”。 |
子元素:
以下其中一项为必需:
cnpResponse
这是所有 cnpAPI 批量响应的根元素。
父元素:
无
属性:
属性名称 | 类型 | 必需? | 描述 |
---|---|---|---|
version | 字符串 | 是 | 定义了作为 XML 消息验证依据的 cnpAPI 架构版本。 最小长度 = 不适用 最大长度 = 10 |
id | 字符串 | 否 | 该响应会返回与授权交易中提交的相同值。 最小长度 = 不适用 最大长度 = 25 |
response | 字符串 | 是 | 表示您的 XML 句法是否通过了验证。预期值如下: 0 - XML 验证成功。 1 - XML 验证失败。有关更多详情,请参见消息属性。 最小长度 = 不适用 最大长度 = 3 |
message | 字符串 | 是 | XML 验证错误消息。预期值如下: 如果响应属性返回的值为 0,则消息属性返回文本“Valid Format”(有效格式)。 如果响应属性返回的值为 1,则消息属性返回错误消息,从而帮助您识别并排除语句问题。 最小长度 = 不适用 最大长度 = 512 |
cnpBatchId | 长 | 是 | 由我们分配用于识别会话的独特值。 最小长度 = 不适用 最大长度 = 19 |
子元素:
以下其中一项为必需:
cnpToken
cnpToken
元素定义了 token 的值。当发出新的 token 以替换账号时,系统在 XML 响应中返回此值。该 token 的长度与提交的账号长度相同。
Type = String; minLength = 13; maxLength = 25
父元素:
cnpToken
元素是每个所列父元素的可选子元素。
属性:
无
子元素:
无
cnpTxnId
cnpTxnId
元素用于识别系统中的交易。系统在 XML 响应中返回此元素。您可在各种请求中用它来引用原始交易。例如,在提交收款交易时,您可以包含关联授权的 cnpTxnId
。
Type = Long; minLength = N/A; maxLength = 19
父元素:
属性:
无
子元素
无
expDate
merchantId
merchantId
元素是 accountUpdateFileRequestData
元素的子元素,在您请求账户升级文件时使用。该值是用于识别系统内商户的独特字符串。
Type = String; minLength = N/A; maxLength = 50
父元素:
属性:
无
子元素:
无
多个元素使用 merchantId
作为属性,包括 batchRequest
、batchResponse
和 cnpOnlineRequest
。
message
message
元素包含交易返回的响应代码的简短定义。
若要了解响应代码和相关消息的完整列表,请参见 Worldpay eComm cnpAPI 参考指南。
Type = String; minLength = N/A; maxLength = 512
父元素:
属性:
无
子元素:
无
number
number
元素是 card
元素的必需子元素,用于无卡交易和账户更新交易。它还是 accountInformation
元素的可选子元素,用于“授权”和“销售”响应。它定义了与交易关联的账号。
Type = String; minLength = 13; maxLength = 25
父元素:
属性:
无
子元素:
无
orderId
orderId
元素定义了商户分配的值,该值代表了商户系统中的顺序。
Type = String; minLength = N/A; maxLength = 25<
父元素:
accountUpdate
accountUpdateResponse
属性:
无
子元素:
无
originalCard
originalCard
元素是 accountUpdateResponse
元素的可选子元素,其中包含为提交的银行卡提供原始信息的子元素。
父元素:
属性:
无
子元素:
originalCard 结构
<originalCard>
<type>Old Card Type</type>
<number>Old Account Number</number>
<expDate>Old Expiration Date</expDate>
</originalCard>
<originalCard> <type>Old Card Type</type> <number>Old Account Number</number> <expDate>Old Expiration Date</expDate> </originalCard>
originalToken
originalToken
元素是 accountUpdateResponse
元素的可选子元素,其中包含为提交的 token 提供原始信息的子元素。
父元素:
属性:
无
子元素:
cnpToken
tokenUrl
expDate
type
bin
originalToken 结构
<originalToken>
<cnpToken>Old Token Number</cnpToken>
<expDate>Old Expiration Date</expDate>
<type>Old Card Type</type>
<bin> Old Card BIN </bin>
</originalToken>
<originalToken> <cnpToken>Old Token Number</cnpToken> <expDate>Old Expiration Date</expDate> <type>Old Card Type</type> <bin> Old Card BIN </bin> </originalToken>
password
password
元素是 authentication
元素的必需子元素。它与用户元素组合使用,用于验证消息是否源自有效来源。
Type = String; minLength = N/A; maxLength = 20
父元素:
属性:
无
子元素:
无
postDay
postDay
元素是 accountUpdateFileRequestData
元素的可选子元素,它定义了您提交账户更新器请求的日期。其格式为 YYYY-MM-DD。
该日期也是我们创建账户更新器确认文件的日期。
Type = Date; minLength = N/A; maxLength = 10
父元素:
属性:
无
子元素:
无
response
response
元素包含一个三位数的代码,它指明了交易是已获批(000 代码)还是已拒绝。消息元素提供了响应代码的简短定义。
若要了解响应代码和相关消息的完整列表,请参见 Worldpay eComm cnpAPI 参考指南附录 A。
Type = String; minLength = N/A; maxLength = 3
父元素:
属性:
无
子元素:
无
responseTime
responseTime
元素提供了响应的日期/时间戳。该元素的格式为 YYYY-MM-DDTHH:MM:SS。例如,2009-12-21T11:37:04。
Type = String; minLength = N/A; maxLength = 19
父元素:
属性:
无
子元素:
无
RFRRequest
RFRRequest
元素是 cnpRequest
元素的可选子元素。您可以按两种方式之一来使用此类型的请求。
若要从之前处理的
cnpRequest
请求会话响应,则包括cnpSessionId
子元素。导致的 RFR 响应将复制与cnpSessionId
关联的原始会话响应。在响应中返回的会话 ID 将作为原始会话的会话 ID。若要请求账户更新器完成响应文件,则包括
accountUpdateFileRequestData
元素。如果完成文件准备就绪,则它会被返回。如果完成文件未准备就绪,您会收到 RFR 响应消息,其中响应属性会被设为 1,同时消息属性文本显示“The account Update file is not ready yet.Please try again later.(账户更新文件尚未准备就绪。请稍后重试。)”。
父元素:
属性:
无
子元素:(选择其中的)
cnpSessionId
或accountUpdateFileRequestData
RFRRequest 结构 - 批量
<RFRRequest>
<cnpSessionId>Session ID</cnpSessionId>
</RFRRequest>
<RFRRequest> <cnpSessionId>Session ID</cnpSessionId> </RFRRequest>
RFRRequest 结构 - 账户更新器
<RFRRequest>
<accountUpdateFileRequestData>
<merchantId>Merchant ID</merchantId>
<postDay>Post Date</postDay>
</accountUpdateFileRequestData>
</RFRRequest>
<RFRRequest> <accountUpdateFileRequestData> <merchantId>Merchant ID</merchantId> <postDay>Post Date</postDay> </accountUpdateFileRequestData> </RFRRequest>
RFRResponse
RFRResponse
元素是 cnpResponse
元素在响应 RFRRequest 时返回的可选子元素。
父元素:
属性:
属性名称 | 类型 | 必需? | 描述 |
---|---|---|---|
response | 字符串 | 是 | 表示 RFR 请求结果的 RFR 响应代码。 最小长度 = 不适用 最大长度 = 3 |
message | 字符串 | 是 | 该交易返回的响应代码的简短定义。 最小长度 = 不适用 最大长度 = 512 |
子元素:
无
Token
tokenUrl
tokenUrl
元素是 token、originalToken、updatedToken 元素的可选子元素。当通过 WPG (Worldpay Gateway) 提交账户更新器请求时,可以使用它来提交 token URL 值。该值必须使用以下模式: http.?://./.
Type = String; minLength = N/A; maxLength = 400
- 在向 WPG 请求账户更新器服务时,您只能在账户更新器请求中使用 tokenURL 元素。
父元素:
属性:
无
子元素:
无
类型
该 type
元素在卡协会、卡公司、Bill Me Later 或 PayPal 等方面定义了在交易中使用的账户类型。从账户更新器的角度,MC、VI 和 DI 是仅有的有效枚举。
- 有关
type
元素其他应用的信息,请参见 Worldpay eComm cnpAPI 参考指南。
Type = String (Enum); minLength = N/A; maxLength = 2
父元素:
originalCard
updatedCard
card
originalToken
updatedToken
属性:
无
子元素:
无
枚举:
枚举 | 描述 |
---|---|
MC | MasterCard |
VI | Visa |
DI | Discover |
updatedCard
updatedCard
元素是 accountUpdateResponse
元素的可选子元素,其中包含为提交的银行卡提供更新信息的子元素。
父元素:
属性:
无
子元素:
originalCard 结构
<updatedCard>
<type>Card Type</type>
<number>New Account Number</number>
<expDate>New Expiration Date</expDate>
</updatedCard>
<updatedCard> <type>Card Type</type> <number>New Account Number</number> <expDate>New Expiration Date</expDate> </updatedCard>
updatedCard
元素还可能包含type
、number
和expDate
元素的“N/A”(不适用)值。
updatedToken
updatedToken
元素是 accountUpdateResponse
元素的可选子元素,其中包含为提交的 token 提供更新信息的子元素。
父元素:
属性:
无
子元素:
cnpToken
tokenUrl
expDate
type
bin
updatedToken 结构
<updatedToken>
<cnpToken>New Token Number</cnpToken>
<expDate>New Expiration Date</expDate>
<type>Card Type</type>
<bin> Card BIN </bin>
</updatedToken>
<updatedToken> <cnpToken>New Token Number</cnpToken> <expDate>New Expiration Date</expDate> <type>Card Type</type> <bin> Card BIN </bin> </updatedToken>
updatedToken
元素还可能包含cnpToken
、expDate
和type
元素的“N/A”(不适用)值。
user
user
元素是 authentication
元素的必需子元素。它是用户/商户的独特识别码,用于验证消息是否源自有效来源。
Type = String; minLength = N/A; maxLength = 20
父元素:
属性:
无
子元素:
无