Function: PaymentsBetweenDates

The PaymentsBetweenDates function returns the payment amounts that are "submitted", "pending" or "rejected" between specific dates.

The following is a sample SOAP 1.2 request and response. In the request, you need to replace the data types in yellow with actual values.

SOAP 1.2: Request

POST /v2/payeefunctions.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>

<PaymentsBetweenDates xmlns="http://Tipalti.org/">

<payerName>string</payerName>

<idap>string</idap>

<timestamp>double</timestamp>

<from>double</from>

<to>double</to>

<key>string</key>

</PaymentsBetweenDates>

</soap12:Body>

</soap12:Envelope>

SOAP 1.2: Response

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>

<PaymentsBetweenDatesResponse xmlns="http://Tipalti.org/">

<PaymentsBetweenDatesResult>

<errorMessage>string</errorMessage>

<errorCode>string</errorCode>

<submittedTotal>double</submittedTotal>

<pendingTotal>double</pendingTotal>

<rejectedTotal>double</rejectedTotal>

<skippedTotal>double</skippedTotal>

</PaymentsBetweenDatesResult>

</PaymentsBetweenDatesResponse>

</soap12:Body>

</soap12:Envelope>

Request parameters

Element

description

limitation

Mandatory?

data type
payerName The name of the payer, as assigned by Tipalti
  • Max. length = 50
  • Value is case sensitive
 Mandatory string
idap Unique payee identifier (the payee ID)
  • Max. length = 64
  • Valid characters:
    • Numbers
    • Letters
    • Commas
    • Periods
    • Underscores
    • Dashes
  • No spaces allowed
 Mandatory string
timestamp

Current time (UTC) when the request is sent

 Unix time Mandatory double
from Start of date range Unix time Mandatory double
to End of date range Unix time Mandatory double
key Encryption key   Mandatory string

Response parameters

The result of the PaymentsBetweenDates function is provided in the "submittedTotal", "pendingTotal", "rejectedTotal" or "skippedTotal" parameters.

element

description

data type
PaymentsBetweenDatesResult Contains the response parameters TipaltiPaymentQueryResponse

TipaltiPaymentQueryResponse

element

description

Limitations

data type
errorMessage A description of the error See API error codes. string
errorCode The status of the error See API error codes. string
submittedTotal Amount submitted for payment within a date range   double
pendingTotal Amount pending payment within a date range   double
rejectedTotal Amount rejected within a date range   double
skippedTotal Amount skipped within a date range   double