Function: GetDynamicKey

The GetDynamicKey function returns a dynamic encryption key that can be used to sign the content of the TipaltiiFrame query string (see Enhance security for guidelines on using dynamic keys). Do not send the key over the wire or include it in the query string. Store it in a secure location.

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

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>

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

<GetDynamicKeyResult>

<errorMessage>string</errorMessage>

<errorCode>string</errorCode>

<Key>string</Key>

<Token>string</Token>

</GetDynamicKeyResult>

</GetDynamicKeyResponse>

</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
timestamp	Current time (UTC) when the request is sent	Unix time	Mandatory	double
key	Encryption key		Mandatory	string

Response parameters

element	description	data type
GetDynamicKeyResult	Contains the response parameters	SecurityToken

SecurityToken

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
Key	Dynamic encryption key (no EAT)	Max. length = 64	string
Token	The token to concatenate with the query string The token identifies which dynamic encryption key you are using to encrypt the query string.	Max. length = 64	string