Skip to main content

Class GetHistoricalEventWithTransactionDetailReportRequest

Properties​

NAMETYPELENGTHREQUIREDDESCRIPTION
storeIdlongYUnique user ID generated by EPS.
storeKeystringYUnique password generated by EPS.
entityIdintYUnique identifier that is generated by EPS.
wsdisplayFieldsenum of Type WSDisplayFieldsYAvailable fields that can be included in the report.

Valid values are:
  • SequenceID (d)
  • Transaction_DateTime (d)
  • BatchNumber (d)
  • OriginatedAs (d)
  • IsDuplicate (d)
  • EffectiveDate (d)
  • FaceFeeType (d)
  • 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
  • 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
locationIdsintYUnique identifier generated by EPS for each location. This element can be repeated in the request for each location.
wstransEventenum of Type WSTransactionEventYEvents by which a transaction could be affected.

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
wstransStatusenum of Type WSTransactionStatusStatuses of a transaction.

Valid values are:
  • Declined
  • Approved
  • Error
  • Voided
  • Processed
  • Collected
  • Awaiting_Capture
  • Awaiting_Approval
  • Suspended
  • In_Collection
  • In_Research
  • Disputed
  • Uncollected_NSF
  • Pending
  • Invalid__Closed_Account
  • 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.
wssettlementTypeenum of Type WSSettlementTypeType of transaction.

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.
wspaymentTypeenum of Type WSPaymentTypeType of payment.

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.
wspaymentOriginenum of Type WSPaymentOriginMethod by which the transaction was originated.

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.
wssettlementStatusenum of Type WSSettlementStatusSettlement disposition of a transaction.

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.
wsauthResponseCodeenum of Type WSAuthResponseCodeValid 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.
wsopTypeenum of Type WSOperationTypeTransaction operation types.

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.
faceFeeTypeenum of Type WSFaceFeeTypeValid values are:
  • __None
  • Face
  • Bill_Convenience_Face
  • NSF_Fee
  • Convenience_Fee
  • Bill_Convenience_Fee
beginTransDateDateTimeYThis element represents the date from which to start gathering transaction information.
endTransDateDateTimeYThis element represents the last date to use for gathering transaction information.
fromAmountstringThis element is used in conjunction with toAmount to request either transactions for a specific amount or transactions within an amount range.
toAmountstringThis element is used in conjunction with fromAmount to request either transactions for a specific amount or transactions within an amount range.

Examples​

<soap:Envelope
	xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns:xsd="http://www.w3.org/2001/XMLSchema">
	<soap:Body>
		<GetHistoricalEventWithTransactionDetailReportResponse
			xmlns="https://ssl.selectpayment.com/PV">
			<GetHistoricalEventWithTransactionDetailReportResult>
				<WSEventWithTransactionDetailReport>
					<TransactionStatus>Processed</TransactionStatus>
					<PaymentType>Savings</PaymentType>
					<NameOnAccount>John Doe</NameOnAccount>
					<TransactionNumber>2013-12-18 2:31:11:87040</TransactionNumber>
					<ReferenceNumber>T:HWSB6Y2DF6</ReferenceNumber>
					<CustomerNumber>LG081612-2</CustomerNumber>
					<OperationType>Sale</OperationType>
					<LocationName>ProfitStars</LocationName>
					<TransactionDateTime>2014-10-17T12:28:48</TransactionDateTime>
					<TotalAmount>2.3100</TotalAmount>
					<AccountNumber>0458</AccountNumber>
					<OwnerAppReferenceId>0</OwnerAppReferenceId>
					<EventDateTime>2014-10-17T12:39:10.427</EventDateTime>
					<EventType>Approved</EventType>
					<EventDatastring>Success</EventDatastring>
					<SequenceId>306029968</SequenceId>
					<BatchNumber>12345678</BatchNumber>
					<OriginatedAs>ACH</OriginatedAs>
					<IsDuplicate>False</IsDuplicate>
					<EffectiveDate>2014-10-20T00:00:00</EffectiveDate>
					<FaceFeeType>Face</FaceFeeType>
				</WSEventWithTransactionDetailReport>
				<WSEventWithTransactionDetailReport>
					<TransactionStatus>Processed</TransactionStatus>
					<PaymentType>Savings</PaymentType>
					<NameOnAccount>John Doe</NameOnAccount>
					<TransactionNumber>2013-12-18 2:31:11:87040</TransactionNumber>
					<ReferenceNumber>T:HWSB6Y2DF6</ReferenceNumber>
					<CustomerNumber>LG081612-2</CustomerNumber>
					<OperationType>Sale</OperationType>
					<LocationName>ProfitStars</LocationName>
					<TransactionDateTime>2014-10-17T12:28:48</TransactionDateTime>
					<TotalAmount>2.3100</TotalAmount>
					<AccountNumber>0458</AccountNumber>
					<OwnerAppReferenceId>0</OwnerAppReferenceId>
					<EventDateTime>2014-10-17T14:30:01</EventDateTime>
					<EventType>Processed</EventType>
					<EventDatastring/>
					<SequenceId>306036332</SequenceId>
					<BatchNumber>12345678</BatchNumber>
					<OriginatedAs>ACH</OriginatedAs>
					<IsDuplicate>False</IsDuplicate>
					<EffectiveDate>2014-10-20T00:00:00</EffectiveDate>
					<FaceFeeType>Face</FaceFeeType>
				</WSEventWithTransactionDetailReport>
				<WSEventWithTransactionDetailReport>
					<TransactionStatus>Processed</TransactionStatus>
					<PaymentType>Savings</PaymentType>
					<NameOnAccount>John Doe</NameOnAccount>
					<TransactionNumber>2013-12-18 2:31:11:87040</TransactionNumber>
					<ReferenceNumber>T:HWSB6Y2DF6</ReferenceNumber>
					<CustomerNumber>LG081612-2</CustomerNumber>
					<OperationType>Sale</OperationType>
					<LocationName>ProfitStars</LocationName>
					<TransactionDateTime>2014-10-17T12:28:48</TransactionDateTime>
					<TotalAmount>2.3100</TotalAmount>
					<AccountNumber>0458</AccountNumber>
					<OwnerAppReferenceId>0</OwnerAppReferenceId>
					<EventDateTime>2014-10-20T00:00:00</EventDateTime>
					<EventType>Originated</EventType>
					<EventDatastring/>
					<SequenceId>306036336</SequenceId>
					<BatchNumber>12345678</BatchNumber>
					<OriginatedAs>ACH</OriginatedAs>
					<IsDuplicate>False</IsDuplicate>
					<EffectiveDate>2014-10-20T00:00:00</EffectiveDate>
					<FaceFeeType>Face</FaceFeeType>
				</WSEventWithTransactionDetailReport>
				<WSEventWithTransactionDetailReport>
					<TransactionStatus>Processed</TransactionStatus>
					<PaymentType>Savings</PaymentType>
					<NameOnAccount>John Doe</NameOnAccount>
					<TransactionNumber>2013-12-18 2:31:11:87040</TransactionNumber>
					<ReferenceNumber>T:HWSB6Y2DF6</ReferenceNumber>
					<CustomerNumber>LG081612-2</CustomerNumber>
					<OperationType>Sale</OperationType>
					<LocationName>ProfitStars</LocationName>
					<TransactionDateTime>2014-10-17T12:28:48</TransactionDateTime>
					<TotalAmount>2.3100</TotalAmount>
					<AccountNumber>0458</AccountNumber>
					<OwnerAppReferenceId>0</OwnerAppReferenceId>
					<EventDateTime>2014-10-20T00:00:00</EventDateTime>
					<EventType>Settled</EventType>
					<EventDatastring/>
					<SequenceId>306036340</SequenceId>
					<BatchNumber>12345678</BatchNumber>
					<OriginatedAs>ACH</OriginatedAs>
					<IsDuplicate>False</IsDuplicate>
					<EffectiveDate>2014-10-20T00:00:00</EffectiveDate>
					<FaceFeeType>Face</FaceFeeType>
				</WSEventWithTransactionDetailReport>
				<WSEventWithTransactionDetailReport>
					<TransactionStatus>Processed</TransactionStatus>
					<PaymentType>Checking</PaymentType>
					<NameOnAccount>Jane Doe</NameOnAccount>
					<TransactionNumber>20140122-1:11:88180</TransactionNumber>
					<ReferenceNumber>T:3CVB6Y2DF6</ReferenceNumber>
					<CustomerNumber>7c4c20b5-5ea2-4138-9174-19e3accd3dfa</CustomerNumber>
					<OperationType>Sale</OperationType>
					<LocationName>ProfitStars</LocationName>
					<TransactionDateTime>2014-10-21T08:36:17</TransactionDateTime>
					<TotalAmount>50.0000</TotalAmount>
					<AccountNumber>1154</AccountNumber>
					<OwnerAppReferenceId>0</OwnerAppReferenceId>
					<EventDateTime>2014-10-21T08:36:18.273</EventDateTime>
					<EventType>Approved</EventType>
					<EventDatastring>Success</EventDatastring>
					<SequenceId>306183232</SequenceId>
					<BatchNumber>12345679</BatchNumber>
					<OriginatedAs>ACH</OriginatedAs>
					<IsDuplicate>False</IsDuplicate>
					<EffectiveDate>2014-10-22T00:00:00</EffectiveDate>
					<FaceFeeType>Face</FaceFeeType>
				</WSEventWithTransactionDetailReport>
				<WSEventWithTransactionDetailReport>
					<TransactionStatus>Processed</TransactionStatus>
					<PaymentType>Checking</PaymentType>
					<NameOnAccount>Jane Doe</NameOnAccount>
					<TransactionNumber>20140122-1:11:88180</TransactionNumber>
					<ReferenceNumber>T:3CVB6Y2DF6</ReferenceNumber>
					<CustomerNumber>7c4c20b5-5ea2-4138-9174-19e3accd3dfa</CustomerNumber>
					<OperationType>Sale</OperationType>
					<LocationName>ProfitStars</LocationName>
					<TransactionDateTime>2014-10-21T08:36:17</TransactionDateTime>
					<TotalAmount>50.0000</TotalAmount>
					<AccountNumber>1154</AccountNumber>
					<OwnerAppReferenceId>0</OwnerAppReferenceId>
					<EventDateTime>2014-10-21T10:40:01</EventDateTime>
					<EventType>Processed</EventType>
					<EventDatastring/>
					<SequenceId>306188216</SequenceId>
					<BatchNumber>12345679</BatchNumber>
					<OriginatedAs>ACH</OriginatedAs>
					<IsDuplicate>False</IsDuplicate>
					<EffectiveDate>2014-10-22T00:00:00</EffectiveDate>
					<FaceFeeType>Face</FaceFeeType>
				</WSEventWithTransactionDetailReport>
				<WSEventWithTransactionDetailReport>
					<TransactionStatus>Processed</TransactionStatus>
					<PaymentType>Checking</PaymentType>
					<NameOnAccount>Jane Doe</NameOnAccount>
					<TransactionNumber>20140122-1:11:88180</TransactionNumber>
					<ReferenceNumber>T:3CVB6Y2DF6</ReferenceNumber>
					<CustomerNumber>7c4c20b5-5ea2-4138-9174-19e3accd3dfa</CustomerNumber>
					<OperationType>Sale</OperationType>
					<LocationName>ProfitStars</LocationName>
					<TransactionDateTime>2014-10-21T08:36:17</TransactionDateTime>
					<TotalAmount>50.0000</TotalAmount>
					<AccountNumber>1154</AccountNumber>
					<OwnerAppReferenceId>0</OwnerAppReferenceId>
					<EventDateTime>2014-10-22T00:00:00</EventDateTime>
					<EventType>Originated</EventType>
					<EventDatastring/>
					<SequenceId>306188220</SequenceId>
					<BatchNumber>12345679</BatchNumber>
					<OriginatedAs>ACH</OriginatedAs>
					<IsDuplicate>False</IsDuplicate>
					<EffectiveDate>2014-10-22T00:00:00</EffectiveDate>
					<FaceFeeType>Face</FaceFeeType>
				</WSEventWithTransactionDetailReport>
				<WSEventWithTransactionDetailReport>
					<TransactionStatus>Processed</TransactionStatus>
					<PaymentType>Checking</PaymentType>
					<NameOnAccount>Jane Doe</NameOnAccount>
					<TransactionNumber>20140122-1:11:88180</TransactionNumber>
					<ReferenceNumber>T:3CVB6Y2DF6</ReferenceNumber>
					<CustomerNumber>7c4c20b5-5ea2-4138-9174-19e3accd3dfa</CustomerNumber>
					<OperationType>Sale</OperationType>
					<LocationName>ProfitStars</LocationName>
					<TransactionDateTime>2014-10-21T08:36:17</TransactionDateTime>
					<TotalAmount>50.0000</TotalAmount>
					<AccountNumber>1154</AccountNumber>
					<OwnerAppReferenceId>0</OwnerAppReferenceId>
					<EventDateTime>2014-10-22T00:00:00</EventDateTime>
					<EventType>Settled</EventType>
					<EventDatastring/>
					<SequenceId>306188224</SequenceId>
					<BatchNumber>12345679</BatchNumber>
					<OriginatedAs>ACH</OriginatedAs>
					<IsDuplicate>False</IsDuplicate>
					<EffectiveDate>2014-10-22T00:00:00</EffectiveDate>
					<FaceFeeType>Face</FaceFeeType>
				</WSEventWithTransactionDetailReport>
			</GetHistoricalEventWithTransactionDetailReportResult>
		</GetHistoricalEventWithTransactionDetailReportResponse>
	</soap:Body>
</soap:Envelope>