TipaltiPayerSOAPV5


Click here for a complete list of operations.

CreatePaymentOrdersReport

Create payment orders report. Return value is the report file name that is written to the SFTP folder.
The details file format may change over time. Columns may be added. When reading the file ensure you have functionality that can ignore new, additional, columns.
The report is on all the payment orders between startTime and endTime parameters.
EAT - none

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
payerName:
timestamp:
key:
startTime:
endTime:

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 /v5/PayerFunctions.asmx HTTP/1.1
Host: api.tipalti.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://Tipalti.org/CreatePaymentOrdersReport"

<?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>
    <CreatePaymentOrdersReport xmlns="http://Tipalti.org/">
      <payerName>string</payerName>
      <timestamp>double</timestamp>
      <key>string</key>
      <startTime>dateTime</startTime>
      <endTime>dateTime</endTime>
    </CreatePaymentOrdersReport>
  </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>
    <CreatePaymentOrdersReportResponse xmlns="http://Tipalti.org/">
      <CreatePaymentOrdersReportResult>
        <errorMessage>string</errorMessage>
        <errorCode>int</errorCode>
        <resultsFile>string</resultsFile>
      </CreatePaymentOrdersReportResult>
    </CreatePaymentOrdersReportResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

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

POST /v5/PayerFunctions.asmx HTTP/1.1
Host: api.tipalti.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <CreatePaymentOrdersReport xmlns="http://Tipalti.org/">
      <payerName>string</payerName>
      <timestamp>double</timestamp>
      <key>string</key>
      <startTime>dateTime</startTime>
      <endTime>dateTime</endTime>
    </CreatePaymentOrdersReport>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <CreatePaymentOrdersReportResponse xmlns="http://Tipalti.org/">
      <CreatePaymentOrdersReportResult>
        <errorMessage>string</errorMessage>
        <errorCode>int</errorCode>
        <resultsFile>string</resultsFile>
      </CreatePaymentOrdersReportResult>
    </CreatePaymentOrdersReportResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP POST

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

POST /v5/PayerFunctions.asmx/CreatePaymentOrdersReport HTTP/1.1
Host: api.tipalti.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

payerName=string&timestamp=string&key=string&startTime=string&endTime=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<TipaltiReportResponse xmlns="http://Tipalti.org/">
  <errorMessage>string</errorMessage>
  <errorCode>int</errorCode>
  <resultsFile>string</resultsFile>
</TipaltiReportResponse>