Ezidebit Chargeback Transaction                                                    UML
                                
         
     
    
    
    
    
        
            Added On:  11/22/13 
        
        
        
            Module:  UniCharge 
        
     
    
        
            Type:  Entity 
            Status:  Active 
        
        
                            Java Class:  EzidebitChargebackTransaction 
                    
        
        
     
    
        
            
                
                    Represents chargeback transaction as it is defined in Ezidebit's chargeback specification.                
             
         
     
        
        
                    
                        
                Added On:  11/22/13
                SQL Column:  BANK_FAILED_REASON
                Java Field:  bankFailedReason
             
            
                Status:  Active
                SQL Type:  varchar(100)
                Java Type:  String
             
            
            
            
                
                    
                        
                        The full text description for the reason that the payment was unsuccessful (dishonoured)
Where a payment is successful or still pending an outcome, this value will be blank.                        
                     
                 
             
                    
                        
                Added On:  11/22/13
                SQL Column:  BANK_RECEIPT_ID
                Java Field:  bankReceiptId
             
            
                Status:  Active
                SQL Type:  varchar(10)
                Java Type:  String
             
            
            
            
                
                    
                        
                        The original receipt number supplied by the banking system for real-time credit cards or BPAY payments
NB - ALL real time credit card payments are assigned a BankReceiptID when the transaction is attempted. The presence of a BankReceiptID does NOT identify the payment as being successful. You must check the PaymentStatus to determine the outcome of the transaction.                        
                     
                 
             
                    
                        
                Added On:  11/22/13
                SQL Column:  BANK_RETURN_CODE
                Java Field:  bankReturnCode
             
            
                Status:  Active
                SQL Type:  varchar(5)
                Java Type:  String
             
            
            
            
                
                    
                        
                        Return code of the bank that processed the transaction.                        
                     
                 
             
                    
                        
                Added On:  11/22/13
                SQL Column:  CHARGE_TRANSACTION_FK
                Java Field:  chargeTransaction
             
            
                Status:  Active
                SQL Type:  bigint(20)
                Java Type:  Long
             
            
            
            
                
                    
                        
                        Referece to the entity that represents information about chargeback transaction.                        
                     
                 
             
                    
                        
                Added On:  09/16/14
                SQL Column:  CUSTOMER_NAME
                Java Field:  customerName
             
            
                Status:  Active
                SQL Type:  varchar(255)
                Java Type:  String
             
            
            
            
                    
                        
                Added On:  11/22/13
                SQL Column:  DEBIT_DATE
                Java Field:  debitDate
             
            
                Status:  Active
                SQL Type:  varchar(19)
                Java Type:  String
             
            
            
            
                
                    
                        
                        The date that is wished for the payment to be deducted from customer's bank account or credit card.                        
                     
                 
             
                    
                        
                Added On:  12/09/13
                SQL Column:  EZIDEBIT_CUSTOMER_ID
                Java Field:  ezidebitCustomerId
             
            
                Status:  Active
                SQL Type:  varchar(10)
                Java Type:  String
             
            
            
            
                
                    
                        
                        Identification number of the customer, used for references. Provided by EziDebit.                        
                     
                 
             
                    
                        
                Added On:  11/22/13
                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:  11/22/13
                SQL Column:  INVOICE_ID
                Java Field:  invoiceId
             
            
                Status:  Active
                SQL Type:  varchar(20)
                Java Type:  String
             
            
            
            
                
                    
                        
                        The Ezidebit Tax Invoice number that the fees for this payment were charged on. The Invoice number is also used as a batch identifier for transactions that were settled to the client.                        
                     
                 
             
                    
                        
                Added On:  11/22/13
                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:  11/22/13
                SQL Column:  PAYMENT_AMOUNT
                Java Field:  paymentAmount
             
            
                Status:  Active
                SQL Type:  varchar(13)
                Java Type:  String
             
            
            
            
                
                    
                        
                        Amount of the processed payment.                        
                     
                 
             
                    
                        
                Added On:  11/22/13
                SQL Column:  PAYMENT_ID
                Java Field:  paymentId
             
            
                Status:  Active
                SQL Type:  varchar(50)
                Java Type:  String
             
            
            
            
                
                    
                        
                        Identifier for the payment within Ezidebit's own payment systems.                        
                     
                 
             
                    
                        
                Added On:  09/16/14
                SQL Column:  PAYMENT_METHOD
                Java Field:  paymentMethod
             
            
                Status:  Active
                SQL Type:  varchar(2)
                Java Type:  String
             
            
            
            
                
                    
                        
                        Method used to make the payment.                        
                     
                 
             
                    
                        
                Added On:  09/16/14
                SQL Column:  PAYMENT_REFERENCE
                Java Field:  paymentReference
             
            
                Status:  Active
                SQL Type:  varchar(40)
                Java Type:  String
             
            
            
            
                
                    
                        
                        The client side element name that is capturing a payment reference number. This may be a hidden field that server has already generated.                        
                     
                 
             
                    
                        
                Added On:  09/16/14
                SQL Column:  PAYMENT_SOURCE
                Java Field:  paymentSource
             
            
                Status:  Active
                SQL Type:  varchar(9)
                Java Type:  String
             
            
            
            
                
                    
                        
                        The source channel by which the payment was made.                        
                     
                 
             
                    
                        
                Added On:  11/22/13
                SQL Column:  PAYMENT_STATUS
                Java Field:  paymentStatus
             
            
                Status:  Active
                SQL Type:  varchar(1)
                Java Type:  String
             
            
            
            
                
                    
                        
                        Status indicating the state of the payment within the Ezidebit system.                        
                     
                 
             
                    
                        
                Added On:  06/10/16
                SQL Column:  
                Java Field:  recordContent
             
            
                Status:  Active
                SQL Type:  
                Java Type:  String
             
            
            
            
                
                    
                        
                        Specific data included in the record.                        
                     
                 
             
                    
                        
                Added On:  09/16/14
                SQL Column:  SCHEDULED_AMOUNT
                Java Field:  scheduledAmount
             
            
                Status:  Active
                SQL Type:  varchar(13)
                Java Type:  String
             
            
            
            
                
                    
                        
                        The original amount that was scheduled to be deducted from the customers payment method.
NB - This figure may differ from the Payment Amount if Ezidebit has applied transaction, SMS or setup fees to the Customer.                        
                     
                 
             
                    
                        
                Added On:  11/22/13
                SQL Column:  SETTLEMENT_DATE
                Java Field:  settlementDate
             
            
                Status:  Active
                SQL Type:  varchar(19)
                Java Type:  String
             
            
            
            
                
                    
                        
                        The date that the payment was settled to the client (for successful transactions) or the date that Ezidebit was notified that the payment was unsuccessful (for dishonoured transactions).
This value will remain blank until such point as the payment is dishonoured in the Ezidebit system or is settled to the client's bank account.                        
                     
                 
             
                    
                        
                Added On:  11/22/13
                SQL Column:  TRANSACTION_FEE_CLIENT
                Java Field:  transactionFeeClient
             
            
                Status:  Active
                SQL Type:  varchar(13)
                Java Type:  String
             
            
            
            
                
                    
                        
                        The total amount of fees paid to Ezidebit by the client (business) for processing this transaction.                        
                     
                 
             
                    
                        
                Added On:  11/22/13
                SQL Column:  TRANSACTION_FEE_CUSTOMER
                Java Field:  transactionFeeCustomer
             
            
                Status:  Active
                SQL Type:  varchar(13)
                Java Type:  String
             
            
            
            
                
                    
                        
                        The total amount of fees paid to Ezidebit by the customer for processing this transaction.                        
                     
                 
             
                    
                        
                Added On:  11/22/13
                SQL Column:  TRANSACTION_TIME
                Java Field:  transactionTime
             
            
                Status:  Active
                SQL Type:  varchar(19)
                Java Type:  String
             
            
            
            
                
                    
                        
                        Actual time of the transaction processing.                        
                     
                 
             
                    
                        
                Added On:  09/16/14
                SQL Column:  YOUR_GENERAL_REFERENCE
                Java Field:  yourGeneralReference
             
            
                Status:  Active
                SQL Type:  varchar(50)
                Java Type:  String
             
            
            
            
                
                    
                        
                        A secondary unique reference for the customer.
Where system based identifiers (YourSystemReference) can be complex numbers, this is designed to be a simpler, human-friendly number. You may use a GUID to create the system-to-system link with YourSystemReference, and choose to include a membership ID, or such in this field.
If no value is supplied for this field it will default to 'LastnameFirstnameYYYYmmDDhhMM'.                        
                     
                 
             
                    
                        
                Added On:  09/16/14
                SQL Column:  YOUR_SYSTEM_REFERENCE
                Java Field:  yourSystemReference
             
            
                Status:  Active
                SQL Type:  varchar(50)
                Java Type:  String
             
            
            
            
                
                    
                        
                        Unique system identifier for the customer (e.g. GUID or your primary key). You can use this value to identify your customer in the Ezidebit system.