EFT Profit Stars Retail Transaction UML


Added On:  08/27/15 
Module:  UniCharge 
Type:  Entity  Status:  Active 
Java Class:  EftProfitStarsRetailTransaction 
Profit Stars specific low-level representation of Retail Transaction produced by Forward Transformation Process within Settlement Process.

During Generation Process, Profit Stars specific interchange message is generated from this object for settlement. Consequently, all fields of the object are mapped into message segments/elements.
Added On:  06/13/16
SQL Column:  
Java Field:  accountNumber
Status:  Active
SQL Type:  
Java Type:  String
Attributes: Transient
Contains the credit card account number which identifies the customer. The account number is left justified with trailing spaces.
Added On:  08/27/15
SQL Column:  ACCOUNT_TYPE
Java Field:  accountType
Status:  Active
SQL Type:  varchar(8)
Java Type:  String
Attributes:
Type of the account.
Added On:  11/11/15
SQL Column:  ACTION
Java Field:  action
Status:  Active
SQL Type:  varchar(32)
Java Type:  String
Attributes:
Type of transaction.
Added On:  08/27/15
SQL Column:  ACTUAL_DATE
Java Field:  actualDate
Status:  Active
SQL Type:  varchar(32)
Java Type:  String
Attributes:
Date and time when the transaction was created.
Added On:  08/27/15
SQL Column:  ADDRESS1
Java Field:  address1
Status:  Active
SQL Type:  varchar(50)
Java Type:  String
Attributes:
Customer’s home or business address.
Added On:  08/27/15
SQL Column:  BILLING_ADDRESS1
Java Field:  billingAddress1
Status:  Active
SQL Type:  varchar(50)
Java Type:  String
Attributes:
Street (line 1) of the billing address.
Added On:  08/27/15
SQL Column:  BILLING_CITY
Java Field:  billingCity
Status:  Active
SQL Type:  varchar(40)
Java Type:  String
Attributes:
City of the billing address.
Added On:  08/27/15
SQL Column:  BILLING_COUNTRY
Java Field:  billingCountry
Status:  Active
SQL Type:  varchar(40)
Java Type:  String
Attributes:
Country of the billing address.
Added On:  08/27/15
SQL Column:  BILLING_PHONE
Java Field:  billingPhone
Status:  Active
SQL Type:  varchar(14)
Java Type:  String
Attributes:
Phone number of the billing address.
Added On:  08/27/15
SQL Column:  BILLING_POSTAL_CODE
Java Field:  billingPostalCode
Status:  Active
SQL Type:  varchar(10)
Java Type:  String
Attributes:
ZIP (or postal) code of the billing address.
Added On:  08/27/15
SQL Column:  BILLING_STATE_REGION
Java Field:  billingStateRegion
Status:  Active
SQL Type:  varchar(40)
Java Type:  String
Attributes:
State or region of the billing address.
Added On:  08/27/15
SQL Column:  CAPTURE_AMOUNT
Java Field:  captureAmount
Status:  Active
SQL Type:  varchar(10)
Java Type:  String
Attributes:
Amount of the authorized transactions to be validated.
Added On:  08/27/15
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 representing real-time financial transaction.
Added On:  08/27/15
SQL Column:  CHECK_NUMBER
Java Field:  checkNumber
Status:  Active
SQL Type:  varchar(17)
Java Type:  String
Attributes:
Check number.
  • Required when PaymentOrigin = Bounced_Check.
  • Should be removed when is a credit card account or CheckMICRLine is included in the request.
Added On:  08/27/15
SQL Column:  CITY
Java Field:  city
Status:  Active
SQL Type:  varchar(40)
Java Type:  String
Attributes:
City where the customer's address is located.
Added On:  08/27/15
SQL Column:  COUNTRY
Java Field:  country
Status:  Active
SQL Type:  varchar(40)
Java Type:  String
Attributes:
Country where the customer's address is located.
Added On:  08/27/15
SQL Column:  CREATE_CUSTOMER_IF_DOES_NOT_EXISTS
Java Field:  createCustomerIfDoesNotExists
Status:  Active
SQL Type:  varchar(1)
Java Type:  String
Attributes:
Indicates whether a new customer account should be created.
Added On:  08/27/15
SQL Column:  CUSTOMER_NUMBER
Java Field:  customerNumber
Status:  Active
SQL Type:  varchar(50)
Java Type:  String
Attributes:
Unique identifier representing a specific customer in the system.

*Required if updateCustomerIfExists is ‘Yes’.
Added On:  08/27/15
SQL Column:  DESCRIPTION
Java Field:  description
Status:  Active
SQL Type:  varchar(50)
Java Type:  String
Attributes:
Optional element used to define or explain the purpose of the transaction.
Added On:  08/27/15
SQL Column:  EFFECTIVE_DATE
Java Field:  effectiveDate
Status:  Active
SQL Type:  varchar(10)
Java Type:  String
Attributes:
Transaction processing date.
Added On:  12/16/15
SQL Column:  EFT_PROFIT_STARS_RETURNS_BATCH_FK
Java Field:  eftProfitStarsReturnsBatch
Status:  Active
SQL Type:  bigint(20)
Java Type:  Long
Attributes:
Reference to the entity representing EFT Profit Stars returns batch file.
Added On:  08/27/15
SQL Column:  EMAIL_ADDRESS
Java Field:  emailAddress
Status:  Active
SQL Type:  varchar(60)
Java Type:  String
Attributes:
Email address for discussing any processing issues.
Added On:  08/27/15
SQL Column:  ENTITY_ID
Java Field:  entityId
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Unique identifier of the merchant in the processor's system. Also referred to as the merchant ID or MID.
Added On:  08/27/15
SQL Column:  ERROR
Java Field:  error
Status:  Active
SQL Type:  varchar(5)
Java Type:  String
Attributes:
Identifies whether the error occured during the transaction processing.
Added On:  12/16/15
SQL Column:  EVENT_DATA_STRING
Java Field:  eventDataString
Status:  Active
SQL Type:  varchar(255)
Java Type:  String
Attributes:
String data of the event (transaction).
Added On:  12/16/15
SQL Column:  EVENT_DATE_TIME
Java Field:  eventDateTime
Status:  Active
SQL Type:  varchar(22)
Java Type:  String
Attributes:
Actual time of the event (transaction).
Added On:  12/16/15
SQL Column:  EVENT_TYPE_NAME
Java Field:  eventTypeName
Status:  Active
SQL Type:  varchar(30)
Java Type:  String
Attributes:
Name of the event type.
Added On:  08/27/15
SQL Column:  FIELD1
Java Field:  field1
Status:  Active
SQL Type:  varchar(50)
Java Type:  String
Attributes:
Optional information associated with a customer. Data is stored with the customer. Indexed field.
Added On:  08/27/15
SQL Column:  FIELD2
Java Field:  field2
Status:  Active
SQL Type:  varchar(50)
Java Type:  String
Attributes:
Optional information associated with a customer.
Added On:  08/27/15
SQL Column:  FIELD3
Java Field:  field3
Status:  Active
SQL Type:  varchar(50)
Java Type:  String
Attributes:
Optional information associated with a customer.
Added On:  08/27/15
SQL Column:  FIRST_NAME
Java Field:  firstName
Status:  Active
SQL Type:  varchar(30)
Java Type:  String
Attributes:
First name of an individual customer.
Added On:  06/13/16
SQL Column:  
Java Field:  host
Status:  Active
SQL Type:  
Java Type:  String
Attributes: Transient
Added On:  08/27/15
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.
Added On:  08/27/15
SQL Column:  IP_ADDRESS_OF_ORIGINATOR
Java Field:  ipAddressOfOriginator
Status:  Active
SQL Type:  varchar(15)
Java Type:  String
Attributes:
IP address of person sending request. May be automatically retrieved.
Added On:  08/27/15
SQL Column:  IS_BUSSINESS_PAYMENT
Java Field:  isBussinessPayment
Status:  Active
SQL Type:  varchar(1)
Java Type:  String
Attributes:
Indicates whether the transaction is ACH only as either drawn on a business or personal account.
Added On:  08/27/15
SQL Column:  IS_COMPANY
Java Field:  isCompany
Status:  Active
SQL Type:  varchar(1)
Java Type:  String
Attributes:
Indicates whether a customer is an individual merchant or a business. The default value of ‘Individual’ will be used if null.
Added On:  08/27/15
SQL Column:  LAST_NAME
Java Field:  lastName
Status:  Active
SQL Type:  varchar(60)
Java Type:  String
Attributes:
Either the last name of an individual customer or the company name on a business account.

Is required if
  • createCustomerIfDoesNotExists OR
  • updateCustomerIfExists = 1.
Added On:  08/27/15
SQL Column:  LOCATION_ID
Java Field:  locationId
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Unique identifier for a location (account) set up under a user.
Added On:  08/27/15
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:  08/27/15
SQL Column:  NAME_ON_ACCOUNT
Java Field:  nameOnAccount
Status:  Active
SQL Type:  varchar(50)
Java Type:  String
Attributes:
Customer’s name as it appears in the account. Is required for SettlementType ACH when PaymentOrigin is Internet (WEB), Telephone_IVR, Telephone_Operator, Signature_Faxed, Signature_Original Corporate_Trade_Exchange.
Added On:  12/16/15
SQL Column:  NOTICE_OF_CHANGE
Java Field:  noticeOfChange
Status:  Active
SQL Type:  varchar(260)
Java Type:  String
Attributes:
Information about NoC transaction.
Added On:  12/16/15
SQL Column:  NOTICE_OF_CHANGE_CODE
Java Field:  noticeOfChangeCode
Status:  Active
SQL Type:  varchar(3)
Java Type:  String
Attributes:
Code of the NoC transaction.
Added On:  08/27/15
SQL Column:  OPERATION_TYPE
Java Field:  operationType
Status:  Active
SQL Type:  varchar(8)
Java Type:  String
Attributes:
Type of the transaction (either a debit or credit). If null, the default value ‘Sale’ is specified.
Added On:  08/27/15
SQL Column:  ORIGINAL_REFERENCE_NUMBER
Java Field:  originalReferenceNumber
Status:  Active
SQL Type:  varchar(20)
Java Type:  String
Attributes:
Reference number assigned to the transaction to be captured (with an OperationType of ‘Auth’).
Added On:  08/27/15
SQL Column:  ORIGINATED_AS
Java Field:  originatedAs
Status:  Active
SQL Type:  varchar(24)
Java Type:  String
Attributes:
Identifies the transaction type.
Added On:  08/27/15
SQL Column:  PAYMENT_ORIGIN
Java Field:  paymentOrigin
Status:  Active
SQL Type:  varchar(18)
Java Type:  String
Attributes:
Identifies the method the transaction was originated. If not included in the request, the default value ‘Internet’ is specified.
Added On:  08/27/15
SQL Column:  POSTAL_CODE
Java Field:  postalCode
Status:  Active
SQL Type:  varchar(10)
Java Type:  String
Attributes:
ZIP (or postal) code of the customer's address.
Added On:  08/27/15
SQL Column:  RECURRING_PAYMENT_ORIGIN
Java Field:  recurringPaymentOrigin
Status:  Active
SQL Type:  varchar(18)
Java Type:  String
Attributes:
Identifies the method the recurring transaction was originated. If not included in the request, the default value ‘Internet’ is specified.
Added On:  08/27/15
SQL Column:  REFERENCE_NUMBER
Java Field:  referenceNumber
Status:  Active
SQL Type:  varchar(20)
Java Type:  String
Attributes:
The reference number assigned to the transaction.
Added On:  08/27/15
SQL Column:  RESPONSE_CODE
Java Field:  responseCode
Status:  Active
SQL Type:  varchar(30)
Java Type:  String
Attributes:
Gateway generated response code.
Added On:  08/27/15
SQL Column:  RESPONSE_MESSAGE
Java Field:  responseMessage
Status:  Active
SQL Type:  varchar(255)
Java Type:  String
Attributes:
Gateway generated response message explaining the correspoding response code.
Added On:  08/27/15
SQL Column:  RETAIL_TRANSACTION_CYCLE_FK
Java Field:  retailTransactionCycle
Status:  Active
SQL Type:  bigint(20)
Java Type:  Long
Attributes:
Reference to the entity representing a group of real-time transactions that must be settled together.
Added On:  12/16/15
SQL Column:  RETURN_CODE
Java Field:  returnCode
Status:  Active
SQL Type:  varchar(3)
Java Type:  String
Attributes:
Code of the returns transaction.
Added On:  12/16/15
SQL Column:  RETURN_DESCRIPTION
Java Field:  returnDescription
Status:  Active
SQL Type:  varchar(255)
Java Type:  String
Attributes:
Short description of the returns transaction reason.
Added On:  06/13/16
SQL Column:  
Java Field:  routingNumber
Status:  Active
SQL Type:  
Java Type:  String
Attributes: Transient
Bank routing/transit or ABA number.
Added On:  08/27/15
SQL Column:  SETTELMENT_STATUS
Java Field:  settelmentStatus
Status:  Active
SQL Type:  varchar(30)
Java Type:  String
Attributes:
The settelment status.
Do NOT include this element in your request. The appropriate value will be set by the processor.
Added On:  08/27/15
SQL Column:  STATE_REGION
Java Field:  stateRegion
Status:  Active
SQL Type:  varchar(40)
Java Type:  String
Attributes:
State or region where the customer's address is located.
Added On:  08/27/15
SQL Column:  STORE_ID
Java Field:  storeId
Status:  Active
SQL Type:  bigint(20)
Java Type:  Long
Attributes:
Store ID generated by the processor. Can be unique to each individual merchant, or a master store ID can be assigned at the partner/owner level.
Added On:  06/13/16
SQL Column:  
Java Field:  storeKey
Status:  Active
SQL Type:  
Java Type:  String
Attributes: Transient
Added On:  08/27/15
SQL Column:  SUCCESS
Java Field:  success
Status:  Active
SQL Type:  varchar(5)
Java Type:  String
Attributes:
Identifies whether the transaction was successful.
Added On:  08/27/15
SQL Column:  TOTAL_AMOUNT
Java Field:  totalAmount
Status:  Active
SQL Type:  varchar(10)
Java Type:  String
Attributes:
Total amount of the transaction.
Added On:  08/27/15
SQL Column:  TRANSACTION_NUMBER
Java Field:  transactionNumber
Status:  Active
SQL Type:  bigint(20)
Java Type:  Long
Attributes:
Number (or code) identifying transaction in the system.
Added On:  08/27/15
SQL Column:  TRANSACTION_STATUS
Java Field:  transactionStatus
Status:  Active
SQL Type:  varchar(30)
Java Type:  String
Attributes:
Current status of the transaction.
Added On:  08/27/15
SQL Column:  UPDATE_CUSTOMER_IF_EXISTS
Java Field:  updateCustomerIfExists
Status:  Active
SQL Type:  varchar(1)
Java Type:  String
Attributes:
Indicates whether the customer account information should be updated (if changed).
Added On:  06/13/16
SQL Column:  
Java Field:  uri
Status:  Active
SQL Type:  
Java Type:  String
Attributes: Transient