Function: GetUpdatedPayments
The GetUpdatedPayments function returns reference codes of payment orders that have been updated after a given date.
- EAT Encryption Additional Terms parameter: None
- API version: V6
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 /v6/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>
<GetUpdatedPayments xmlns="http://Tipalti.org/">
<payerName>string</payerName>
<timestamp>double</timestamp>
<key>string</key>
<changedSince>double</changedSince>
</GetUpdatedPayments>
</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>
<GetUpdatedPaymentsResponse xmlns="http://Tipalti.org/">
<GetUpdatedPaymentsResult>
<errorMessage>string</errorMessage>
<errorCode>string</errorCode>
<b>boolean</b>
<i>integer</i>
<d>double</d>
<s>string</s>
<ChangedPaymentOrdersRefCode>
<string>string</string>
<string>string</string>
</ChangedPaymentOrdersRefCode>
<ChangedPaymentOrdersRefCode>
<string>string</string>
<string>string</string>
</ChangedPaymentOrdersRefCode>
</GetUpdatedPaymentsResult>
</GetUpdatedPaymentsResponse>
</soap12:Body>
</soap12:Envelope>
Request parameters
|
Element |
Description |
Limitation |
Mandatory? |
Data type |
|---|---|---|---|---|
| payerName | The name of the payer, as assigned by Tipalti |
|
Mandatory | string |
| timestamp |
Current time (UTC) when the request is sent |
Unix time | Mandatory | double |
| key | Encryption key | Mandatory | string | |
| changedSince | The starting date to return all updated payment orders | Unix time | Mandatory | double |
Response parameters
|
Element |
Description |
Data type |
|---|---|---|
| GetUpdatedPaymentsResult | Contains the response parameters | TipaltiGetUpdatedPaymentsResponse (extension of type TipaltiResponse) |
TipaltiGetUpdatedPaymentsResponse
|
Element |
Description |
Limitation |
Data Type |
|---|---|---|---|
| errorMessage | A description of the error | See API error codes. | string |
| errorCode | The status of the error | See API error codes. | string |
| b | If the return code is Boolean, this parameter will carry the value. | boolean | |
| i | If the return code is integer, this parameter will carry the value. | integer | |
| d | If the return code is double, this parameter will carry the value. | double | |
| s | If the return code is string, this parameter will carry the value. | string | |
| ChangedPaymentOrdersRefCode |
List of payment order reference codes |
Array of string |
string
|
element |
description |
limitation |
data type |
|---|---|---|---|
| string | The reference code for the payment order |
|
string |