Paymentus Auth Retail Transaction                                                    UML
                                
         
     
    
    
    
    
        
            Added On:  06/01/16 
        
        
        
            Module:  UniCharge 
        
     
    
        
            Type:  Entity 
            Status:  Active 
        
        
                            Java Class:  PaymentusAuthRetailTransaction 
                    
        
        
     
    
        
        
                    
                        
                Added On:  06/01/16
                SQL Column:  CHARGE_TRANSACTION_FK
                Java Field:  chargeTransaction
             
            
                Status:  Active
                SQL Type:  bigint(20)
                Java Type:  Long
             
            
            
            
                
                    
                        
                        Reference to the entity that represents real-time financial transaction.                        
                     
                 
             
                    
                        
                Added On:  06/01/16
                SQL Column:  CUSTOMER_ADDRESS_CITY
                Java Field:  customerAddressCity
             
            
                Status:  Active
                SQL Type:  varchar(32)
                Java Type:  String
             
            
            
            
                
                    
                        
                        City of the customer's mailing address.                        
                     
                 
             
                    
                        
                Added On:  06/01/16
                SQL Column:  CUSTOMER_ADDRESS_COUNTRY
                Java Field:  customerAddressCountry
             
            
                Status:  Active
                SQL Type:  varchar(2)
                Java Type:  String
             
            
            
            
                
                    
                        
                        Country code of the customer's mailing address.                        
                     
                 
             
                    
                        
                Added On:  06/01/16
                SQL Column:  CUSTOMER_ADDRESS_LINE1
                Java Field:  customerAddressLine1
             
            
                Status:  Active
                SQL Type:  varchar(128)
                Java Type:  String
             
            
            
            
                
                    
                        
                        Customer's mailing address (line 1).                        
                     
                 
             
                    
                        
                Added On:  06/01/16
                SQL Column:  CUSTOMER_ADDRESS_STATE
                Java Field:  customerAddressState
             
            
                Status:  Active
                SQL Type:  varchar(2)
                Java Type:  String
             
            
            
            
                
                    
                        
                        State code of the customer's mailing address.                        
                     
                 
             
                    
                        
                Added On:  06/01/16
                SQL Column:  CUSTOMER_ADDRESS_ZIP_CODE
                Java Field:  customerAddressZipCode
             
            
                Status:  Active
                SQL Type:  varchar(9)
                Java Type:  String
             
            
            
            
                
                    
                        
                        ZIP (or postal) code of the customer's mailing address.                        
                     
                 
             
                    
                        
                Added On:  06/01/16
                SQL Column:  CUSTOMER_DAY_PHONE_NR
                Java Field:  customerDayPhoneNr
             
            
                Status:  Active
                SQL Type:  varchar(10)
                Java Type:  String
             
            
            
            
                
                    
                        
                        10-digit phone number that can be used for discussing any processing issues with the customer during the day time.                        
                     
                 
             
                    
                        
                Added On:  06/01/16
                SQL Column:  CUSTOMER_EMAIL
                Java Field:  customerEmail
             
            
                Status:  Active
                SQL Type:  varchar(100)
                Java Type:  String
             
            
            
            
                
                    
                        
                        Email of the customer. Used for payment and subsequent payment action notifications.                        
                     
                 
             
                    
                        
                Added On:  06/01/16
                SQL Column:  CUSTOMER_FIRST_NAME
                Java Field:  customerFirstName
             
            
                Status:  Active
                SQL Type:  varchar(50)
                Java Type:  String
             
            
            
            
                
                    
                        
                        First name of the customer.                        
                     
                 
             
                    
                        
                Added On:  06/01/16
                SQL Column:  CUSTOMER_LAST_NAME
                Java Field:  customerLastName
             
            
                Status:  Active
                SQL Type:  varchar(64)
                Java Type:  String
             
            
            
            
                
                    
                        
                        Last name of the customer.                        
                     
                 
             
                    
                        
                Added On:  06/01/16
                SQL Column:  CUSTOMER_MIDDLE_NAME
                Java Field:  customerMiddleName
             
            
                Status:  Active
                SQL Type:  varchar(100)
                Java Type:  String
             
            
            
            
                
                    
                        
                        Middle name of the customer.                        
                     
                 
             
                    
                        
                Added On:  06/01/16
                SQL Column:  HEADER_ACCOUNT_NUMBER
                Java Field:  headerAccountNumber
             
            
                Status:  Active
                SQL Type:  varchar(32)
                Java Type:  String
             
            
            
            
                
                    
                        
                        Account number of the customer.                        
                     
                 
             
                    
                        
                Added On:  06/01/16
                SQL Column:  HEADER_EXTERNAL_REFERENCE_NUMBER
                Java Field:  headerExternalReferenceNumber
             
            
                Status:  Active
                SQL Type:  varchar(32)
                Java Type:  String
             
            
            
            
                
                    
                        
                        External unique identifier of the payment.
Note: External reference number must be unique. Payment will be rejected as a duplicate payment (in current, or any subsequent file) if external reference number is repeated for the same account.                         
                     
                 
             
                    
                        
                Added On:  06/01/16
                SQL Column:  HEADER_OPERATION
                Java Field:  headerOperation
             
            
                Status:  Active
                SQL Type:  varchar(32)
                Java Type:  String
             
            
            
            
                
                    
                        
                        Current payment operation made by the customer.                        
                     
                 
             
                    
                        
                Added On:  06/01/16
                SQL Column:  HEADER_PAYMENT_AMOUNT
                Java Field:  headerPaymentAmount
             
            
                Status:  Active
                SQL Type:  varchar(11)
                Java Type:  String
             
            
            
            
                    
                        
                Added On:  06/01/16
                SQL Column:  HEADER_PAYMENT_TYPE_CODE
                Java Field:  headerPaymentTypeCode
             
            
                Status:  Active
                SQL Type:  varchar(32)
                Java Type:  String
             
            
            
            
                
                    
                        
                        Code of the payment type.                        
                     
                 
             
                    
                        
                Added On:  06/01/16
                SQL Column:  HEADER_REFERENCE_NUMBER
                Java Field:  headerReferenceNumber
             
            
                Status:  Active
                SQL Type:  varchar(12)
                Java Type:  String
             
            
            
            
                
                    
                        
                        Payment reference number. This value will be zero if no payment is found.                         
                     
                 
             
                    
                        
                Added On:  06/01/16
                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:  06/01/16
                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/01/16
                SQL Column:  
                Java Field:  paymentMethodAccountNumber
             
            
                Status:  Active
                SQL Type:  
                Java Type:  String
             
            
            
            
                
                    
                        
                        Credit card or bank account number of the customer.                        
                     
                 
             
                    
                        
                Added On:  06/29/16
                SQL Column:  
                Java Field:  paymentMethodBankId
             
            
                Status:  Active
                SQL Type:  
                Java Type:  String
             
            
            
            
                
                    
                        
                        Unique identification number of the bank.                        
                     
                 
             
                    
                        
                Added On:  06/29/16
                SQL Column:  
                Java Field:  paymentMethodBankTransitNumber
             
            
                Status:  Active
                SQL Type:  
                Java Type:  String
             
            
            
            
                    
                        
                Added On:  06/01/16
                SQL Column:  PAYMENT_METHOD_CARD_HOLDER_NAME
                Java Field:  paymentMethodCardHolderName
             
            
                Status:  Active
                SQL Type:  varchar(151)
                Java Type:  String
             
            
            
            
                
                    
                        
                        Name of the account holder (or credit cardholder name).                        
                     
                 
             
                    
                        
                Added On:  06/01/16
                SQL Column:  PAYMENT_METHOD_CREDIT_CARD_EXPIRY_MONTH
                Java Field:  paymentMethodCreditCardExpiryMonth
             
            
                Status:  Active
                SQL Type:  varchar(2)
                Java Type:  String
             
            
            
            
                
                    
                        
                        Credit card expiration month (2 difits).                        
                     
                 
             
                    
                        
                Added On:  06/01/16
                SQL Column:  PAYMENT_METHOD_CREDIT_CARD_EXPIRY_YEAR
                Java Field:  paymentMethodCreditCardExpiryYear
             
            
                Status:  Active
                SQL Type:  varchar(4)
                Java Type:  String
             
            
            
            
                
                    
                        
                        Credit card expiration year (4 difits).                        
                     
                 
             
                    
                        
                Added On:  06/01/16
                SQL Column:  
                Java Field:  paymentMethodCvv
             
            
                Status:  Active
                SQL Type:  
                Java Type:  String
             
            
            
            
                
                    
                        
                        CVV or CVD of the credit card.                        
                     
                 
             
                    
                        
                Added On:  06/29/16
                SQL Column:  PAYMENT_METHOD_FI_NAME
                Java Field:  paymentMethodFiName
             
            
                Status:  Active
                SQL Type:  varchar(32)
                Java Type:  String
             
            
            
            
                    
                        
                Added On:  06/01/16
                SQL Column:  PAYMENT_METHOD_TYPE
                Java Field:  paymentMethodType
             
            
                Status:  Active
                SQL Type:  varchar(32)
                Java Type:  String
             
            
            
            
                
                    
                        
                        Type of payment method (e.g. credit card type).                        
                     
                 
             
                    
                        
                Added On:  06/01/16
                SQL Column:  PAYMENT_RESPONSE_ADDITIONAL_AMOUNT
                Java Field:  paymentResponseAdditionalAmount
             
            
                Status:  Active
                SQL Type:  varchar(13)
                Java Type:  String
             
            
            
            
                
                    
                        
                        Optional additional payment amount to be included as part of the transaction, for example a donation.                        
                     
                 
             
                    
                        
                Added On:  06/01/16
                SQL Column:  PAYMENT_RESPONSE_CONVENIENCE_FEE
                Java Field:  paymentResponseConvenienceFee
             
            
                Status:  Active
                SQL Type:  varchar(13)
                Java Type:  String
             
            
            
            
                
                    
                        
                        Convenience fee determined by configuration.                        
                     
                 
             
                    
                        
                Added On:  06/01/16
                SQL Column:  PAYMENT_RESPONSE_ERRORS
                Java Field:  paymentResponseErrors
             
            
                Status:  Active
                SQL Type:  varchar(128)
                Java Type:  String
             
            
            
            
                
                    
                        
                        Payment error description (if occured).                        
                     
                 
             
                    
                        
                Added On:  06/01/16
                SQL Column:  PAYMENT_RESPONSE_PAYMENT_AMOUNT
                Java Field:  paymentResponsePaymentAmount
             
            
                Status:  Active
                SQL Type:  varchar(13)
                Java Type:  String
             
            
            
            
                    
                        
                Added On:  06/01/16
                SQL Column:  PAYMENT_RESPONSE_PAYMENT_DATE
                Java Field:  paymentResponsePaymentDate
             
            
                Status:  Active
                SQL Type:  varchar(14)
                Java Type:  String
             
            
            
            
                
                    
                        
                        Date in the mmDDyyyyHHmmss format. 
Note: Only present within sale response.                        
                     
                 
             
                    
                        
                Added On:  06/01/16
                SQL Column:  PAYMENT_RESPONSE_PAYMENT_STATUS
                Java Field:  paymentResponsePaymentStatus
             
            
                Status:  Active
                SQL Type:  varchar(32)
                Java Type:  String
             
            
            
            
                
                    
                        
                        Current status of the payment (Accepted/Failed).                        
                     
                 
             
                    
                        
                Added On:  06/01/16
                SQL Column:  PAYMENT_RESPONSE_PAYMENT_STATUS_DESCRIPTION
                Java Field:  paymentResponsePaymentStatusDescription
             
            
                Status:  Active
                SQL Type:  varchar(256)
                Java Type:  String
             
            
            
            
                
                    
                        
                        Short description of the payment status.                        
                     
                 
             
                    
                        
                Added On:  06/01/16
                SQL Column:  PAYMENT_RESPONSE_REFERENCE_NUMBER
                Java Field:  paymentResponseReferenceNumber
             
            
                Status:  Active
                SQL Type:  varchar(12)
                Java Type:  String
             
            
            
            
                
                    
                        
                        Unique Paymentus payment reference number.
Note: Only present within sale and void responses.                         
                     
                 
             
                    
                        
                Added On:  06/01/16
                SQL Column:  PAYMENT_RESPONSE_TOTAL_AMOUNT
                Java Field:  paymentResponseTotalAmount
             
            
                Status:  Active
                SQL Type:  varchar(13)
                Java Type:  String
             
            
            
            
                
                    
                        
                        Total amount charged from the customer.                        
                     
                 
             
                    
                        
                Added On:  06/01/16
                SQL Column:  RETAIL_TRANSACTION_CYCLE_FK
                Java Field:  retailTransactionCycle
             
            
                Status:  Active
                SQL Type:  bigint(20)
                Java Type:  Long
             
            
            
            
                
                    
                        
                        Reference to the entity that represents a group of real-time transactions which must be settled together.                        
                     
                 
             
                    
                        
                Added On:  06/01/16
                SQL Column:  USER_LOGIN_ID
                Java Field:  userLoginId
             
            
                Status:  Active
                SQL Type:  varchar(32)
                Java Type:  String
             
            
            
            
                    
                        
                Added On:  06/01/16
                SQL Column:  
                Java Field:  userPassword
             
            
                Status:  Active
                SQL Type:  
                Java Type:  String
             
            
            
            
                
                    
                        
                        Password of the user, corresponding to the login ID.