Skip to main content

Class GetTransactionReportRequest

Properties​

NAMETYPELENGTHREQUIREDDESCRIPTION
storeIdlongYUnique user ID generated by EPS. (See - Required Data Elements)
storeKeystringYUnique password generated by EPS. (See - Required Data Elements)
entityIdintYUnique identifier that is generated by EPS. (See - Required Data Elements)
wsdisplayFieldsenum of Type WSDisplayFieldsYAvailable fields that can be included in the report. (See - Required Data Elements)

Valid values are:
  • Transaction_DateTime (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 (Not Used)
  • Event_Type_Name (Not Used)
  • Event_Datastring (Not Used)
  • __NONE
  • OwnerApplication
  • ReceivingApplication
  • OwnerAppReferenceId
  • ReturnCode (Not Used)
  • Notice_Of_Change (Not Used)
  • 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 with data.

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. (See - Required Data Elements)

This element will be repeated for each location requested.
wstransStatusenum of Type WSTransactionStatusStatuses 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
  • 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. (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.
wspaymentTypeenum of Type WSPaymentTypeType 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.
wspaymentOriginenum of Type WSPaymentOriginMethod 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
  • Represented_Check
  • __NONE (All payment origins)


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. (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.
wsauthResponseCodeenum 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.
wsopTypeenum of Type WSOperationTypeTransaction 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.
beginTransDateDateTimeYThis element represents the transaction date from which to start gathering transaction information.
endTransDateDateTimeYThis element represents the last transaction date to use for gathering transaction information.
wsdateTypeenum of Type WSReportDateTypeYThis element designates which date to use for determining which transactions to list.

Valid Values are:
  • Transactions_Created
  • Effective_Dates
  • __NONE


Note: If __NONE is used, beginTransDate and endTransDate values will be disregarded.
fromAmountstringThis element is used in conjunction with toAmount to request transactions for a specific amount or transactions within an amount range.
toAmountstringThis element is used in conjunction with fromAmount to request transactions for a specific amount or transactions within an amount range.

Examples​

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:pv="https://ssl.selectpayment.com/PV">
	<soapenv:Header/>
	<soapenv:Body>
		<pv:GetTransactionReport>
			<pv:storeId>12334</pv:storeId>
			<pv:storeKey>3z9em9oxqwX3acsaqc6H0ck8D3Yj</pv:storeKey>
			<pv:entityId>12345</pv:entityId>
			<pv:wsdisplayFields>
				<!--Zero or more repetitions:-->
				<pv:WSDisplayFields>Auth_Response_Type_Name</pv:WSDisplayFields>
				<pv:WSDisplayFields>Payment_Origin_Name</pv:WSDisplayFields>
				<pv:WSDisplayFields>Settlement_Status_Name</pv:WSDisplayFields>
				<pv:WSDisplayFields>Display_Account_Number</pv:WSDisplayFields>
				<pv:WSDisplayFields>Check_Number</pv:WSDisplayFields>
				<pv:WSDisplayFields>Cust_Field_1</pv:WSDisplayFields>
				<pv:WSDisplayFields>Cust_Field_2</pv:WSDisplayFields>
				<pv:WSDisplayFields>Cust_Field_3</pv:WSDisplayFields>
				<pv:WSDisplayFields>Field_1</pv:WSDisplayFields>
				<pv:WSDisplayFields>Field_2</pv:WSDisplayFields>
				<pv:WSDisplayFields>Field_3</pv:WSDisplayFields>
				<pv:WSDisplayFields>Third_Party_Reference_Number</pv:WSDisplayFields>
				<pv:WSDisplayFields>Audit_User_Name</pv:WSDisplayFields>
				<pv:WSDisplayFields>OwnerApplication</pv:WSDisplayFields>
				<pv:WSDisplayFields>ReceivingApplication</pv:WSDisplayFields>
				<pv:WSDisplayFields>OwnerAppReferenceId</pv:WSDisplayFields>
			</pv:wsdisplayFields>
			<pv:locationIds>
				<!--Zero or more repetitions:-->
				<pv:int>11346</pv:int>
			</pv:locationIds>
			<pv:wstransStatus>
				<!--Zero or more repetitions:-->
				<pv:WSTransactionStatus>__NONE</pv:WSTransactionStatus>
			</pv:wstransStatus>
			<pv:wssettlementType>
				<!--Zero or more repetitions:-->
				<pv:WSSettlementType>None</pv:WSSettlementType>
			</pv:wssettlementType>
			<pv:wspaymentType>__NONE</pv:wspaymentType>
			<pv:wspaymentOrigin>
				<!--Zero or more repetitions:-->
				<pv:WSPaymentOrigin>__NONE</pv:WSPaymentOrigin>
			</pv:wspaymentOrigin>
			<pv:wssettlementStatus>
				<!--Zero or more repetitions:-->
				<pv:WSSettlementStatus>__NONE</pv:WSSettlementStatus>
			</pv:wssettlementStatus>
			<pv:wsauthResponseCode>__NONE</pv:wsauthResponseCode>
			<pv:wsopType>__NONE</pv:wsopType>
			<pv:beginTransDate>2012-04-25</pv:beginTransDate>
			<pv:endTransDate>2012-05-03</pv:endTransDate>
			<pv:wsdateType>Effective_Dates</pv:wsdateType>
			<pv:fromAmount></pv:fromAmount>
			<pv:toAmount></pv:toAmount>
		</pv:GetTransactionReport>
	</soapenv:Body>
</soapenv:Envelope>