TipaltiPayerSOAPV5 Web Service

TipaltiPayerSOAPV5

Click here for a complete list of operations.

CreateOrUpdateCustomFields

Create update or delete custom fields. Custom fields type can be created as: .
1. Free text - the user can enter any free text.
2. Unique text - the value can enter any text. The value will be validated as unique.
3. Multiple values - the user can select multiple values from a predefined list of values.
4. List of values - the user can select a single value from a predefined list of values.
EAT - null

Test

The test form is only available for methods with primitive types as parameters.

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

<?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>
    <CreateOrUpdateCustomFields xmlns="http://Tipalti.org/">
      <payerName>string</payerName>
      <timestamp>double</timestamp>
      <key>string</key>
      <customFieldInfo>
        <TipaltiCustomField>
          <Title>string</Title>
          <Description>string</Description>
          <Action>CreateOrUpdate or Delete</Action>
          <Entity>PaymentOrder or Payee or Invoice</Entity>
          <SubEntity>Bill or BillLine</SubEntity>
          <Type>FreeText or UniqueText or MultipleValues or ListOfValues</Type>
          <IframeDisplay>boolean</IframeDisplay>
          <Values>
            <CustomFieldValue xsi:nil="true" />
            <CustomFieldValue xsi:nil="true" />
          </Values>
        </TipaltiCustomField>
        <TipaltiCustomField>
          <Title>string</Title>
          <Description>string</Description>
          <Action>CreateOrUpdate or Delete</Action>
          <Entity>PaymentOrder or Payee or Invoice</Entity>
          <SubEntity>Bill or BillLine</SubEntity>
          <Type>FreeText or UniqueText or MultipleValues or ListOfValues</Type>
          <IframeDisplay>boolean</IframeDisplay>
          <Values>
            <CustomFieldValue xsi:nil="true" />
            <CustomFieldValue xsi:nil="true" />
          </Values>
        </TipaltiCustomField>
      </customFieldInfo>
    </CreateOrUpdateCustomFields>
  </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>
    <CreateOrUpdateCustomFieldsResponse xmlns="http://Tipalti.org/">
      <CreateOrUpdateCustomFieldsResult>
        <CustomFieldUpdateResult>
          <TipaltiCustomFieldUpdateResponse>
            <Result>Other or Success or FieldDoesntExist or DuplicateField or EmptyTitle or TooLongTitle or IllegalCharsTitle or RestrictedTitle or EmptyMultiValueSelectionField or MultiValuesAreNotUnique or ValueTypeNotSupported or UnknownPayerEntity</Result>
            <Message>string</Message>
            <CustomField xsi:nil="true" />
          </TipaltiCustomFieldUpdateResponse>
          <TipaltiCustomFieldUpdateResponse>
            <Result>Other or Success or FieldDoesntExist or DuplicateField or EmptyTitle or TooLongTitle or IllegalCharsTitle or RestrictedTitle or EmptyMultiValueSelectionField or MultiValuesAreNotUnique or ValueTypeNotSupported or UnknownPayerEntity</Result>
            <Message>string</Message>
            <CustomField xsi:nil="true" />
          </TipaltiCustomFieldUpdateResponse>
        </CustomFieldUpdateResult>
      </CreateOrUpdateCustomFieldsResult>
    </CreateOrUpdateCustomFieldsResponse>
  </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>
    <CreateOrUpdateCustomFields xmlns="http://Tipalti.org/">
      <payerName>string</payerName>
      <timestamp>double</timestamp>
      <key>string</key>
      <customFieldInfo>
        <TipaltiCustomField>
          <Title>string</Title>
          <Description>string</Description>
          <Action>CreateOrUpdate or Delete</Action>
          <Entity>PaymentOrder or Payee or Invoice</Entity>
          <SubEntity>Bill or BillLine</SubEntity>
          <Type>FreeText or UniqueText or MultipleValues or ListOfValues</Type>
          <IframeDisplay>boolean</IframeDisplay>
          <Values>
            <CustomFieldValue xsi:nil="true" />
            <CustomFieldValue xsi:nil="true" />
          </Values>
        </TipaltiCustomField>
        <TipaltiCustomField>
          <Title>string</Title>
          <Description>string</Description>
          <Action>CreateOrUpdate or Delete</Action>
          <Entity>PaymentOrder or Payee or Invoice</Entity>
          <SubEntity>Bill or BillLine</SubEntity>
          <Type>FreeText or UniqueText or MultipleValues or ListOfValues</Type>
          <IframeDisplay>boolean</IframeDisplay>
          <Values>
            <CustomFieldValue xsi:nil="true" />
            <CustomFieldValue xsi:nil="true" />
          </Values>
        </TipaltiCustomField>
      </customFieldInfo>
    </CreateOrUpdateCustomFields>
  </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>
    <CreateOrUpdateCustomFieldsResponse xmlns="http://Tipalti.org/">
      <CreateOrUpdateCustomFieldsResult>
        <CustomFieldUpdateResult>
          <TipaltiCustomFieldUpdateResponse>
            <Result>Other or Success or FieldDoesntExist or DuplicateField or EmptyTitle or TooLongTitle or IllegalCharsTitle or RestrictedTitle or EmptyMultiValueSelectionField or MultiValuesAreNotUnique or ValueTypeNotSupported or UnknownPayerEntity</Result>
            <Message>string</Message>
            <CustomField xsi:nil="true" />
          </TipaltiCustomFieldUpdateResponse>
          <TipaltiCustomFieldUpdateResponse>
            <Result>Other or Success or FieldDoesntExist or DuplicateField or EmptyTitle or TooLongTitle or IllegalCharsTitle or RestrictedTitle or EmptyMultiValueSelectionField or MultiValuesAreNotUnique or ValueTypeNotSupported or UnknownPayerEntity</Result>
            <Message>string</Message>
            <CustomField xsi:nil="true" />
          </TipaltiCustomFieldUpdateResponse>
        </CustomFieldUpdateResult>
      </CreateOrUpdateCustomFieldsResult>
    </CreateOrUpdateCustomFieldsResponse>
  </soap12:Body>
</soap12:Envelope>