TipaltiPayerSOAPV5 Web Service

TipaltiPayerSOAPV5

Click here for a complete list of operations.

TestPayments

Test payments in a list.
Return value includes warnings and errors.
Payment list can be no more than 250 item long. NO PAYMENTS WILL BE EXECUTED
EAT - paymentGroupTitle

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

<?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>
    <TestPayments xmlns="http://Tipalti.org/">
      <payerName>string</payerName>
      <paymentGroupTitle>string</paymentGroupTitle>
      <tipaltiPaymentsOrders>
        <TipaltiPaymentOrderItem>
          <Idap>string</Idap>
          <Amount>double</Amount>
          <RefCode>string</RefCode>
          <EWalletMessage>string</EWalletMessage>
          <IgnoreThresholds>boolean</IgnoreThresholds>
          <BankingMessage>string</BankingMessage>
          <EmailMessage>string</EmailMessage>
          <Currency>string</Currency>
          <ScheduledDate>dateTime</ScheduledDate>
          <IsScheduledVisible>boolean</IsScheduledVisible>
          <IgnoreRiskCases>boolean</IgnoreRiskCases>
          <CustomFields>
            <KeyValuePair xsi:nil="true" />
            <KeyValuePair xsi:nil="true" />
          </CustomFields>
          <IgnoreTaxValidation>boolean</IgnoreTaxValidation>
          <MaxWithholding>boolean</MaxWithholding>
          <IncomeType>string</IncomeType>
          <TreatyLimitExceeded>boolean</TreatyLimitExceeded>
          <AdditionalWithholding>string</AdditionalWithholding>
          <UsSource>string</UsSource>
        </TipaltiPaymentOrderItem>
        <TipaltiPaymentOrderItem>
          <Idap>string</Idap>
          <Amount>double</Amount>
          <RefCode>string</RefCode>
          <EWalletMessage>string</EWalletMessage>
          <IgnoreThresholds>boolean</IgnoreThresholds>
          <BankingMessage>string</BankingMessage>
          <EmailMessage>string</EmailMessage>
          <Currency>string</Currency>
          <ScheduledDate>dateTime</ScheduledDate>
          <IsScheduledVisible>boolean</IsScheduledVisible>
          <IgnoreRiskCases>boolean</IgnoreRiskCases>
          <CustomFields>
            <KeyValuePair xsi:nil="true" />
            <KeyValuePair xsi:nil="true" />
          </CustomFields>
          <IgnoreTaxValidation>boolean</IgnoreTaxValidation>
          <MaxWithholding>boolean</MaxWithholding>
          <IncomeType>string</IncomeType>
          <TreatyLimitExceeded>boolean</TreatyLimitExceeded>
          <AdditionalWithholding>string</AdditionalWithholding>
          <UsSource>string</UsSource>
        </TipaltiPaymentOrderItem>
      </tipaltiPaymentsOrders>
      <timeStamp>double</timeStamp>
      <key>string</key>
    </TestPayments>
  </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>
    <TestPaymentsResponse xmlns="http://Tipalti.org/">
      <TestPaymentsResult>
        <errorMessage>string</errorMessage>
        <errorCode>int</errorCode>
        <linesResults>
          <ExpandedLineResult>
            <status>OK or Warning or Error</status>
            <paymentOrderStatus>string</paymentOrderStatus>
            <message>string</message>
            <refCode>string</refCode>
            <lineErrorOrWarningType>int</lineErrorOrWarningType>
          </ExpandedLineResult>
          <ExpandedLineResult>
            <status>OK or Warning or Error</status>
            <paymentOrderStatus>string</paymentOrderStatus>
            <message>string</message>
            <refCode>string</refCode>
            <lineErrorOrWarningType>int</lineErrorOrWarningType>
          </ExpandedLineResult>
        </linesResults>
        <summary>
          <TipaltiProcessPaymentsSummary>
            <accountType>int</accountType>
            <accountCurrency>string</accountCurrency>
            <fundsRequired>double</fundsRequired>
            <outstandingAmount>double</outstandingAmount>
            <tipaltiSummaryAmounts xsi:nil="true" />
          </TipaltiProcessPaymentsSummary>
          <TipaltiProcessPaymentsSummary>
            <accountType>int</accountType>
            <accountCurrency>string</accountCurrency>
            <fundsRequired>double</fundsRequired>
            <outstandingAmount>double</outstandingAmount>
            <tipaltiSummaryAmounts xsi:nil="true" />
          </TipaltiProcessPaymentsSummary>
        </summary>
      </TestPaymentsResult>
    </TestPaymentsResponse>
  </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>
    <TestPayments xmlns="http://Tipalti.org/">
      <payerName>string</payerName>
      <paymentGroupTitle>string</paymentGroupTitle>
      <tipaltiPaymentsOrders>
        <TipaltiPaymentOrderItem>
          <Idap>string</Idap>
          <Amount>double</Amount>
          <RefCode>string</RefCode>
          <EWalletMessage>string</EWalletMessage>
          <IgnoreThresholds>boolean</IgnoreThresholds>
          <BankingMessage>string</BankingMessage>
          <EmailMessage>string</EmailMessage>
          <Currency>string</Currency>
          <ScheduledDate>dateTime</ScheduledDate>
          <IsScheduledVisible>boolean</IsScheduledVisible>
          <IgnoreRiskCases>boolean</IgnoreRiskCases>
          <CustomFields>
            <KeyValuePair xsi:nil="true" />
            <KeyValuePair xsi:nil="true" />
          </CustomFields>
          <IgnoreTaxValidation>boolean</IgnoreTaxValidation>
          <MaxWithholding>boolean</MaxWithholding>
          <IncomeType>string</IncomeType>
          <TreatyLimitExceeded>boolean</TreatyLimitExceeded>
          <AdditionalWithholding>string</AdditionalWithholding>
          <UsSource>string</UsSource>
        </TipaltiPaymentOrderItem>
        <TipaltiPaymentOrderItem>
          <Idap>string</Idap>
          <Amount>double</Amount>
          <RefCode>string</RefCode>
          <EWalletMessage>string</EWalletMessage>
          <IgnoreThresholds>boolean</IgnoreThresholds>
          <BankingMessage>string</BankingMessage>
          <EmailMessage>string</EmailMessage>
          <Currency>string</Currency>
          <ScheduledDate>dateTime</ScheduledDate>
          <IsScheduledVisible>boolean</IsScheduledVisible>
          <IgnoreRiskCases>boolean</IgnoreRiskCases>
          <CustomFields>
            <KeyValuePair xsi:nil="true" />
            <KeyValuePair xsi:nil="true" />
          </CustomFields>
          <IgnoreTaxValidation>boolean</IgnoreTaxValidation>
          <MaxWithholding>boolean</MaxWithholding>
          <IncomeType>string</IncomeType>
          <TreatyLimitExceeded>boolean</TreatyLimitExceeded>
          <AdditionalWithholding>string</AdditionalWithholding>
          <UsSource>string</UsSource>
        </TipaltiPaymentOrderItem>
      </tipaltiPaymentsOrders>
      <timeStamp>double</timeStamp>
      <key>string</key>
    </TestPayments>
  </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>
    <TestPaymentsResponse xmlns="http://Tipalti.org/">
      <TestPaymentsResult>
        <errorMessage>string</errorMessage>
        <errorCode>int</errorCode>
        <linesResults>
          <ExpandedLineResult>
            <status>OK or Warning or Error</status>
            <paymentOrderStatus>string</paymentOrderStatus>
            <message>string</message>
            <refCode>string</refCode>
            <lineErrorOrWarningType>int</lineErrorOrWarningType>
          </ExpandedLineResult>
          <ExpandedLineResult>
            <status>OK or Warning or Error</status>
            <paymentOrderStatus>string</paymentOrderStatus>
            <message>string</message>
            <refCode>string</refCode>
            <lineErrorOrWarningType>int</lineErrorOrWarningType>
          </ExpandedLineResult>
        </linesResults>
        <summary>
          <TipaltiProcessPaymentsSummary>
            <accountType>int</accountType>
            <accountCurrency>string</accountCurrency>
            <fundsRequired>double</fundsRequired>
            <outstandingAmount>double</outstandingAmount>
            <tipaltiSummaryAmounts xsi:nil="true" />
          </TipaltiProcessPaymentsSummary>
          <TipaltiProcessPaymentsSummary>
            <accountType>int</accountType>
            <accountCurrency>string</accountCurrency>
            <fundsRequired>double</fundsRequired>
            <outstandingAmount>double</outstandingAmount>
            <tipaltiSummaryAmounts xsi:nil="true" />
          </TipaltiProcessPaymentsSummary>
        </summary>
      </TestPaymentsResult>
    </TestPaymentsResponse>
  </soap12:Body>
</soap12:Envelope>