Function: PayeeUpdateEmail
The PayeeUpdateEmail function updates the payee's email address for communication.
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 /v14/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>
<PayeeUpdateEmail xmlns="http://Tipalti.org/">
<payerName>string</payerName>
<idap>string</idap>
<timestamp>double</timestamp>
<key>string</key>
<email>string</email>
</PayeeUpdateEmail>
</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>
<PayeeUpdateEmailResponse xmlns="http://Tipalti.org/">
<PayeeUpdateEmailResult>
<errorMessage>string</errorMessage>
<errorCode>string</errorCode>
<b>boolean</b>
<i>integer</i>
<d>double</d>
<s>string</s>
</PayeeUpdateEmailResult>
</PayeeUpdateEmailResponse>
</soap12:Body>
</soap12:Envelope>
Request parameters
Response parameters
The result of the PayeeUpdateEmail function is provided in the "b" parameter.
|
Element |
description |
data type |
|---|---|---|
| PayeeUpdateEmailResult | Contains the response parameters | TipaltiResponse |
TipaltiResponse
|
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 |