- Home
- All APIs
- Access Worldpay
- Account Updater
- Requests and Responses
- Account Updater elements
Account Updater elements
Each of the following sections define a particular element, its relationship to other elements (parents and children), as well as any attributes associated with the element.
accountUpdater
The accountUpdate element is the parent element for all Account Updater request transactions. You can use this only with batch transactions.
Parent elements:
Attributes:
| Attribute Name | Type | Required? | Description |
|---|---|---|---|
| id | String | Yes | A unique identifier assigned by the presenter and mirrored back in the response. minLength = N/AmaxLength = 25 |
| customerId | String | No | A value assigned by the merchant to identify the consumer. minLength = N/AmaxLength = 50 |
| reportGroup | String | Yes | Required attribute that defines the merchant sub-group in the user interface where this transaction will be displayed. minLength = 1maxLength = 25 |
Child elements: (Required)
orderIdcardOrTokencardor token elements)
accountUpdateFileRequestData
The accountUpdateFileRequestData element is a child of the RFRRequestelement, required when requesting the response file for an Account Updater submission.
Parent elements:
Attributes:
None
Child elements:
Required:
Optional:
accountUpdateFileRequestData Structure
<accountUpdateFileRequestData>
<merchantId>Merchant ID</merchantId>
<postDay>Post Date</postDay>
</accountUpdateFileRequestData><accountUpdateFileRequestData> <merchantId>Merchant ID</merchantId> <postDay>Post Date</postDay> </accountUpdateFileRequestData>accountUpdateResponse
The accountUpdaterResponse element is the parent element for all Account Updater responses transactions. You can use this only with Batch transactions.
Parent elements:
Attributes:
| Attribute Name | Type | Required? | Description |
|---|---|---|---|
| id | String | Yes | The response returns the same value submitted in the accountUpdate transaction. minLength = N/AmaxLength = 25 |
| customerId | String | No | The response returns the same value submitted in the accountUpdate transaction. minLength = N/AmaxLength = 50 |
| reportGroup | String | Yes | The response returns the same value submitted in the accountUpdate transaction. minLength = 1maxLength = 25 |
Child elements: (Required)
cnpTxnIdorderIdresponseresponseTimemessage
Child elements: (Optional)
authenticatedShopperID
The authenticatedShopperID element is an optiojnal child of the accountUpdate element and defines the value of the authenticated shopper 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
authentication
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:
Attributes:
None
Child elements:
authentication Structure
<authentication>
<user>User Name</user>
<password>Password</password>
</authentication><authentication> <user>User Name</user> <password>Password</password> </authentication>batchRequest
This is the root element for all cnpAPI Batch requests.
Parent elements:
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.
| Attribute Name | Type | Required? | Description |
|---|---|---|---|
| id | String | No | A unique string to identify this batchRequest within the system. minLength = N/AmaxLength = 50 |
| numAccountUpdates | Integer | No | Defines the total count of Account Update transactions in the batchRequest. minLength = N/AmaxLength = N/A |
| merchantId | String | Yes | A unique string to identify the merchant within the system. minLength = N/AmaxLength = 50 |
Child elements:
Required:
batchResponse
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:
Attributes:
| Attribute Name | Type | Required? | Description |
|---|---|---|---|
| id | String | No | In the acknowledgment message, the response returns the same value submitted in the batchRequest. This attribute is not returned in the AU completion response message. minLength = N/AmaxLength = 25 |
| cnpBatchId | Long | Yes | A unique value assigned by us to identify the batch. minLength = N/AmaxLength = 19 |
| merchantId | String | Yes | The response returns the same value submitted in the authorization transaction. minLength = 1maxLength = 50 |
Child elements:
Required:accountUpdateResponse
bin
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.
SeeoriginalTokenupdatedToken
Attributes:
None
Child elements:
None
card
The card element defines payment card information through its child elements.
Parent elements:
Attributes:
None
Child elements:
card Structure - Account Updater
<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
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:
Substitution Options:
cnpRequest
This is the root element for all cnpAPI Batch requests.
Parent elements:
None
Attributes:
| Attribute Name | Type | Required? | Description |
|---|---|---|---|
| version | String | Yes | Defines the cnpAPI schema version against which the XML is validated. The current version is 7.3, but you may be using an older version. minLength = N/AmaxLength = 10 |
| xmlns | String | Yes | Defines the URI of the schema definition. This is a fixed location and must be specified as: http://www.vantivcnp.com/schema. minLength = N/AmaxLength = 38 |
| id | String | No | A unique string to identify the session within the system. minLength = N/AmaxLength = 25 |
| numBatchRequests | Integer | Yes | Defines the total number of batchRequest children included in the cnpRequest. If the cnpRequest contains only an RFRRequest, then set this attribute to “0”. |
Child elements:
Required:authentication
One of the following required:
cnpResponse
This is the root element for all cnpAPI Batch responses.
Parent elements:
None
Attributes:
| Attribute Name | Type | Required? | Description |
|---|---|---|---|
| version | String | Yes | Defines the cnpAPI schema version against which we validate the XML message. minLength = N/AmaxLength = 10 |
| id | String | No | The response returns the same value submitted in the authorization transaction. minLength = N/AmaxLength = 25 |
| response | String | Yes | Indicates whether your XML syntax passed validation. Expected values are as follows: 0 - XML validation succeeded. 1 - XML validation failed. See the message attribute for more details. minLength = N/AmaxLength = 3 |
| message | String | Yes | XML validation error message. Expected values are as follows: If the response attribute returns 0, the message attribute returns the text “Valid Format.” If the response attribute returns 1, the message attribute returns an error message that helps you to identify and troubleshoot the syntax problem. minLength = N/AmaxLength = 512 |
| cnpSessionId | Long | Yes | A unique value assigned by us to identify the session. minLength = N/AmaxLength = 19 |
Child elements:
One of the following required:
cnpToken
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.
Attributes:
None
Child elements:
None
cnpTxnId
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 Eeements
None
expDate
merchantId
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:
Attributes:
None
Child elements:
None
Several elements use merchantId as an attribute, including batchRequest, batchResponse, and cnpOnlineRequest.
message
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:
Attributes:
None
Child elements:
None
number
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:
Attributes:
None
Child elements:
None
orderId
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:
accountUpdateaccountUpdateResponse
Attributes:
None
Child elements:
None
originalCard
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:
Attributes:
None
Child elements:
originalCard Structure
<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
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:
Attributes:
None
Child elements:
cnpTokentokenUrlexpDatetypebin
originalToken Structure
<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
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:
Attributes:
None
Child elements:
None
postDay
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:
Attributes:
None
Child elements:
None
response
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:
Attributes:
None
Child elements:
None
responseTime
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:
Attributes:
None
Child elements:
None
RFRRequest
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 thecnpSessionIdchild. The resulting RFR response will duplicate the original session response associated with thecnpSessionId. 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
accountUpdateFileRequestDataelement. 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:
Attributes:
None
Child elements: (Choice of)
cnpSessionId oraccountUpdateFileRequestData
RFRRequest Structure - Batch
<RFRRequest>
<cnpSessionId>Session ID</cnpSessionId>
</RFRRequest><RFRRequest> <cnpSessionId>Session ID</cnpSessionId> </RFRRequest>RFRRequest Structure - Account Updater
<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
The RFRResponse element is an optional child of a cnpResponse element returned in response to a RFRRequest.
Parent elements:
Attributes:
| Attribute Name | Type | Required? | Description |
|---|---|---|---|
| response | String | Yes | The RFR Response Code indicating the result of the RFR request. minLength = N/AmaxLength = 3 |
| message | String | Yes | A brief definition of the response code returned for this transaction. minLength = N/AmaxLength = 512 |
Child elements:
None
token
The token element replaces the card element in tokenized transactions and defines the tokenized payment card information.
Parent elements:
Attributes:
None
Child elements:
Optional:expDate
tokenUrl
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:
Attributes:
None
Child elements:
None
type
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
typeelement.
Type = String (Enum); minLength = N/A; maxLength = 2
Parent elements:
originalCardupdatedCardcardoriginalTokenupdatedToken
Attributes:
None
Child elements:
None
Enumerations:
| Enumeration | Description |
|---|---|
| MC | MasterCard |
| VI | Visa |
| DI | Discover |
updatedCard
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:
Attributes:
None
Child elements:
originalCard Structure
<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>- The
updatedCardelement may also contain the value of “N/A” for thetype,number, andexpDateelement.
updatedToken
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:
Attributes:
None
Child elements:
cnpTokentokenUrlexpDatetypebin
updatedToken Structure
<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>- The
updatedTokenelement may also contain the value of “N/A” for thecnpToken,expDate, andtypeelements.
user
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:
Attributes:
None
Child elements:
None
