TrxDetail Web Service

TrxDetail

Click here for a complete list of operations.

GetReturnedCheckReport

Retrieves returned checks report for a merchant.
Required parameters are in bold.
Parameter Value
UserName Required: User Name
Password Required: Password
MerchantKey Required: Merchant key for which to pull the report
BeginDt Required 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. If not provided, end date will be midnight of beginning date.
ExtData Optional: Extended Data in XML, Valid Values are: Future Use

Test

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

Parameter	Value
UserName:
Password:
MerchantKey:
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/GetReturnedCheckReport"

<?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>
    <GetReturnedCheckReport xmlns="http://demo.tpisoft.com/Admin/ws">
      <UserName>string</UserName>
      <Password>string</Password>
      <MerchantKey>string</MerchantKey>
      <BeginDt>string</BeginDt>
      <EndDt>string</EndDt>
      <ExtData>string</ExtData>
    </GetReturnedCheckReport>
  </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>
    <GetReturnedCheckReportResponse xmlns="http://demo.tpisoft.com/Admin/ws">
      <GetReturnedCheckReportResult>xml</GetReturnedCheckReportResult>
    </GetReturnedCheckReportResponse>
  </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/GetReturnedCheckReport?UserName=string&Password=string&MerchantKey=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"?>
xml

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/GetReturnedCheckReport HTTP/1.1
Host: secure.ftipgw.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

UserName=string&Password=string&MerchantKey=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"?>
xml

Parameter	Value
UserName	Required: User Name
Password	Required: Password
MerchantKey	Required: Merchant key for which to pull the report
BeginDt	Required 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. If not provided, end date will be midnight of beginning date.
ExtData	Optional: Extended Data in XML, Valid Values are: Future Use