Payment Option UML


Added On:  03/16/12 
SQL Table:  PAYMENT_OPTION 
Module:  UniBill 
Type:  Entity  Status:  Active 
Java Class:  PaymentOption 
Represents information about payment option associated with the customer.
Added On:  03/16/12
SQL Column:  ID
Java Field:  id
Status:  Active
SQL Type:  bigint(20)
Java Type:  Long
Identifier / Primary Key
Attributes: Required
Identifier of the object used for references; auto-incremented integer value.
Added On:  03/16/12
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:  03/16/12
SQL Column:  REF_CODE
Java Field:  refCode
Status:  Active
SQL Type:  varchar(60)
Java Type:  String
Attributes:
Secondary identifier that can be used to cross-reference records between UniPay and integrated systems.

See Reference Code definition for additional information.
Added On:  03/16/12
SQL Column:  SYS_MESSAGE
Java Field:  sysMessage
Status:  Active
SQL Type:  varchar(255)
Java Type:  String
Attributes:
Message that includes identifier of the payment option, last received decline date, decline response code and decline response message (i.e. 252|20131220|D01|Denied by customer's bank (Declined)).
Added On:  03/16/12
SQL Column:  CREATE_DATE
Java Field:  createDate
Status:  Active
SQL Type:  datetime
Java Type:  Date
Attributes:
Date when the record was created.
Added On:  03/16/12
SQL Column:  IMPORT_DATE
Java Field:  importDate
Status:  Active
SQL Type:  datetime
Java Type:  Date
Attributes:
Date when the record was imported.
Added On:  03/16/12
SQL Column:  IS_ACTIVE
Java Field:  isActive
Status:  Active
SQL Type:  tinyint(1)
Java Type:  Boolean
Attributes: Default: true
Indicates whether the record is active in the system.
Added On:  03/16/12
SQL Column:  HOLDER_NAME
Java Field:  holderName
Status:  Active
SQL Type:  varchar(150)
Java Type:  String
Attributes:
Name of the bank account or credit card holder.
Added On:  03/16/12
SQL Column:  TOKEN_CODE
Java Field:  tokenCode
Status:  Active
SQL Type:  varchar(512)
Java Type:  String
Attributes:
Code of the token associated with the particular payment option.
Added On:  03/16/12
SQL Column:  NUMBER
Java Field:  number
Status:  Active
SQL Type:  varchar(80)
Java Type:  String
Attributes:
Number of a payment card or bank account.
Added On:  03/16/12
SQL Column:  NUMBER_LAST4
Java Field:  numberLast4
Status:  Active
SQL Type:  varchar(4)
Java Type:  String
Attributes:
Last 4 digits of the bank card or bank account number.
Added On:  03/16/12
SQL Column:  MASKED_NUMBER
Java Field:  maskedNumber
Status:  Active
SQL Type:  varchar(19)
Java Type:  String
Attributes:
Bank card or account number being masked for secure storage within the system (i.e. 4***********1111).
Added On:  03/16/12
SQL Column:  ACCESSORY
Java Field:  accessory
Status:  Active
SQL Type:  varchar(80)
Java Type:  String
Attributes:
Expiration date of the card or bank routing number.
Added On:  03/16/12
SQL Column:  MASKED_ACCESSORY
Java Field:  maskedAccessory
Status:  Active
SQL Type:  varchar(9)
Java Type:  String
Attributes:
Expiration date of the card or bank routing number being masked for secure storage within the system.
Added On:  03/16/12
SQL Column:  STREET1
Java Field:  street1
Status:  Active
SQL Type:  varchar(128)
Java Type:  String
Attributes:
Street name of the user's mailing address.
Added On:  03/16/12
SQL Column:  STREET2
Java Field:  street2
Status:  Active
SQL Type:  varchar(128)
Java Type:  String
Attributes:
Additional street name field for entering user's mailing address.
Added On:  03/16/12
SQL Column:  CITY
Java Field:  city
Status:  Active
SQL Type:  varchar(50)
Java Type:  String
Attributes:
City name of the user's mailing address.
Added On:  03/16/12
SQL Column:  STATE
Java Field:  state
Status:  Active
SQL Type:  varchar(3)
Java Type:  String
Attributes:
Code of the state associated with a user's mailing address.
Added On:  03/16/12
SQL Column:  ZIP_CODE
Java Field:  zipCode
Status:  Active
SQL Type:  varchar(15)
Java Type:  String
Attributes:
ZIP or postal code associated with a user's mailing address.
Added On:  03/16/12
SQL Column:  COUNTRY_CL
Java Field:  countryCl
Status:  Active
SQL Type:  varchar(3)
Java Type:  String
Attributes:
Enumeration of possible country codes associated with a user's mailing address.
Added On:  03/16/12
SQL Column:  FIRST_BILLING_DATE
Java Field:  firstBillingDate
Status:  Active
SQL Type:  datetime
Java Type:  Date
Attributes:
Date when the first billing occured.
Added On:  03/16/12
SQL Column:  PAYMENT_OPTION_CL
Java Field:  paymentOptionCl
Status:  Active
SQL Type:  varchar(2)
Java Type:  String
Attributes:
Reference to the entity that represents possible types of payment options.
Added On:  03/16/12
SQL Column:  COLLECTOR_ACCOUNT_CODE
Java Field:  collectorAccountCode
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Code of the collector agent's account.
Added On:  03/16/12
SQL Column:  LAST_UPDATE_DATE
Java Field:  lastUpdateDate
Status:  Active
SQL Type:  datetime
Java Type:  Date
Attributes:
Date when the payment plan was updated for the last time.
Added On:  03/16/12
SQL Column:  ISSUER_BANK_NAME
Java Field:  issuerBankName
Status:  Active
SQL Type:  varchar(255)
Java Type:  String
Attributes:
Name of the bank that issued a customer's card.
Added On:  03/16/12
SQL Column:  ISSUER_BANK_PHONE
Java Field:  issuerBankPhone
Status:  Active
SQL Type:  varchar(15)
Java Type:  String
Attributes:
Phone number of the bank that issued a customer's card.
Added On:  03/16/12
SQL Column:  DECLINE_COUNT
Java Field:  declineCount
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Number of the declined billing attempts.
Added On:  03/16/12
SQL Column:  DECLINE_DATE
Java Field:  declineDate
Status:  Active
SQL Type:  datetime
Java Type:  Date
Attributes:
Date when the billing attempt was declined.
Added On:  03/16/12
SQL Column:  DECLINE_CL
Java Field:  declineCl
Status:  Active
SQL Type:  varchar(2)
Java Type:  String
References Decline Classifier
Attributes:
Reference to the entity that represents enumeration of decline types.
Added On:  03/16/12
SQL Column:  IS_VISIBLE_EXTERNALLY
Java Field:  isVisibleExternally
Status:  Active
SQL Type:  tinyint(1)
Java Type:  Boolean
Attributes: Default: true
Indicates whether the payment operation is visible externally.
Added On:  03/16/12
SQL Column:  ENCODED_BIN
Java Field:  encodedBin
Status:  Active
SQL Type:  varchar(32)
Java Type:  String
Attributes:
BIN (bank identification number) masked for secure storage within the system.
Added On:  03/16/12
SQL Column:  ACTIVATOR_CODE
Java Field:  activatorCode
Status:  Active
SQL Type:  varchar(60)
Java Type:  String
Attributes:
Name fo the customer that activated the payment option.
Added On:  03/16/12
SQL Column:  IS_BIN_UNAVAILABLE
Java Field:  isBinUnavailable
Status:  Active
SQL Type:  tinyint(1)
Java Type:  Boolean
Attributes:
Indicates whether the BIN (bank identification number) is unavailable.
Added On:  03/16/12
SQL Column:  IS_UPDATE_REQUIRED
Java Field:  isUpdateRequired
Status:  Active
SQL Type:  tinyint(1)
Java Type:  Boolean
Attributes: Default: false
Indicates whether the account requires an update.
Added On:  03/16/12
SQL Column:  LAST_ACCOUNT_UPDATE_DATE
Java Field:  lastAccountUpdateDate
Status:  Active
SQL Type:  datetime
Java Type:  Date
Attributes:
Date when the account was updated for the last time.
Added On:  03/16/12
SQL Column:  BANK_INFO_FK
Java Field:  bankInfo
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
References Bank Info
Attributes:
Reference to the entity that represents information about the bank that holds the account.
Added On:  03/16/12
SQL Column:  ACCOUNT_UPDATER_HISTORY_FK
Java Field:  accountUpdaterHistory
Status:  Active
SQL Type:  bigint(20)
Java Type:  Long
Attributes:
Reference to the entity that includes information about account from the creation till the current date.
Added On:  06/12/12
SQL Column:  PHONE
Java Field:  phone
Status:  Active
SQL Type:  varchar(15)
Java Type:  String
Attributes:
Phone number of the customer.
Added On:  06/05/14
SQL Column:  LAST_ACTIVATE_DATE
Java Field:  lastActivateDate
Status:  Active
SQL Type:  datetime
Java Type:  Date
Attributes:
Date when the account was activated for the last time.
Added On:  06/05/14
SQL Column:  BASE_OBJECT_CODE
Java Field:  baseObjectCode
Status:  Active
SQL Type:  bigint(20)
Java Type:  Long
Attributes:
The reference to the Payment Option that was used as the base object for cloning the current object.
Added On:  07/06/15
SQL Column:  TOKEN_EXTENDED
Java Field:  tokenExtended
Status:  Active
SQL Type:  varchar(50)
Java Type:  String
Attributes:
The extended token number.
Added On:  08/07/15
SQL Column:  LAST_EMAIL_ACCOUNT_EXPIRATION_SENT_DATE
Java Field:  lastEmailAccountExpirationSentDate
Status:  Active
SQL Type:  datetime
Java Type:  Date
Attributes:
Date when the last notification about email account expiration was sent.
Added On:  09/21/16
SQL Column:  
Java Field:  cvv2
Status:  Active
SQL Type:  
Java Type:  String
Attributes: Transient
CVV2 code associated with payment.
Added On:  09/21/16
SQL Column:  
Java Field:  refId
Status:  Active
SQL Type:  
Java Type:  Long
Attributes: Transient
Secondary identifier that can be used to cross-reference records between UniPay and integrated systems.
Added On:  09/21/16
SQL Column:  
Java Field:  isProxynizationEnabled
Status:  Active
SQL Type:  
Java Type:  Boolean
Attributes: Transient, Default: false
Indocates whether proxynization for card number is enabled.
Added On:  03/28/18
SQL Column:  NETWORK_TRANSACTION_ID
Java Field:  networkTransactionId
Status:  Active
SQL Type:  varchar(15)
Java Type:  String
Attributes: