Account Updater elements

The accountUpdate element is the parent element for all Account Updater request transactions. You can use this only with batch transactions.

Parent elements:

batchRequest

Attributes:

Child elements: (Required)

orderId, cardOrToken (allows the substitution of either the cardor token elements)

The accountUpdateFileRequestData element is a child of the RFRRequestelement, required when requesting the response file for an Account Updater submission.

Parent elements:

RFRRequest

Attributes:

None

Child elements:

Required: merchantId

Optional: postDay

accountUpdateFileRequestData Structure

<accountUpdateFileRequestData>
<merchantId>Merchant ID</merchantId>
<postDay>Post Date</postDay>
</accountUpdateFileRequestData>

The accountUpdaterResponse element is the parent element for all Account Updater responses transactions. You can use this only with Batch transactions.

Parent elements:

batchResponse

Attributes:

Child elements: (Required)

cnpTxnId,orderId, response, responseTime, message

Child elements: (Optional)

originalCard, updatedCard, originalToken, updatedToken

The authenticatedShopperID element is an optional child of the accountUpdate element and defines the value of the authenticated customer identifier. This value applies only to merchants submitting Account Update requests on the WPG platform.

Type= String; minLength=1; maxLength=64

Parent elements (optional)

token

Attributes:

None

Child elements

None

The authentication element is a required element of both the cnpOnlineRequest and the batchRequestelements. It contains child elements used to authenticate that the XML message is from a valid user.

Parent elements:

cnpOnlineRequest, cnpRequest

Attributes:

None

Child elements:

Required: user, password

authentication Structure

<authentication>
 <user>User Name</user>
 <password>Password</password>
</authentication>

This is the root element for all cnpAPI Batch requests.

Parent elements:

cnpRequest

Attributes:

There are a number of additional attributes listed in the schema for this element, but you do not need them for Account Updater transactions.

Child elements:

Required: authentication,accountUpdate

The batchResponse element is the parent element for information returned to you in response to a batch you submitted for processing. It is a child of a cnpResponse element.

Parent elements:

cnpResponse

Attributes:

Child elements:

Required: accountUpdateResponse

The bin element provides the 6-digit Bank (or Issuer) Identification Number of the Issuing Bank. The system returns this value in XML responses when issuing new tokens to replace Visa or MasterCard account numbers. For Discover and American Express cards, this element is empty.

Type = String; minLength = 0; maxLength = 6

Parent elements:

The bin element is an optional child of each listed parent element.

See originalToken and updatedToken

Attributes:

None

Child elements:

None

The card element defines payment card information through its child elements.

Parent elements:

accountUpdate

Attributes:

None

Child elements:

Required: type, number, expDate

card Structure - Account Updater

<card>
 <type>Card Type Abbreviation</type>
 <number>Account Number</number>
 <expDate>Expiration Date</expDate>
</card>

The cardOrToken element an abstract that allows the substitution of either the card or token element. You must specify one of the two substitution elements as a child of the accountUpdate element.

Parent elements:

accountUpdate

Substitution Options:

card, token

This is the root element for all cnpAPI Batch requests.

Parent elements:

None

Attributes:

Child elements:

Required: authentication

One of the following required: batchRequest, RFRRequest

This is the root element for all cnpAPI Batch responses.

Parent elements:

None

Attributes:

Child elements:

One of the following required: batchResponse, RFRResponse

The cnpToken element defines the value of the token. The system returns this value in XML responses when issuing new tokens to replace account numbers. The length of the token is the same as the length of the submitted account number.

Type = String; minLength = 13; maxLength = 25

Parent elements:

The cnpToken element is an optional child of each listed parent element.

originalToken, updatedToken

Attributes:

None

Child elements:

None

The cnpTxnId element is used to identify transactions in the system. The system returns this element in XML responses. You use it in various requests to reference the original transaction. For example, when you submit a Capture transaction, you include the cnpTxnId for the associated Authorization.

Type = Long; minLength = N/A; maxLength = 19

Parent elements:

Required: accountUpdateResponse

Attributes:

None

Child elements

None

The expDate element is a child of the card element, which specifies the expiration date of the card and is required for card-not-present transactions.

Type = String; minLength = 4; maxLength = 4

Parent elements:

card, token

Attributes:

None

Child elements:

None

The merchantId element is a child of the accountUpdateFileRequestData element used when you request an Account Update file. This value is a unique string used to identify the merchant within the system.

Type = String; minLength = N/A; maxLength = 50

Parent elements:

accountUpdateFileRequestData

Attributes:

None

Child elements:

None

Several elements use merchantId as an attribute, including batchRequest, batchResponse, and cnpOnlineRequest.

The message element contains a brief definition of the response code returned for the transaction.

For a complete list of response codes and associated messages, please refer to the Worldpay eComm cnpAPI Reference Guide.

Type = String; minLength = N/A; maxLength = 512

Parent elements:

accountUpdateResponse

Attributes:

None

Child elements:

None

The number element is a required child of the card element, used for card-not-present transactions and Account Update transactions. It is also an optional child of the accountInformation element, used in Authorization and Sale responses. It defines the account number associated with the transaction.

Type = String; minLength = 13; maxLength = 25

Parent elements:

card

Attributes:

None

Child elements:

None

The orderId element defines a merchant-assigned value representing the order in the merchant’s system.

Type = String; minLength = N/A; maxLength = 25<

Parent elements:

accountUpdate, accountUpdateResponse

Attributes:

None

Child elements:

None

The originalCard element is an optional child of the accountUpdateResponse element, which contains child elements providing the original information for the submitted card.

Parent elements:

accountUpdateResponse

Attributes:

None

Child elements:

type, number, expDate

originalCard Structure

<originalCard>
 <type>Old Card Type</type>
 <number>Old Account Number</number>
 <expDate>Old Expiration Date</expDate>
</originalCard>

The originalToken element is an optional child of the accountUpdateResponse element, which contains child elements providing the original information for the submitted token.

Parent elements:

accountUpdateResponse

Attributes:

None

Child elements:

cnpToken or tokenUrl, expDate, type, bin

originalToken Structure

<originalToken>
 <cnpToken>Old Token Number</cnpToken>
 <expDate>Old Expiration Date</expDate>
 <type>Old Card Type</type>
 <bin> Old Card BIN </bin>
</originalToken>

The password element is a required child of the authentication element. It is used in combination with the user element to authenticate that the message is from a valid source.

Type = String; minLength = N/A; maxLength = 20

Parent elements:

authentication

Attributes:

None

Child elements:

None

The postDay element is an optional child of the accountUpdateFileRequestData element that defines the date you submitted the Account Updater request. The format is YYYY-MM-DD.

This is also the same date that we created the Account Updater acknowledgment file.

Type = Date; minLength = N/A; maxLength = 10

Parent elements:

accountUpdateFileRequestData

Attributes:

None

Child elements:

None

The response element contains a three digit numeric code which specifies either that the transaction is approved (000 code) or declined. The message element provides a brief definition of the response code.

For a complete list of response codes and associated messages, please refer to Appendix A of the Worldpay eComm cnpAPI Reference Guide .

Type = String; minLength = N/A; maxLength = 3

Parent elements:

accountUpdateResponse

Attributes:

None

Child elements:

None

The responseTime element provides a date/time stamp of the response. The format of the element is YYYY-MM-DDTHH:MM:SS. For example, 2009-12-21T11:37:04.

Type = String; minLength = N/A; maxLength = 19

Parent elements:

accountUpdateResponse

Attributes:

None

Child elements:

None

The RFRRequest element is an optional child of a cnpRequest element. You can use this type of request in one of two ways.

• To request a session response from a previously processed cnpRequest , include the cnpSessionId child. The resulting RFR response will duplicate the original session response associated with the cnpSessionId . The session ID returned in the response will be the session ID of the original session.

• To request an Account Updater completion response file, include the accountUpdateFileRequestData element. If the completion file is ready, it is returned. If the completion file is not ready, you receive an RFR Response message with the response attribute set to 1 and the message attribute reading, “The account Update file is not ready yet. Please try again later.”

Parent elements:

cnpRequest

Attributes:

None

Child elements: (Choice of)

cnpSessionId or accountUpdateFileRequestData

RFRRequest Structure - Batch

<RFRRequest>
 <cnpSessionId>Session ID</cnpSessionId>
</RFRRequest>

RFRRequest Structure - Account Updater

<RFRRequest>
 <accountUpdateFileRequestData>
 <merchantId>Merchant ID</merchantId>
 <postDay>Post Date</postDay>
 </accountUpdateFileRequestData>
</RFRRequest>

The RFRResponse element is an optional child of a cnpResponse element returned in response to a RFRRequest.

Parent elements:

cnpResponse

Attributes:

Child elements:

None

The token element replaces the card element in tokenized transactions and defines the tokenized payment card information.

Parent elements:

accountUpdate

Attributes:

None

Child elements:

Required: cnpToken or tokenUrl

Optional: expDate

The tokenUrl element is an optional child of the token, originalToken, updatedToken elements. You use it to submit the token URL value when submitting an Account Updater request via WPG (Worldpay Gateway). This value must use the following pattern: http.?://./.

Type = String; minLength = N/A; maxLength = 400

• You can only use the tokenURL element in an Account Updater request, when requesting the Account Updater service from WPG.

Parent elements:

updatedToken, originalToken

Attributes:

None

Child elements:

None

This type element defines the type of account used in the transaction in terms of card association, card company, Bill Me Later, or PayPal. From an Account Updater perspective, MC, VI, and DI are the only valid enumerations.

• Please refer to the Worldpay eComm cnpAPI Reference Guide for information about other uses of the type element.

Type = String (Enum); minLength = N/A; maxLength = 2

Parent elements:

originalCard, updatedCard, card, originalToken, updatedToken

Attributes:

None

Child elements:

None

Enumerations:

The updatedCard element is an optional child of the accountUpdateResponse element, which contains child elements providing the updated information for the submitted card.

Parent elements:

accountUpdateResponse

Attributes:

None

Child elements:

type, number, expDate

originalCard Structure

<updatedCard>
 <type>Card Type</type>
 <number>New Account Number</number>
 <expDate>New Expiration Date</expDate>
</updatedCard>

• The updatedCard element may also contain the value of “N/A” for the type, number, and expDate element.

The updatedToken element is an optional child of the accountUpdateResponse element, which contains child elements providing the updated information for the submitted token.

Parent elements:

accountUpdateResponse

Attributes:

None

Child elements:

cnpToken or tokenUrl, expDate, type, bin

updatedToken Structure

<updatedToken>
 <cnpToken>New Token Number</cnpToken>
 <expDate>New Expiration Date</expDate>
 <type>Card Type</type>
 <bin> Card BIN </bin>
</updatedToken>

• The updatedToken element may also contain the value of “N/A” for the cnpToken, expDate, and type elements.

The user element is a required child of the authentication element. It is a unique identifier of the user/merchant used to authenticate that the message is from a valid source.

Type = String; minLength = N/A; maxLength = 20

Parent elements:

authentication

Attributes:

None

Child elements:

None