Subscription Transaction                                                    UML
                                
         
     
    
    
    
    
        
            Added On:  09/25/15 
        
        
        
            Module:  UniCharge 
        
     
    
        
            Type:  Entity 
            Status:  Active 
        
        
                            Java Class:  SubscriptionTransaction 
                    
        
        
     
    
        
            
                
                    Entity that represents information about subscription transaction.
                
             
         
     
        
        
                    
                        
                Added On:  09/25/15
                SQL Column:  ACCOUNT_ACCESSORY
                Java Field:  accountAccessory
             
            
                Status:  Active
                SQL Type:  varchar(50)
                Java Type:  String
             
            
            
            
                
                    
                        
                        Expiration date or routing number of the transaction. 
                        
                     
                 
             
                    
                        
                Added On:  09/25/15
                SQL Column:  ACCOUNT_ACCESSORY_MASKED
                Java Field:  accountAccessoryMasked
             
            
                Status:  Active
                SQL Type:  varchar(10)
                Java Type:  String
             
            
            
            
                
                    
                        
                        Masked account accessory number.
                        
                     
                 
             
                    
                        
                Added On:  01/13/16
                SQL Column:  ACCOUNT_CL
                Java Field:  accountCl
             
            
                Status:  Active
                SQL Type:  varchar(2)
                Java Type:  String
             
            
            
            
                
                    
                        
                        Represents the type of the bank account associated with the transaction.
                        
                     
                 
             
                    
                        
                Added On:  09/25/15
                SQL Column:  ACCOUNT_NUMBER
                Java Field:  accountNumber
             
            
                Status:  Active
                SQL Type:  varchar(80)
                Java Type:  String
             
            
            
            
                
                    
                        
                        Number of the customer's bank account.
                        
                     
                 
             
                    
                        
                Added On:  09/25/15
                SQL Column:  ACCOUNT_NUMBER_LAST4
                Java Field:  accountNumberLast4
             
            
                Status:  Active
                SQL Type:  varchar(4)
                Java Type:  String
             
            
            
            
                
                    
                        
                        Last four digits of the bank account or credit card number.
                        
                     
                 
             
                    
                        
                Added On:  09/25/15
                SQL Column:  ACCOUNT_NUMBER_MASKED
                Java Field:  accountNumberMasked
             
            
                Status:  Active
                SQL Type:  varchar(20)
                Java Type:  String
             
            
            
            
                
                    
                        
                        Masked version of the account number (credit card or bank account) associated with this transaction. The mask is formed by using the first and last digits of the account, e.g. 4********5655.
                        
                     
                 
             
                    
                        
                Added On:  06/10/16
                SQL Column:  BANK_INFO_FK
                Java Field:  bankInfo
             
            
                Status:  Active
                SQL Type:  int(11)
                Java Type:  Integer
             
            
            
            
                
                    
                        
                        Reference to the entity that represents information about the bank.
                        
                     
                 
             
                    
                        
                Added On:  09/25/15
                SQL Column:  CITY
                Java Field:  city
             
            
                Status:  Active
                SQL Type:  varchar(50)
                Java Type:  String
             
            
            
            
                
                    
                        
                        City of the mailing address associated with this customer account.
                        
                     
                 
             
                    
                        
                Added On:  09/25/15
                SQL Column:  COUNTRY_CODE
                Java Field:  countryCode
             
            
                Status:  Active
                SQL Type:  varchar(2)
                Java Type:  String
             
            
            
            
                
                    
                        
                        Country code of the mailing address associated with this customer account.
                        
                     
                 
             
                    
                        
                Added On:  09/25/15
                SQL Column:  CREATE_DATE
                Java Field:  createDate
             
            
                Status:  Active
                SQL Type:  datetime
                Java Type:  Date
             
            
            
            
                
                    
                        
                        Date when the record was created
                        
                     
                 
             
                    
                        
                Added On:  09/25/15
                SQL Column:  CUSTOMER_ACCOUNT_CODE
                Java Field:  customerAccountCode
             
            
                Status:  Active
                SQL Type:  varchar(60)
                Java Type:  String
             
            
            
            
                
                    
                        
                        Value identifying the customer in a submitter’s system. 
                        
                     
                 
             
                    
                        
                Added On:  09/25/15
                SQL Column:  DATA_HASH1
                Java Field:  dataHash1
             
            
                Status:  Active
                SQL Type:  bigint(20)
                Java Type:  Long
             
            
            
            
                
                    
                        
                        Data used for identification of the subscription that contains an account number.
                        
                     
                 
             
                    
                        
                Added On:  10/28/15
                SQL Column:  DATA_HASH2
                Java Field:  dataHash2
             
            
                Status:  Active
                SQL Type:  bigint(20)
                Java Type:  Long
             
            
            
            
                
                    
                        
                        Data used for identification of the subscription that contains a token.
                        
                     
                 
             
                    
                        
                Added On:  10/27/15
                SQL Column:  DUPLICATE_CODE
                Java Field:  duplicateCode
             
            
                Status:  Active
                SQL Type:  bigint(20)
                Java Type:  Long
             
            
            
            
                
                    
                        
                        Identifier of the original transaction assigned to this duplicate record.
                        
                     
                 
             
                    
                        
                Added On:  09/25/15
                SQL Column:  EMAIL
                Java Field:  email
             
            
                Status:  Active
                SQL Type:  varchar(100)
                Java Type:  String
             
            
            
            
                
                    
                        
                        Email address associated with this customer account.
                        
                     
                 
             
                    
                        
                Added On:  03/14/17
                SQL Column:  EXTERNAL_SUBSCRIPTION_CODE
                Java Field:  externalSubscriptionCode
             
            
                Status:  Active
                SQL Type:  varchar(20)
                Java Type:  String
             
            
            
            
                
                    
                        
                        Identifier of the subscription assigned within the processor's system.
                        
                     
                 
             
                    
                        
                Added On:  09/25/15
                SQL Column:  FIRST_NAME
                Java Field:  firstName
             
            
                Status:  Active
                SQL Type:  varchar(50)
                Java Type:  String
             
            
            
            
                
                    
                        
                        First name of the customer.
                        
                     
                 
             
                    
                        
                Added On:  09/25/15
                SQL Column:  ID
                Java Field:  id
             
            
                Status:  Active
                SQL Type:  bigint(20)
                Java Type:  Long
             
            
            
                
                    Attributes:
                    Unique, Required, CreateOnly, ReadOnly                
                             
            
                
                    
                        
                        Identifier of the object used for references; auto-incremented integer value.
                        
                     
                 
             
                    
                        
                Added On:  09/25/15
                SQL Column:  IS_ORGANIZATION
                Java Field:  isOrganization
             
            
                Status:  Active
                SQL Type:  tinyint(1)
                Java Type:  Boolean
             
            
            
                
                    Attributes:
                    Default:false                
                             
            
                
                    
                        
                        Indicates whether the specified customer is an organization.
                        
                     
                 
             
                    
                        
                Added On:  09/25/15
                SQL Column:  LAST_NAME
                Java Field:  lastName
             
            
                Status:  Active
                SQL Type:  varchar(50)
                Java Type:  String
             
            
            
            
                
                    
                        
                        Last name of the customer.
                        
                     
                 
             
                    
                        
                Added On:  09/25/15
                SQL Column:  MERCHANT_ACCOUNT_CODE
                Java Field:  merchantAccountCode
             
            
                Status:  Active
                SQL Type:  int(11)
                Java Type:  Integer
             
            
            
            
                
                    
                        
                        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/10/16
                SQL Column:  PHONE
                Java Field:  phone
             
            
                Status:  Active
                SQL Type:  varchar(15)
                Java Type:  String
             
            
            
            
                
                    
                        
                        Phone number associated with this customer account.
                        
                     
                 
             
                    
                        
                Added On:  09/25/15
                SQL Column:  PROVIDER_REFERENCE_NUMBER
                Java Field:  providerReferenceNumber
             
            
                Status:  Active
                SQL Type:  varchar(60)
                Java Type:  String
             
            
            
            
                
                    
                        
                        Returns reference number of underlying processor.
                        
                     
                 
             
                    
                        
                Added On:  01/15/16
                SQL Column:  PROVIDER_RESPONSE_CODE
                Java Field:  providerResponseCode
             
            
                Status:  Active
                SQL Type:  varchar(4)
                Java Type:  String
             
            
            
            
                
                    
                        
                        Response code generated by a processor.
                        
                     
                 
             
                    
                        
                Added On:  01/15/16
                SQL Column:  PROVIDER_RESPONSE_MESSAGE
                Java Field:  providerResponseMessage
             
            
                Status:  Active
                SQL Type:  varchar(255)
                Java Type:  String
             
            
            
            
                
                    
                        
                        Response message generated by a processor.
                        
                     
                 
             
                    
                        
                Added On:  06/10/16
                SQL Column:  REQUEST_TYPE
                Java Field:  requestType
             
            
                Status:  Active
                SQL Type:  varchar
                Java Type:  String
             
            
            
                
                    Attributes:
                    Transient, Default:subscription                
                             
            
                
                    
                        
                        Type of the request. For subscription request type the value is Subscription.
                        
                     
                 
             
                    
                        
                Added On:  09/25/15
                SQL Column:  RESPONSE_CODE
                Java Field:  responseCode
             
            
                Status:  Active
                SQL Type:  varchar(5)
                Java Type:  String
             
            
            
            
                
                    
                        
                        Response code generated by the gateway.
                        
                     
                 
             
                    
                        
                Added On:  09/25/15
                SQL Column:  RESPONSE_DATE
                Java Field:  responseDate
             
            
                Status:  Active
                SQL Type:  datetime
                Java Type:  Date
             
            
            
            
                
                    
                        
                        Date of the response generated by the gateway.
                        
                     
                 
             
                    
                        
                Added On:  09/25/15
                SQL Column:  RESPONSE_MESSAGE
                Java Field:  responseMessage
             
            
                Status:  Active
                SQL Type:  varchar(255)
                Java Type:  String
             
            
            
            
                
                    
                        
                        Response message generated by the gateway.
                        
                     
                 
             
                    
                        
                Added On:  09/25/15
                SQL Column:  STATE
                Java Field:  state
             
            
                Status:  Active
                SQL Type:  varchar(3)
                Java Type:  String
             
            
            
            
                
                    
                        
                        State of the mailing address associated with this customer account.
                        
                     
                 
             
                    
                        
                Added On:  09/25/15
                SQL Column:  STATUS_CL
                Java Field:  statusCl
             
            
                Status:  Active
                SQL Type:  varchar(1)
                Java Type:  String
             
            
            
            
                
                    
                        
                        Represents current status of the subscriptions/mandate processing. 
                        
                     
                 
             
                    
                        
                Added On:  09/25/15
                SQL Column:  STREET
                Java Field:  street
             
            
                Status:  Active
                SQL Type:  varchar(128)
                Java Type:  String
             
            
            
            
                
                    
                        
                        Street of the mailing address associated with this customer account.
                        
                     
                 
             
                    
                        
                Added On:  10/23/15
                SQL Column:  TOKEN
                Java Field:  token
             
            
                Status:  Active
                SQL Type:  varchar(50)
                Java Type:  String
             
            
            
            
                
                    
                        
                        Token value replacing bank account number.
                        
                     
                 
             
                    
                        
                Added On:  10/23/15
                SQL Column:  TOKEN_CODE
                Java Field:  tokenCode
             
            
                Status:  Active
                SQL Type:  varchar(20)
                Java Type:  String
             
            
            
            
                
                    
                        
                        Token generated for the provided payment information. Always present when tokenization service is enabled.
                        
                     
                 
             
                    
                        
                Added On:  09/25/15
                SQL Column:  TRANSACTION_CODE
                Java Field:  transactionCode
             
            
                Status:  Active
                SQL Type:  varchar(60)
                Java Type:  String
             
            
            
            
                
                    
                        
                        Value identifying the transaction in a submitter’s system.
                        
                     
                 
             
                    
                        
                Added On:  09/25/15
                SQL Column:  ZIP_CODE
                Java Field:  zipCode
             
            
                Status:  Active
                SQL Type:  varchar(15)
                Java Type:  String
             
            
            
            
                
                    
                        
                        ZIP or postal code of the mailing address associated with this customer account.