TrxDetail Web Service

TrxDetail

Click here for a complete list of operations.

GetOpenBatchSummary

Retrieves Payment Type transaction summary of the current open batch for a specific merchant.
Required parameters are in bold.
Parameter Value
UserName Required: User Name
Password Required: Password
RPNum Required: The merchant's RP Number, the query will be run against this merchant's account.
BeginDt Optional query field: The begin date of the date range in MM/DD/YYYY format. This date will be converted to MM/DD/YYYYT00:00:00:0000AM
EndDt Optional query field: The end date of the date range in MM/DD/YYYY format. This date will be converted to MM/DD/YYYYT12:59:59:9999PM
ExtData Optional: Extended Data in XML

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

Parameter	Value
username:
password:
rpNum:
beginDt:
endDt:
extData:

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /admin/ws/trxdetail.asmx HTTP/1.1
Host: secure.ftipgw.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://demo.tpisoft.com/Admin/ws/GetOpenBatchSummary"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetOpenBatchSummary xmlns="http://demo.tpisoft.com/Admin/ws">
      <username>string</username>
      <password>string</password>
      <rpNum>string</rpNum>
      <beginDt>string</beginDt>
      <endDt>string</endDt>
      <extData>string</extData>
    </GetOpenBatchSummary>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetOpenBatchSummaryResponse xmlns="http://demo.tpisoft.com/Admin/ws">
      <GetOpenBatchSummaryResult>string</GetOpenBatchSummaryResult>
    </GetOpenBatchSummaryResponse>
  </soap:Body>
</soap:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /admin/ws/trxdetail.asmx/GetOpenBatchSummary?username=string&password=string&rpNum=string&beginDt=string&endDt=string&extData=string HTTP/1.1
Host: secure.ftipgw.com

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<string xmlns="http://demo.tpisoft.com/Admin/ws">string</string>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /admin/ws/trxdetail.asmx/GetOpenBatchSummary HTTP/1.1
Host: secure.ftipgw.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

username=string&password=string&rpNum=string&beginDt=string&endDt=string&extData=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<string xmlns="http://demo.tpisoft.com/Admin/ws">string</string>

Parameter	Value
UserName	Required: User Name
Password	Required: Password
RPNum	Required: The merchant's RP Number, the query will be run against this merchant's account.
BeginDt	Optional query field: The begin date of the date range in MM/DD/YYYY format. This date will be converted to MM/DD/YYYYT00:00:00:0000AM
EndDt	Optional query field: The end date of the date range in MM/DD/YYYY format. This date will be converted to MM/DD/YYYYT12:59:59:9999PM
ExtData	Optional: Extended Data in XML