Class GetHistoricalEventReportRequest
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:
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. | |
| wstransEvent | enum of Type WSTransactionEvent | Y | Events by which a transaction could be affected. Valid values are:
| |
| wstransStatus | enum of Type WSTransactionStatus | Statuses of a transaction. (See - Optional Data Elements) Valid values are:
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:
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:
| ||
| wspaymentOrigin | enum of Type WSPaymentOrigin | Method by which the transaction was originated. (See - Optional Data Elements) Valid values are:
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:
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:
| ||
| wsopType | enum of Type WSOperationType | Transaction operation types. (See - Optional Data Elements) Valid values are:
| ||
| 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. |
Examples
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pv="https://ssl.selectpayment.com/PV">
<soapenv:Header>
<pv:SecurityHeader>
<pv:BinarySecurityToken>your security token here</pv:BinarySecurityToken>
</pv:SecurityHeader>
</soapenv:Header>
<soapenv:Body>
<pv:GetHistoricalEventReport>
<pv:storeId>0</pv:storeId>
<pv:storeKey isNull="false"/>
<pv:entityId>123456</pv:entityId>
<pv:wsdisplayFields>Name_On_Account</pv:wsdisplayFields>
<pv:locationIds>0656513</pv:locationIds>
<pv:wstransEvent>Declined</pv:wstransEvent>
<pv:wstransStatus>Declined</pv:wstransStatus>
<pv:wssettlementType>ACH</pv:wssettlementType>
<pv:wspaymentType>__NONE</pv:wspaymentType>
<pv:wspaymentOrigin>Internet</pv:wspaymentOrigin>
<pv:wssettlementStatus>No_Settlement_Needed</pv:wssettlementStatus>
<pv:wsauthResponseCode>Success</pv:wsauthResponseCode>
<pv:wsopType>Sale<pv:/wsopType>
<pv:beginTransDate>12/18/2025 2:18:32 PM</pv:beginTransDate>
<pv:endTransDate>12/18/2025 2:18:32 PM</pv:endTransDate>
<pv:fromAmount>0.01</pv:fromAmount>
<pv:toAmount>10000.00</pv:toAmount>
</MethodParameters>
</GetHistoricalEventReport>