WorldPay Secure Net Auth Retail Transaction UML


Added On:  06/01/16 
Module:  UniCharge 
Type:  Entity  Status:  Active 
Java Class:  WorldPaySecureNetAuthRetailTransaction 
WorldPay Secure Net specific low-level representation of Retail Transaction produced by Forward Transformation Process within Authorization Process.
During Generation Process, WorldPay Secure Net specific interchange message is generated from this object for authorization. Consequently, all fields of the object are mapped into message segments/elements.
Added On:  07/01/16
SQL Column:  
Java Field:  accountNumber
Status:  Active
SQL Type:  
Java Type:  String
Attributes: Transient
Account number of the customer.
Added On:  06/30/16
SQL Column:  ACCOUNT_TYPE
Java Field:  accountType
Status:  Active
SQL Type:  varchar(20)
Java Type:  String
Attributes:
Type of customer's account.
Added On:  06/01/16
SQL Column:  ADDITIONAL_AMOUNT
Java Field:  additionalAmount
Status:  Active
SQL Type:  varchar(16)
Java Type:  String
Attributes:
Remaining balance on a stored value account.
Added On:  06/01/16
SQL Column:  ALLOW_PARTIAL_CHANGES
Java Field:  allowPartialChanges
Status:  Active
SQL Type:  varchar(5)
Java Type:  String
Attributes:
Indicates whether it is permissible to authorize less than the total balance available on a prepaid card.
Added On:  06/01/16
SQL Column:  AMOUNT
Java Field:  amount
Status:  Active
SQL Type:  varchar(16)
Java Type:  String
Attributes:
Amount of the transaction.
Added On:  07/14/16
SQL Column:  AMOUNT_RESPONSE
Java Field:  amountResponse
Status:  Active
SQL Type:  varchar(16)
Java Type:  String
Attributes:
Added On:  06/01/16
SQL Column:  AUTHORIZATION_CODE
Java Field:  authorizationCode
Status:  Active
SQL Type:  varchar(6)
Java Type:  String
Attributes:
Authorization approval code.
Added On:  06/01/16
SQL Column:  AUTHORIZED_AMOUNT
Java Field:  authorizedAmount
Status:  Active
SQL Type:  varchar(16)
Java Type:  String
Attributes:
The total authorized amount for the authorization request. If the Partial authorization flag is enabled, this amount may be less than the requested amount.
Added On:  06/01/16
SQL Column:  AVS_CODE
Java Field:  avsCode
Status:  Active
SQL Type:  varchar(1)
Java Type:  String
Attributes:
Address verification code. Refer to the specification of the provider for additional information.
Added On:  06/01/16
SQL Column:  AVS_RESULT
Java Field:  avsResult
Status:  Active
SQL Type:  varchar(12)
Java Type:  String
Attributes:
Address verification result.

Possible values:
  • MATCH
  • NOT_MATCHED
  • NOT CHECKED
Added On:  07/01/16
SQL Column:  
Java Field:  back
Status:  Active
SQL Type:  
Java Type:  String
Attributes: Transient
Base64-encoded image of the back of the check in BMP/JPG/PNG format; optional.
Added On:  06/01/16
SQL Column:  CARD_CODE_CODE
Java Field:  cardCodeCode
Status:  Active
SQL Type:  varchar(1)
Java Type:  String
Attributes:
Card security code result.

Possible values:
  • 0 - CVV/CID not provided
  • M - Match
  • N - No match
  • P - Not processed
  • S - Data not present
  • U - Issuer unable to process request
  • Y - Card code matches (Amex only)
Added On:  06/01/16
SQL Column:  CARD_CODE_RESULT
Java Field:  cardCodeResult
Status:  Active
SQL Type:  varchar(12)
Java Type:  String
Attributes:
Card security code result.

Possible values:
  • MATCH
  • NOT_MATCH
  • NOT_CHECKED
Added On:  06/01/16
SQL Column:  CARD_NUMBER
Java Field:  cardNumber
Status:  Active
SQL Type:  varchar(24)
Java Type:  String
Attributes:
Last 4 digits of the credit card number.
Format: XXXXXXXXXXXX 3456.
Added On:  06/01/16
SQL Column:  CASH_BACK_AMOUNT
Java Field:  cashBackAmount
Status:  Active
SQL Type:  varchar(16)
Java Type:  String
Attributes:
Typically used as an optional field for PIN Debit processing. The value of cashBackAmount indicates the amount in cash to be given back to the customer during card processing.
Added On:  06/01/16
SQL Column:  CHARGE_TRANSACTION_FK
Java Field:  chargeTransaction
Status:  Active
SQL Type:  bigint(20)
Java Type:  Long
References Charge Transaction
Attributes:
Reference to the entity that represents real-time financial transaction.
Added On:  07/01/16
SQL Column:  CHECK_NUMBER
Java Field:  checkNumber
Status:  Active
SQL Type:  varchar(15)
Java Type:  String
Attributes:
Check number.
Added On:  07/01/16
SQL Column:  CHECK_TYPE
Java Field:  checkType
Status:  Active
SQL Type:  varchar(32)
Java Type:  String
Attributes:
Type of check payment being made.
Added On:  06/01/16
SQL Column:  CITY
Java Field:  city
Status:  Active
SQL Type:  varchar(40)
Java Type:  String
Attributes:
City where address is located.
Added On:  06/01/16
SQL Column:  COMPANY
Java Field:  company
Status:  Active
SQL Type:  varchar(50)
Java Type:  String
Attributes:
Company name.
Added On:  06/01/16
SQL Column:  COUNTRY
Java Field:  country
Status:  Active
SQL Type:  varchar(2)
Java Type:  String
Attributes:
Country code. US is set by default.
Added On:  06/01/16
SQL Column:  CREDIT_CARD_TYPE
Java Field:  creditCardType
Status:  Active
SQL Type:  varchar(16)
Java Type:  String
Attributes:
Identifies the credit card type.

Possible values:
  • VISA
  • VISAFLEET
  • MASTERCARD
  • MASTERCARDFLEET
  • AMEX
  • DISCOVER
Added On:  06/01/16
SQL Column:  CURRENT_INSTALLMENT
Java Field:  currentInstallment
Status:  Active
SQL Type:  varchar(2)
Java Type:  String
Attributes:
Current installment number. Required if transactionCategory is set as installment.
Added On:  06/01/16
SQL Column:  CUSTOMER_ID
Java Field:  customerId
Status:  Active
SQL Type:  varchar(10)
Java Type:  String
Attributes:
Unique customer identifier.
Added On:  06/01/16
SQL Column:  
Java Field:  cvv
Status:  Active
SQL Type:  
Java Type:  String
Attributes: Transient
Card security code.
Added On:  06/01/16
SQL Column:  DEVELOPER_ID
Java Field:  developerId
Status:  Active
SQL Type:  varchar(8)
Java Type:  String
Attributes:
Developer ID of integrator assigned by SecureNet.
Added On:  06/15/16
SQL Column:  DUTY_AMOUNT
Java Field:  dutyAmount
Status:  Active
SQL Type:  varchar(16)
Java Type:  String
Attributes:
Duty amount included in the transaction.
Added On:  06/01/16
SQL Column:  EMAIL
Java Field:  email
Status:  Active
SQL Type:  varchar(50)
Java Type:  String
Attributes:
Email address used to send notifications.
Added On:  06/01/16
SQL Column:  
Java Field:  expirationDate
Status:  Active
SQL Type:  
Java Type:  String
Attributes: Transient
Expiration date of the credit card.
Added On:  06/01/16
SQL Column:  FIRST_NAME
Java Field:  firstName
Status:  Active
SQL Type:  varchar(50)
Java Type:  String
Attributes:
First name of the account holder.
Added On:  06/15/16
SQL Column:  FREIGHT_AMOUNT
Java Field:  freightAmount
Status:  Active
SQL Type:  varchar(16)
Java Type:  String
Attributes:
Freight amount included in the transaction.
Added On:  07/01/16
SQL Column:  
Java Field:  front
Status:  Active
SQL Type:  
Java Type:  String
Attributes: Transient
Base64-encoded image of the front of the check in BMP/JPG/PNG format; optional.
Added On:  06/01/16
SQL Column:  GRATUITY_AMOUNT
Java Field:  gratuityAmount
Status:  Active
SQL Type:  varchar(16)
Java Type:  String
Attributes:
Amount of the tip.
Added On:  06/01/16
SQL Column:  ID
Java Field:  id
Status:  Active
SQL Type:  bigint(20)
Java Type:  Long
Identifier / Primary Key
Attributes: Unique, Required, CreateOnly, ReadOnly
Identifier of the object used for references; auto-incremented integer value.
Added On:  06/01/16
SQL Column:  INDUSTRY_SPECIFIC_DATA
Java Field:  industrySpecificData
Status:  Active
SQL Type:  varchar(1)
Java Type:  String
Attributes:
Industry-specific data for ecommerce and moto transactions.

For eCommerce transactions:
  • P - Physical goods
  • D - Digital goods

For Moto transactions:
  • 1 - Single purchase transaction (AVS is required)
  • 2 - Recurring billing transaction (do not submit AVS)
  • 3 - Installment transaction
Added On:  06/01/16
SQL Column:  
Java Field:  ksn
Status:  Active
SQL Type:  
Java Type:  String
Attributes: Transient
Unaltered KSN Number from PIN pad. (Debit only.)
Added On:  06/01/16
SQL Column:  LAST_NAME
Java Field:  lastName
Status:  Active
SQL Type:  varchar(50)
Java Type:  String
Attributes:
Last name of the account holder.
Added On:  06/17/16
SQL Column:  LEVEL2_VALID
Java Field:  level2Valid
Status:  Active
SQL Type:  varchar(5)
Java Type:  String
Attributes:
Indicates whether the credit card is level 2 eligible.
Added On:  06/17/16
SQL Column:  LEVEL3_VALID
Java Field:  level3Valid
Status:  Active
SQL Type:  varchar(5)
Java Type:  String
Attributes:
Indicates whether the credit card is level 3 eligible.
Added On:  06/01/16
SQL Column:  LINE1
Java Field:  line1
Status:  Active
SQL Type:  varchar(60)
Java Type:  String
Attributes:
Street address of the account holder.
Added On:  06/01/16
SQL Column:  MERCHANT_ACCOUNT_CODE
Java Field:  merchantAccountCode
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes: Required
Code of Merchant Account to which instance of this object is attributed to. Depending on the context, Merchant Account Code field may contain either Merchant Code or Merchant Account Code.
The field is primarily used for data partitioning and data management, to make it easy to determine the ownership of a record within the database.
Added On:  06/01/16
SQL Column:  MESSAGE
Java Field:  message
Status:  Active
SQL Type:  varchar(300)
Java Type:  String
Attributes:
Text description of the response.
Added On:  06/01/16
SQL Column:  METHOD
Java Field:  method
Status:  Active
SQL Type:  varchar(7)
Java Type:  String
Attributes:
Transaction method.

Possible values:
  • CC - Credit Card
  • DB - Debit
  • ECHECK - Electronic Check
  • PD - Pinless Debit
  • SV - Stored Value
Added On:  06/01/16
SQL Column:  NETWORK_CODE
Java Field:  networkCode
Status:  Active
SQL Type:  varchar(10)
Java Type:  String
Attributes:
Identifier for the network that returned the transaction response.
Added On:  06/01/16
SQL Column:  NOTES
Java Field:  notes
Status:  Active
SQL Type:  varchar(100)
Java Type:  String
Attributes:
Notes (any additional information) about the record.
Added On:  06/01/16
SQL Column:  
Java Field:  number
Status:  Active
SQL Type:  
Java Type:  String
Attributes: Transient
Credit card account number.
Added On:  06/15/16
SQL Column:  ORDER_DATE
Java Field:  orderDate
Status:  Active
SQL Type:  varchar(14)
Java Type:  String
Attributes:
Date of the transaction.
Added On:  06/01/16
SQL Column:  ORDER_ID
Java Field:  orderId
Status:  Active
SQL Type:  varchar(25)
Java Type:  String
Attributes:
Client-generated unique ID for each transaction, used as a way to prevent the processing of duplicate transactions. The orderId must be unique to the merchant's SecureNet ID, but uniqueness is only evaluated for approved transactions and only for the last 30 days. If a transaction is declined, the corresponding orderId may be used again.

The orderId is limited to 25 characters; e.g., “CUSTOMERID MMddyyyyHHmmss”.
Added On:  06/01/16
SQL Column:  PAYMENT_TYPE_CODE
Java Field:  paymentTypeCode
Status:  Active
SQL Type:  varchar(3)
Java Type:  String
Attributes:
Credit card or check type. Valid values can be found in the specification of the provider.
Added On:  06/01/16
SQL Column:  PAYMENT_TYPE_RESULT
Java Field:  paymentTypeResult
Status:  Active
SQL Type:  varchar(12)
Java Type:  String
Attributes:
Transaction method.

Possible values:
  • CHECK
  • CREDIT_CARD
  • DEBIT_CARD
  • FLEET_CARD
  • UNKNOWN
Added On:  06/01/16
SQL Column:  PHONE
Java Field:  phone
Status:  Active
SQL Type:  varchar(25)
Java Type:  String
Attributes:
Phone number used to discuss any processing issues.
Added On:  06/01/16
SQL Column:  
Java Field:  pinBlock
Status:  Active
SQL Type:  
Java Type:  String
Attributes: Transient
PINblock obtained from the PIN pad. (Debit only.)
Added On:  06/15/16
SQL Column:  PURCHASE_ORDER
Java Field:  purchaseOrder
Status:  Active
SQL Type:  varchar(25)
Java Type:  String
Attributes:
Purchase order number associated with the transaction.
Added On:  06/17/16
SQL Column:  REQUEST_DATE_TIME
Java Field:  requestDateTime
Status:  Active
SQL Type:  varchar(25)
Java Type:  String
Attributes:
Date and time of the sent request.
Added On:  06/15/16
SQL Column:  REQUEST_TYPE
Java Field:  requestType
Status:  Active
SQL Type:  varchar(12)
Java Type:  String
Attributes:
Type of the sent request.
Added On:  06/01/16
SQL Column:  RESPONSE_CODE
Java Field:  responseCode
Status:  Active
SQL Type:  varchar(1)
Java Type:  String
Attributes:
Response code for the method call. A value of 1 indicates the customer was created.
Added On:  06/01/16
SQL Column:  RESPONSE_DATE_TIME
Java Field:  responseDateTime
Status:  Active
SQL Type:  varchar(25)
Java Type:  String
Attributes:
Date and time of the transaction response.
Added On:  06/01/16
SQL Column:  RESPONSE_TEXT
Java Field:  responseText
Status:  Active
SQL Type:  varchar(100)
Java Type:  String
Attributes:
Transaction approval status.
Added On:  06/01/16
SQL Column:  RESULT
Java Field:  result
Status:  Active
SQL Type:  varchar(25)
Java Type:  String
Attributes:
Result of the method call.
Added On:  06/15/16
SQL Column:  RETAIL_LANE_NUMBER
Java Field:  retailLaneNumber
Status:  Active
SQL Type:  varchar(4)
Java Type:  String
Attributes:
Lane number at which the transaction was completed in a retail environment.
Added On:  06/01/16
SQL Column:  RETAIL_TRANSACTION_CYCLE_FK
Java Field:  retailTransactionCycle
Status:  Active
SQL Type:  bigint(20)
Java Type:  Long
Attributes:
Reference to the entity that represents a group of real-time transactions which must be settled together.
Added On:  07/01/16
SQL Column:  
Java Field:  routingNumber
Status:  Active
SQL Type:  
Java Type:  String
Attributes: Transient
Routing number (expiration date) of the customer's bank account.
Added On:  06/01/16
SQL Column:  
Java Field:  secureKey
Status:  Active
SQL Type:  
Java Type:  String
Attributes: Transient
Secure key used in conjunction with Secure Net ID to access the processor's gateway.
Added On:  06/01/16
SQL Column:  SECURE_NET_ID
Java Field:  secureNetId
Status:  Active
SQL Type:  varchar(8)
Java Type:  String
Attributes:
SecureNet ID assigned by WorldPay.
Added On:  06/01/16
SQL Column:  SERVER
Java Field:  server
Status:  Active
SQL Type:  varchar(6)
Java Type:  String
Attributes:
Server number (used in restaurant transactions).
Added On:  06/01/16
SQL Column:  SETTLEMENT_DATA_AMOUNT
Java Field:  settlementDataAmount
Status:  Active
SQL Type:  varchar(16)
Java Type:  String
Attributes:
Amount of the transaction.
Added On:  06/01/16
SQL Column:  SETTLEMENT_DATA_BATCH_ID
Java Field:  settlementDataBatchId
Status:  Active
SQL Type:  varchar(15)
Java Type:  String
Attributes:
Identifier for the batch that the transaction belongs to.
Added On:  06/01/16
SQL Column:  SETTLEMENT_DATA_DATE
Java Field:  settlementDataDate
Status:  Active
SQL Type:  varchar(20)
Java Type:  String
Attributes:
Date and time when the transaction was settled.
Added On:  06/01/16
SQL Column:  STATE
Java Field:  state
Status:  Active
SQL Type:  varchar(2)
Java Type:  String
Attributes:
State where address is located. Valid values are 2-character state abbreviations.
Added On:  06/15/16
SQL Column:  STATUS
Java Field:  status
Status:  Active
SQL Type:  varchar(12)
Java Type:  String
Attributes:
Tax status of the transaction.
Added On:  06/17/16
SQL Column:  SUCCESS
Java Field:  success
Status:  Active
SQL Type:  varchar(5)
Java Type:  String
Attributes:
Customer result.
Added On:  06/01/16
SQL Column:  SURCHARGE_AMOUNT
Java Field:  surchargeAmount
Status:  Active
SQL Type:  varchar(16)
Java Type:  String
Attributes:
Surcharge amount to be added to the transaction.
Added On:  06/15/16
SQL Column:  TAX_AMOUNT
Java Field:  taxAmount
Status:  Active
SQL Type:  varchar(16)
Java Type:  String
Attributes:
Tax amount for the transaction.
Added On:  06/01/16
SQL Column:  TOTAL_NUMBER_OF_INSTALLMENTS
Java Field:  totalNumberOfInstallments
Status:  Active
SQL Type:  varchar(2)
Java Type:  String
Attributes:
Total number of installments. Required if transactionCategory is set as installment.
Added On:  06/01/16
SQL Column:  
Java Field:  trackData
Status:  Active
SQL Type:  
Java Type:  String
Attributes: Transient
Data that has been read from the card's magnetic stripe.
Added On:  06/01/16
SQL Column:  TRANSACTION_DUPLICATE_CHECK_INDICATOR
Java Field:  transactionDuplicateCheckIndicator
Status:  Active
SQL Type:  varchar(1)
Java Type:  String
Attributes:
Indicates how checks for duplicate transactions should behave. Duplicates are evaluated on the basis of amount, card number, and order ID; these evaluation criteria can be extended to also include customer ID, invoice number, or a user-defined field.

Possible values:
0 - No duplicate check
1 - Exception code is returned in case of duplicate
2 - Previously existing transaction is returned in case of duplicate
3 - Check is performed as above but without using order ID, and exception code is returned in case of duplicate

The transactionDuplicateCheckIndicator parameter must be enabled in the Virtual Terminal under Tools->Duplicate Transactions. Duplicates are checked only for approved transactions.
Added On:  06/01/16
SQL Column:  TRANSACTION_ID
Java Field:  transactionId
Status:  Active
SQL Type:  varchar(15)
Java Type:  String
Attributes:
Transaction ID of the completed payment.
Added On:  06/01/16
SQL Column:  TRANSACTION_ID_RESPONSE
Java Field:  transactionIdResponse
Status:  Active
SQL Type:  varchar(15)
Java Type:  String
Attributes:
Transaction ID in the response to the transaction.
Added On:  06/01/16
SQL Column:  TRANSACTION_TYPE
Java Field:  transactionType
Status:  Active
SQL Type:  varchar(30)
Java Type:  String
Attributes:
Type of the transaction.
Added On:  06/01/16
SQL Column:  TYPE
Java Field:  type
Status:  Active
SQL Type:  varchar(20)
Java Type:  String
Attributes:
Type of transaction.

Possible values:
  • SINGLE_PURCHASE
  • RECURRING
  • INSTALLMENT
Added On:  06/01/16
SQL Column:  TYPE_OF_GOODS
Java Field:  typeOfGoods
Status:  Active
SQL Type:  varchar(9)
Java Type:  String
Attributes:
Type of goods that are being purchased.

Possible values:
  • DIGITAL
  • PHYSICAL
Added On:  07/01/16
SQL Column:  VERIFICATION
Java Field:  verification
Status:  Active
SQL Type:  varchar(14)
Java Type:  String
Attributes:
Type of check verification that was used for the transaction.
Added On:  06/01/16
SQL Column:  VERSION
Java Field:  version
Status:  Active
SQL Type:  varchar(10)
Java Type:  String
Attributes:
Version number of the integrator's application.
Added On:  06/01/16
SQL Column:  ZIP
Java Field:  zip
Status:  Active
SQL Type:  varchar(9)
Java Type:  String
Attributes:
5- or 9-digit ZIP (or postal) code of the address.