Service Location:
For SOAP connections:
https://<assigned domain>/paygate/ws/trxdetail.asmx?op=GetOpenBatchSummary
For standard HTTPS connections:
https://<assigned domain>/paygate/ws/trxdetail.asmx/GetOpenBatchSummary?
Description:
This web service retrieves a payment
type transaction summary of the current open batch for a specified
merchant.
Developer
Notes:
Date
Formats: Dates entered through input parameters are automatically formatted to
YYYY-MM-DD. Valid entry formats are:
• MM/DD/YYYY
• YYYY-MM-DD
Date Query String: The query string used to obtain transactions in a date range is constructed as follows:
(Date DT >=BeginDt) AND (Date DT <EndDt)
*Date DT is
the transaction timestamp.
Input Parameters:
O = Optional, R = Required
|
Parameter Name |
Opt/Req |
Description |
|
UserName |
R |
User name assigned in the payment server. The user must have an appropriate level of access within the system in order to return records.
|
|
Password |
R |
Password associated with the user name provided.
|
|
RPNum |
R |
Unique numeric value used to identify the merchant for the query. The RPNum is assigned by the gateway and acts as the primary key for the merchant table.
Note: RPNum may also be called Merchant ID, Merchant Number, or Vendor Key.
|
|
BeginDt |
R |
Identifies the beginning date range for a group of transactions. |
|
EndDt |
R |
Identifies the ending date range for a group of transactions. |
|
ExtData |
|
The ExtData parameter allows you to pass additional information to the web service that is not covered under the input parameters. ExtData values need not be placed in any particular order; however, they must be properly formatted using XML tags. Extended data in XML format. Valid values are: • <Timezone>Timezone</Timezone> - Used to convert the input and output (where applicable) date/time values to the desired timezone. When specified, the same timezone is used to convert the begin/end date parameters as well as the Date and Last Update output values. This field is optional, and if omitted all date/time values are treated as UTC. Daylight savings time adjustments, where applicable, are handled automatically. Accepted values are: § AKST – Alaskan Standard Time § CST – Central Standard Time § EST – Eastern Standard Time § HST – Hawaiian Standard Time § MST – Mountain Standard Time § AZMST – Arizona § PST – Pacific Standard Time |