TipaltiPayerSOAPV5


Click here for a complete list of operations.

GetDynamicKey

Returns a dynamic security key that can be used to sign the content of the Tipalti iFrame Query String.
The SecurityToken object returns contains a key and a token. Use the key to sign the query string.
You must send the token within the query string of the iFrame. To do that, set its value to a Query String parameter named 'token'
The key is a temporary key and will expire within the time limit you have set in the administration console
Do not send the key over the wire or include it in the query string. Store it in a secure location.
EAT - none

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
payerName:
timestamp:
key:

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

<?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>
    <GetDynamicKey xmlns="http://Tipalti.org/">
      <payerName>string</payerName>
      <timestamp>double</timestamp>
      <key>string</key>
    </GetDynamicKey>
  </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>
    <GetDynamicKeyResponse xmlns="http://Tipalti.org/">
      <GetDynamicKeyResult>
        <errorMessage>string</errorMessage>
        <errorCode>UnknownError or OK or UnknownCountryCode or CountryNotSupported or UnknownState or PayerUnknown or PayeeUnknown or EncryptionKeyFailedValidation or ParameterError or FeeScheduleUnknown or StringContainsNonEBCDICCharacters or PreferredEntityIsNotValid or InvoiceRefCodeUnknown or InvoiceCannotBeCancelled or UnknownCurrencyCode or InvalidJson or InvoiceValidationError or ValidationError or ValidationWarning or BillsModuleMustBeEnabled or FileNotFound or InvoiceFileNotFound or CannotReadFile or CannotDeleteFile or CannotWriteFile or PaymentAmountTotalMismatch or InvalidPayerIpAddress or EnahncedSecurityNotConfigured or SubPayerIsNotFound or SubPayerDoensNotSupportDynamicKey or PayerDoesntSupportInvoiceModule or CustomFieldDoesNotExist or DuplicateInvoiceRefCode or PaidOrInProcessInvoiceCannotBeUpdated or CanApproveNotSupported or AuthorizationError or InvoiceNotApprovedbyPayee or PaymentAmountCannotBeNegative or RequestLimitReached or ItemAlreadyInProcess or RequestDoesNotExist or RequestStillInProgress or CustomFieldValueIsNotUnique or BillStatusIsNotSupported or GLAccountAssignedToActiveBill or CustomFieldValidationError or CustomFieldValueValidationError or GlAccountValidationError or APAccountNotFound or SyncDirectionInvalid or ErrorTypeInvalid or IntegrationNameInvalid or IntegrationVersionOverMaxLength or CreationTimestampInvalid or ErrorDetailsInvalid or PaymentTermNotFound or CustomFieldInvalidDateFormat or PaymentTermValidationError or TaxCodeValidationError or TaxCodeExternalIdNotFoundError or IllegalErpCurrencyUpdate or PurchaseOrderNotFound or GoodsReceivedNotificationNotFound or UnitOfMeasureIsInUse or PayeeAlreadyInvited or MissingEmail or PayeeAlreadyRegistered or PayeeEmailNotUnique or SupplierPortalDisabled or ReportNotFound</errorCode>
        <Key>string</Key>
        <Token>string</Token>
      </GetDynamicKeyResult>
    </GetDynamicKeyResponse>
  </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>
    <GetDynamicKey xmlns="http://Tipalti.org/">
      <payerName>string</payerName>
      <timestamp>double</timestamp>
      <key>string</key>
    </GetDynamicKey>
  </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>
    <GetDynamicKeyResponse xmlns="http://Tipalti.org/">
      <GetDynamicKeyResult>
        <errorMessage>string</errorMessage>
        <errorCode>UnknownError or OK or UnknownCountryCode or CountryNotSupported or UnknownState or PayerUnknown or PayeeUnknown or EncryptionKeyFailedValidation or ParameterError or FeeScheduleUnknown or StringContainsNonEBCDICCharacters or PreferredEntityIsNotValid or InvoiceRefCodeUnknown or InvoiceCannotBeCancelled or UnknownCurrencyCode or InvalidJson or InvoiceValidationError or ValidationError or ValidationWarning or BillsModuleMustBeEnabled or FileNotFound or InvoiceFileNotFound or CannotReadFile or CannotDeleteFile or CannotWriteFile or PaymentAmountTotalMismatch or InvalidPayerIpAddress or EnahncedSecurityNotConfigured or SubPayerIsNotFound or SubPayerDoensNotSupportDynamicKey or PayerDoesntSupportInvoiceModule or CustomFieldDoesNotExist or DuplicateInvoiceRefCode or PaidOrInProcessInvoiceCannotBeUpdated or CanApproveNotSupported or AuthorizationError or InvoiceNotApprovedbyPayee or PaymentAmountCannotBeNegative or RequestLimitReached or ItemAlreadyInProcess or RequestDoesNotExist or RequestStillInProgress or CustomFieldValueIsNotUnique or BillStatusIsNotSupported or GLAccountAssignedToActiveBill or CustomFieldValidationError or CustomFieldValueValidationError or GlAccountValidationError or APAccountNotFound or SyncDirectionInvalid or ErrorTypeInvalid or IntegrationNameInvalid or IntegrationVersionOverMaxLength or CreationTimestampInvalid or ErrorDetailsInvalid or PaymentTermNotFound or CustomFieldInvalidDateFormat or PaymentTermValidationError or TaxCodeValidationError or TaxCodeExternalIdNotFoundError or IllegalErpCurrencyUpdate or PurchaseOrderNotFound or GoodsReceivedNotificationNotFound or UnitOfMeasureIsInUse or PayeeAlreadyInvited or MissingEmail or PayeeAlreadyRegistered or PayeeEmailNotUnique or SupplierPortalDisabled or ReportNotFound</errorCode>
        <Key>string</Key>
        <Token>string</Token>
      </GetDynamicKeyResult>
    </GetDynamicKeyResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /v5/PayerFunctions.asmx/GetDynamicKey HTTP/1.1
Host: api.tipalti.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

payerName=string&timestamp=string&key=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<SecurityToken xmlns="http://Tipalti.org/">
  <errorMessage>string</errorMessage>
  <errorCode>UnknownError or OK or UnknownCountryCode or CountryNotSupported or UnknownState or PayerUnknown or PayeeUnknown or EncryptionKeyFailedValidation or ParameterError or FeeScheduleUnknown or StringContainsNonEBCDICCharacters or PreferredEntityIsNotValid or InvoiceRefCodeUnknown or InvoiceCannotBeCancelled or UnknownCurrencyCode or InvalidJson or InvoiceValidationError or ValidationError or ValidationWarning or BillsModuleMustBeEnabled or FileNotFound or InvoiceFileNotFound or CannotReadFile or CannotDeleteFile or CannotWriteFile or PaymentAmountTotalMismatch or InvalidPayerIpAddress or EnahncedSecurityNotConfigured or SubPayerIsNotFound or SubPayerDoensNotSupportDynamicKey or PayerDoesntSupportInvoiceModule or CustomFieldDoesNotExist or DuplicateInvoiceRefCode or PaidOrInProcessInvoiceCannotBeUpdated or CanApproveNotSupported or AuthorizationError or InvoiceNotApprovedbyPayee or PaymentAmountCannotBeNegative or RequestLimitReached or ItemAlreadyInProcess or RequestDoesNotExist or RequestStillInProgress or CustomFieldValueIsNotUnique or BillStatusIsNotSupported or GLAccountAssignedToActiveBill or CustomFieldValidationError or CustomFieldValueValidationError or GlAccountValidationError or APAccountNotFound or SyncDirectionInvalid or ErrorTypeInvalid or IntegrationNameInvalid or IntegrationVersionOverMaxLength or CreationTimestampInvalid or ErrorDetailsInvalid or PaymentTermNotFound or CustomFieldInvalidDateFormat or PaymentTermValidationError or TaxCodeValidationError or TaxCodeExternalIdNotFoundError or IllegalErpCurrencyUpdate or PurchaseOrderNotFound or GoodsReceivedNotificationNotFound or UnitOfMeasureIsInUse or PayeeAlreadyInvited or MissingEmail or PayeeAlreadyRegistered or PayeeEmailNotUnique or SupplierPortalDisabled or ReportNotFound</errorCode>
  <Key>string</Key>
  <Token>string</Token>
</SecurityToken>