TipaltiPayerSOAPV5


Click here for a complete list of operations.

GetDynamicKeyOfSubPayer

Get dynamic encryption key of sub payer. the dynamic key is encrypted with the parent payer key.The SecurityToken object returns contains an encrypted 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 - subPayerName

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
payerName:
subPayerName:
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/GetDynamicKeyOfSubPayer"

<?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>
    <GetDynamicKeyOfSubPayer xmlns="http://Tipalti.org/">
      <payerName>string</payerName>
      <subPayerName>string</subPayerName>
      <timestamp>double</timestamp>
      <key>string</key>
    </GetDynamicKeyOfSubPayer>
  </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>
    <GetDynamicKeyOfSubPayerResponse xmlns="http://Tipalti.org/">
      <GetDynamicKeyOfSubPayerResult>
        <errorMessage>string</errorMessage>
        <errorCode>int</errorCode>
        <Key>string</Key>
        <Token>string</Token>
      </GetDynamicKeyOfSubPayerResult>
    </GetDynamicKeyOfSubPayerResponse>
  </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>
    <GetDynamicKeyOfSubPayer xmlns="http://Tipalti.org/">
      <payerName>string</payerName>
      <subPayerName>string</subPayerName>
      <timestamp>double</timestamp>
      <key>string</key>
    </GetDynamicKeyOfSubPayer>
  </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>
    <GetDynamicKeyOfSubPayerResponse xmlns="http://Tipalti.org/">
      <GetDynamicKeyOfSubPayerResult>
        <errorMessage>string</errorMessage>
        <errorCode>int</errorCode>
        <Key>string</Key>
        <Token>string</Token>
      </GetDynamicKeyOfSubPayerResult>
    </GetDynamicKeyOfSubPayerResponse>
  </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/GetDynamicKeyOfSubPayer HTTP/1.1
Host: api.tipalti.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

payerName=string&subPayerName=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"?>
<TipaltiSubPayerSecurityToken xmlns="http://Tipalti.org/">
  <errorMessage>string</errorMessage>
  <errorCode>int</errorCode>
  <Key>string</Key>
  <Token>string</Token>
</TipaltiSubPayerSecurityToken>