Schema Changes from V8.1 through V8.33
The table below specifies elements added in schema versions 8.1 through 8.33.
TABLE 1-6 New Elements V8.1 to V8.33
New Element |
Parent of |
Child of |
Comments |
---|---|---|---|
|
|
|
New transaction type for eCheck Redeposit attempts. |
|
|
|
Response message for eCheck Redeposits |
|
|
|
Allows the substitution of either the |
|
|
|
New transaction type to Void an eCheck Sale or halt attempts to auto-Redeposit |
|
|
|
Response message for eCheck Voids |
|
|
|
Used for eCheck Tokenization |
|
|
|
last 3 digits of eCheck account - returned with the token |
|
|
|
Allows the substitution of either the card or token elements |
|
|
|
Used for Account Updater support for tokens |
|
|
|
Used for Account Updater support for tokens |
|
|
|
Added for eCheck Tokenization |
|
|
|
Parent of filtering switches |
|
|
|
Used to enable/disable Prepaid Card filtering per transaction depending upon configuration and value submitted. Enum Values:
|
|
|
|
Used to disable International Card filtering per transaction. |
|
|
|
Indicates whether the Prepaid card is reloadable |
|
|
|
Indicates the type of Prepaid card used. For example, Teen, Gift, Payroll, etc. |
|
|
|
Indicates the country of the Issuing bank. |
|
|
|
Indicates the type of card. Enum Values: UNKNOWN COMMERCIAL CONSUMER |
|
|
Added the following added in V8.7:
|
Used to submit the Pay Page Registration ID with the Authorization or Sale transaction. The response message contains the token associated with the submitted ID. |
|
|
|
Generated by interaction with the Worldpay eProtect and used as a substitute for the token in the initial Authorization or Sale transaction. You can also use this element in a Register Token request to obtain a token in advance of submitting an Authorization or Sale transaction. |
Note: This element already existed as a child of the eCheck response messages. New parents and children are in bold type. |
|
|
Used to provide info about automatic NOC updates. (New) Used to provide updated card/token numbers in response messages - associated with the Automatic Account Updater service. |
|
|
|
|
|
|
|
Extended Response Code returned with accountUpdater information, if applicable. Value is either 501 (Account was closed.) or 504 (Contact the cardholder for updated information.) |
|
|
|
Contains child elements providing the updated information for the submitted card. |
|
|
|
Contains child elements providing the updated token information for the submitted token. |
|
|
|
Contains child elements providing the updated token information for eCheck transactions. |
|
|
|
Contains child elements providing the original information for the updated card. |
|
|
|
Contains child elements providing the original token information for the updated token. |
|
|
|
Contains child elements providing the updated token information for eCheck transactions. |
|
|
|
|
|
|
|
|
|
|
|
Provides the recommended date/time to recycle the declined Authorization/Sale. |
|
|
|
Signifies the end of the recycling advice. |
|
|
|
|
|
|
|
Used to sort transactions by marketing campaign |
|
|
|
Used to sort transactions by affiliate sales |
|
|
|
Used to sort transactions by merchant designated values |
|
|
|
Used by MCC9311 merchants to designate Tax Billing or Convenience Fee |
|
|
|
Only allowed value: SUSPECT_FRAUD |
|
|
|
|
|
|
|
Used to indicate who merchant or Worldpay) controls recycling of the transaction should it be declined. Also determines where the transaction is counted for the purposes of A/B testing. |
|
|
|
Can be used as an alternate to |
|
|
|
|
|
|
|
Only allowed value: SUSPECT_FRAUD When you include this optional element in an authReversal transaction, the information will be forwarded to MasterCard as part of the MasterCard eCommerce Fraud Alert program. When you include this optional element in an credit transaction, the Worldpay eComm system uses the information to track potentially fraudulent transactions for future analysis |
|
|
|
Set to true to disable all filtering for the submitted transaction. This setting take precedence over all other filter override settings. NOTE: This element is available only if you are using cnpAPI schema version 8.13 or above. |
|
|
|
The parent element for the transaction type used to update a CVV2/CVC2/CID code stored temporarily on the Worldpay eComm platform. |
|
|
|
The parent element for the Worldpay response to updateCardValidationNum OnToken transactions. |
|
|
|
The merchantData element was already a child of a number of transaction types (see merchantData), but was added to these eCheck transactions in V8.15. |
|
|
|
Contains a child element providing the Vantiv transaction Id of an associated credit transaction (see below). |
|
|
|
The Vantiv transaction Id of the credit transaction automatically issued by the system when you use a Void transaction to halt the Recycling Engine, but the transaction is already approved and captured. (Auto-refund option must be enabled.) |
|
|
authReversal
|
Use of the surchargeAmount element applies to Visa or MasterCard credit card payments only. Also, you are required to notify the card networks and Worldpay of your intent to applying surcharges at least 30 days prior to implementing the surcharges. Please consult your Worldpay Relationship Manager if you have additional questions. |
|
|
|
Optional field for inclusion of POS Terminal Id. |
|
|
|
The |
|
|
|
The parent for the transaction type that activates a Private Label Gift Card. |
|
|
|
The parent of a response message for an activate transaction. |
|
|
|
The parent for the transaction type that reverses the activation of a Private Label Gift Card. This transaction type is Online only. |
activateReversalRes ponse |
|
|
The parent of a response message for an activateReversal transaction. |
|
|
|
The parent for the transaction type that queries the available balance of a Private Label Gift Card. |
|
|
|
The parent of a response message for an balanceInquiry transaction. |
|
|
|
The parent for the transaction type that deactivates a Private Label Gift Card. |
|
|
|
The parent of a response message for an deactivate transaction. |
|
|
|
The parent for the transaction type that reverses the deactivation of a Private Label Gift Card. This transaction type is Online only. |
|
|
|
The parent of a response message for an deactivateReversal transaction. |
|
|
|
The parent for the transaction type that adds funds to a Private Label Gift Card. |
|
|
|
The parent of a response message for a load transaction. |
|
|
|
The parent for the transaction type that reverses the loading of a Private Label Gift Card. This transaction type is Online only. |
|
|
|
The parent of a response message for a loadReversal transaction. |
|
|
|
The parent for the transaction type that removes funds from a a Private Label Gift Card. |
|
|
|
The parent of a response message for an unload transaction. |
|
|
|
The parent for the transaction type that reverses the unloading of a Private Label Gift Card. This transaction type is Online only. |
|
|
|
The parent of a response message for an unloadReversal transaction. |
|
|
|
Parent of child elements defining the Virtual Gift Card BIN and number length. |
|
|
|
Defines the length of the Virtual Gift Card number. The value must be an integer between 13 and 25. |
|
|
virtualGiftCard |
Defines the BIN of the Virtual Gift Card. The value cannot exceed 10 digits. |
|
|
|
Parent of child elements defining the Virtual Gift Card account number and validation number. |
|
|
|
Provides details about the beginning, ending, and available balance on a Gift Card, as well as the cash back amount, if applicable. |
|
|
|
Defines the funds available on the Private Label Gift Card prior to the transaction. |
|
|
|
Defines the funds available on the Private Label Gift Card after the transaction. |
|
|
|
Defines the funds returned to the user in the form of cash. |
|
|
|
The parent for the transaction type that creates payment plans. |
|
|
|
The parent of a response message for an createPlan transaction. |
|
|
|
The parent for the transaction type that you use to activate/defective a Plan. Deactivating a Plan has no effect on existing Subscription that use the Plan, but prevents the use of the Plan with new subscriptions. |
|
|
|
The parent of a response message for an updatePlan transaction. |
|
|
|
The parent for the transaction that updates the subscription information associated with a recurring payment. Using this transaction type you can change the Plan, card, billing information, and/or billing date. You can also create, update, or delete a Discount and/or an Add On. |
|
|
|
The parent of a response message for an updateSubscription transaction. |
|
|
|
The parent for the transaction that cancels a Subscription. |
|
|
|
The parent of a response message for an |
|
|
|
The parent of several child elements that define the number of payments and plan type of recurring transaction to be handled by the Worldpay Recurring Engine. |
|
|
|
The parent element providing information in response to a |
|
|
|
A response code related to a recurring request. |
|
|
|
The text message associated with the response code. |
|
|
|
The parent of several child elements that define the number of payments and plan type of recurring transaction to be handled by the Worldpay Recurring Engine. |
|
|
|
A Worldpay assigned identifier of the created Subscription. |
|
|
|
A merchant assigned code for a particular Plan. |
|
|
|
A flag to activate or deactivate a Plan. Deactivating a Plan has no effect on existing Subscription that use the Plan, but prevents the use of the Plan with new subscriptions. Valid values are true or false. |
|
|
|
Used to define a new date for the recurring billing when the scheduled date need to be changed. |
|
|
|
The parent element for elements that define a new Discount applied to a Subscription. |
|
|
|
The parent element for elements that define updates to an existing Discount applied to a Subscription. |
|
|
|
The parent element used to delete a Discount associated with a Subscription. |
|
|
|
The parent element for elements that define a new Add On applied to a Subscription. |
|
|
|
The parent element for elements that define updates to an existing Add On applied to a Subscription. |
|
|
|
The parent element used to delete an Add On associated with a Subscription. |
|
|
|
Parent of the |
|
|
|
A unique value assigned by the merchant used to retrieve the data analysis results from by ThreatMetrix. |
|
|
|
The parent of elements that provide the results of the ThreatMetrix analysis. |
|
|
|
The status resulting from the analysis of the data collected by ThreatMetrix compared to the threshold settings of the merchant profile. Possible values are: pass, fail, review, and unavailable. |
|
|
|
The score resulting from a comparison of the collected data against the threshold settings of the merchant profile. Valid values are between -100 and 100. |
|
|
|
Used only for CAT transactions, the value must be: self service. |
triggeredRule |
|
|
A triggered rule is one where the threshold is exceeded. The element can appear multiple times in the response, once for each triggered rule from the ThreatMetrix policy. |
|
|
|
Allows you to retrieve the Advanced Fraud results without introducing a Authorization or Sale transactions |
|
|
|
Parent element for information related to Mobile POS transactions. |
|
|
|
Defines the key serial number returned from the encrypting device. |
|
|
|
Define the format of the encrypted track returned from the encrypting device. |
|
|
|
The encrypted track data. |
|
|
|
Indicates if the Mobile POS device read the track 1 data. |
|
|
|
Indicates if the Mobile POS device read the track 1 data. |
|
|
|
Used to support MasterPass transactions. |
|
|
|
Defines the source of the transaction information. The only allowed value is MasterPass. |
|
|
|
The Id value returned from the MasterPass service. |
|
|
authorization capture credit captureGivenAuth echeckCredit echeckSale forceCapture sale |
Defines the principal portion of the total amount when a convenience fee applied to the transaction by the merchant. for example, if the total charge is $105, with the principal amount being $100 and the convenience fee being $5, you must use $100 as the value for the secondaryAmount element. Supply the value in cents without a decimal point. For example, a value of 400 signifies $4.00. |
|
|
|
Used, when the merchant does not decrypt the PKPaymentToken, to designate Apple Pay as the method of payment and supply the components of the PKPaymentToken. |
|
|
|
The payment data dictionary, BASE64 encoded string from the PKPaymentToken. |
|
|
|
|
|
|
|
Provides the SHA-256 hash, hex encoded string of the original PKPaymentRequest of the Apple Pay transaction. |
|
|
|
Provides the BASE64 Encoded string of the ephemeral public key bytes from the Apple Pay transaction. |
|
|
|
Provides the BASE64 Encoded string that is a hash of the merchant’s certificate public key bytes associated with the Apple Pay transaction. |
|
|
|
Provides the hexadecimal transaction identifier generated on the device for an Apple Pay transaction. |
|
|
|
The BASE64 encoded string signature of the payment and header data from the PKPaymentToken. |
|
|
|
Provides version information about the payment token. |
|
|
|
Includes information about the Apple Pay transaction. |
|
|
|
Defines the primary account number associated with the application. |
|
|
|
Defines expiration date of the application primary account number. |
|
|
|
The 3-character code for the currency used in the transaction. |
|
|
|
The amount of the transaction. |
|
|
|
The name of the cardholder. |
|
|
|
Defines the manufacturer of the device originating the transaction. |
|
|
|
Specifies the data type of the payment data associated with an Apple Pay transaction. |
|
|
|
Specifies the BASE64 Encoded signature cryptogram associated with the Apple Pay transaction. |
|
|
|
Specifies electronic commerce indicator associated with an Apple Pay/Google Pay transaction. |
|
|
|
You use this element to define a Visa transaction is intended to fund a host-based prepaid product, a brokerage account, or an escrow account. Other enum values used for card on file transactions. |
|
|
|
Returned in response messages for Visa, MasterCard, and Discover transactions. Store the value to use in later recurring, installment, or card on file transactions. |
|
|
|
For Visa and Discover, include this element for recurring, installment, and card on file (after initial) transactions. |
|
|
|
For Discover, include this element for recurring payments (after initial) involving network tokens. Note: Not used at this time. |
|
|
|
Must be present when the marketplace and retailer are not in the same region (country). A value of 'F' indicates that the retailer is located in a different country. |
|
|
|
Required if you submit an Incremental Authorization, used by certain Travel and Entertainment (T&E) merchants. when final purchase amounts are unknown. |
Other schema changes:
-
If you are enabled for American Express Advanced AVS, you can use the
customerIpAddress
element (child ofcardholderAuthentication
element) to submit the customer IP Address. At this time, American Express does not validate the IP Address. -
Merchant initiate Authorization Reversals are supported for American Express transactions.
-
Three new country codes were added to the list of enumerations for the
country
element. The new codes are: BQ (Bonaire, Saint Eustatius and Saba), CW (Curacao), and SX (Dutch part od Sint Maarten). -
The
redepositCount
element was removed from theecheckRedepositResponse
. You can determine the redeposit count via the User Interface. This element was in schema version 8.1 only. It is not listed in the table above. -
New enumeration value,
recurringtel
, added to theorderSource
element. This enumeration is used only for eCheck recurring transactions initiated by telephone. -
The
maxDigits
for amount element changed from 8 to 12. -
The
cardNumValidation
element was added to the Register Token Request transaction (registerTokenRequest
). -
For CAT (Cardholder Activated Terminal) transactions, the capability element must be set to magstripe, the
cardholderId
element must be set to nopin, and thecatLevel
element must be set to self service. -
New enumeration for
<orderSource>,
echeckppd
. Use this value for eCheck PPD transactions (Prearranged Payment and Deposit Entries). This type of transaction occurs when a merchants receives a written authorization, including a voided paper check, from a consumer so that the merchant can debit the consumer account. These transactions can be single entry or recurring debits to a consumer's account. -
New enumeration for
<orderSource>
,applepay
. Use this value for Apple Pay transactions. -
Change in
maxLength
of theauthenticationValue
element - from 32 to 56 characters. -
New enumerations added to the
processingType
element to support recurring and installment card on file transactions. The new enumerations are: initialRecurring, and initialInstallment. -
New enumerations added to the
processingType
element to support card on file transactions. The new enumerations are: initialCOF, merchantInitiatedCOF, and cardholderInitiatedCOF.