Function: UpdatePayeeCustomFields

The UpdatePayeeCustomFields function updates/ sets the values of payee custom fields that have been defined by the payer.

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>

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

<payerName>string</payerName>

<idap>string</idap>

<timestamp>double</timestamp>

<key>string</key>

<customFieldsValues>

<KeyValuePair>

<Key>string</Key>

<Value>string</Value>

</KeyValuePair>

<KeyValuePair>

<Key>string</Key>

<Value>string</Value>

</KeyValuePair>

</customFieldsValues>

</UpdatePayeeCustomFields>

</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>

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

<UpdatePayeeCustomFieldsResult>

<errorMessage>string</errorMessage>

<errorCode>string</errorCode>

<b>boolean</b>

<i>integer</i>

<d>double</d>

<s>string</s>

</UpdatePayeeCustomFieldsResult>

</UpdatePayeeCustomFieldsResponse>

</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
key Encryption key   Mandatory string
customFieldsValues List of values for custom fields
  • For <Key> limitations, see the "Name" field of Custom field limitations.
  • For "free text" entries, max. length = 140 for <Value>.
  • For "list" entries, only one value per key is allowed. Use the unique ID of the list item for the <Value> (see List value limitations).
  • For "list (multiple selection)" entries, multiple values per key are allowed. Use the unique ID of each list item for <Value> (see List value limitations).
 Mandatory Array of KeyValuePair

KeyValuePair

Element

description

Mandatory?

data type
Key Name of field Optional string
Value Value of field Optional string

To define a payee's custom username, use the object "shortname"; for example:
<Key>shortname</Key>
<Value>Example Name</Value>

Response parameters

element

description

data type
UpdatePayeeCustomFieldsResult 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