Class GetHistoricalEventsRequest

---

Properties

NAME	TYPE	LENGTH	REQUIRED	DESCRIPTION
storeId	long		Y	Unique user ID generated by EPS. (See - Required Data Elements)
storeKey	string		Y	Unique password generated by EPS. (See - Required Data Elements)
entityId	int		Y	Unique identifier that is generated by EPS. (See - Required Data Elements)
wsdisplayFields	enum of Type WSDisplayFields		Y	Available fields that can be included in the report. (See - Required Data Elements) Valid values are: Transaction_DateTime (Not Used) Transaction_Status_Name (d) Payment_Type_Name (d) Name_On_Account (d) Transaction_Number (d) Reference_Number (d) Customer_Number (d) Operation_Type_Name (d) Location_Display_Name (d) Total_Amount (d) Auth_Response_Type_Name Payment_Origin_Name Settlement_Status_Name Display_Account_Number (PartialAccount) Check_Number Cust_Field_1 Cust_Field_2 Cust_Field_3 Field_1 Field_2 Field_3 Third_Party_Reference_Number Audit_User_Name Event_DateTime (d) Event_Type_Name (d) Event_Datastring (d) __NONE OwnerApplication ReceivingApplication OwnerAppReferenceId ReturnCode Notice_Of_Change SequenceID (Not Used) BatchNumber (Not Used) OriginatedAs (Not Used) IsDuplicate (Not Used) EffectiveDate (Not Used) FaceFeeType (Not Used) Company_Entry_Description Note: This element cannot be Null. If __NONE is applied, only the default fields designated above will be displayed. Note: The field Event_Datastring is equivalent to the “Description” column when viewing a transaction’s event history from the SmartPay Business.
locationIds	int		Y	Unique identifier generated by EPS for each location. (See - Required Data Elements) This element can be repeated in the request for each location.
wstransEvents	enum of Type WSTransactionEvent		Y	Events by which a transaction could be affected. Include as many or as few as are needed in the request. Valid values are: Declined Approved Processing_Error Voided Captured Refunded Reversed Edited Processed Cleared Collected Collection_Failed Originated Settled Represented Held_For_Approval Suspended Sent_To_Collection Research_Complete Research_Failed Disputed Returned_NSF Returned_Bad_Account Other_Check21_Returns __NONE (All Events) Notice_Of_Change Resolved Unauthorized Originated_SDACH Settled_SDACH Tax_Amount_Withheld Third_Party_Funded Virtual_Card_Requested
wstransStatus	enum of Type WSTransactionStatus			Statuses of a transaction. (See - Optional Data Elements) Valid values are: Declined Approved Error Voided Processed Collected Awaiting_Capture Awaiting_Approval Suspended In_Collection In_Research Disputed Uncollected_NSF Invalid__Closed_Account Pending Other_Check21_Returns __NONE (All Transaction Statuses) Resolved Unauthorized This element can be repeated in the request for each Transaction Status. If null, all transaction statuses will be assumed.
wssettlementType	enum of Type WSSettlementType			Type of transaction. (See - Optional Data Elements) Valid values are: ACH Check_Image Card_Transfer Instant_Payments None (All Settlement Types) This element can be repeated in the request for each Settlement Type. If null, all settlement types will be assumed. Note: The element wssettlementType is equivalent to the “OriginatedAs” option on the SmartPay Business.
wspaymentType	enum of Type WSPaymentType			Type of payment. (See - Optional Data Elements) Valid values are: __NONE Checking Savings Treasury_Check Money_Order Travelers_Check Convenience_Check Cashiers_Check CC_Checking CC_Savings CC_GL Visa MasterCard Discover__Novus American_Express Diners__Carte_Blanche enRoute JCB Bank_Card Gift_Card On_Us_Card Payroll_Card Pay_Pal FedNow® Cash (All Payment Types) Virtual Card If null or __NONE, all payment types will be assumed.
wspaymentOrigin	enum of Type WSPaymentOrigin			Method by which the transaction was originated. (See - Optional Data Elements) Valid values are: Internet Telephone_IVR Telephone_Operator Mailed_In Drop_Box Signature_Faxed Signature_Original Bounced_Check Back_Office Credit_Send Request_for_Payment Return_Request Retail__POS __NONE (All payment origins) Represented_Check This element can be repeated in the request for each Payment Origin option. If null or __NONE, all payment origins will be assumed.
wssettlementStatus	enum of Type WSSettlementStatus			Settlement disposition of a transaction. (See - Optional Data Elements) Valid values: No_Settlement_Needed To_Be_Originated Originating Originated_Settlement_Pending Settling Settled Charged_Back __NONE (All Settlement Statuses) Originated_SDACH Settled_SDACH This element can be repeated in the request for each Settlement Status. If null, all settlement statuses will be assumed.
wsauthResponseCode	enum of Type WSAuthResponseCode			(See - Optional Data Elements) Valid values are: Success Duplicate_Transaction Declined Data_Not_Valid Velocity_Count Velocity_Amount Customer_Opt_Out_Conversion AVS_Declined CCVS_Declined Expired Authorizer_Suppressed_Data Account_Closed Account_Invalid Account_Not_ACHable Account_Invalid_Routing Error_Invalid_Format Error_Timeout Error_Internal Error_Connection Error_Not_Supported Error_Not_Subscribed (ex. No processor settings) Error_Batch_Closed Error_Invalid_Batch Error_Invalid_Terminal Error_Transaction_Not_Found Error_Terminal_Disabled Error_Invalid_State Error_Unspecified __NONE (All Response Codes) If null, the default of “Success” is assumed.
wsopType	enum of Type WSOperationType			Transaction operation types. (See - Optional Data Elements) Valid values are: Sale Auth Auth_Only Credit __NONE (All Operation Types) Refund SDCredit SDSale CreditSend RequestForPayment Reversal If null, the default of “Sale” is assumed.
beginTransDate	DateTime		Y	This element represents the date from which to start gathering transaction information.
endTransDate	DateTime		Y	This element represents the last date to use for gathering transaction information.
fromAmount	string			This element is used in conjunction with toAmount to request either transactions for a specific amount or transactions within an amount range.
toAmount	string			This element is used in conjunction with fromAmount to request either transactions for a specific amount or transactions within an amount range.