generateTimeBasedSecret

Generates a “secret token” to enable communication with our tokenisation APIs.

IMPORTANT: As push provisioning needs to be completed in one minute or less, the recommended setting for the Request Parameter: timeStep is 60.

Request

Path parameters

terminalID

string, 10 characters, required

The Paymentology issued terminal ID of the terminal requesting the transaction

customerReference

string, 1-255 characters, required

Customer reference linked with this card

trackingNumber

string, 1-20 characters, required

Tracking number that identifies the card to be returned

timeStep

integer, required

Default: 60 – Window during which TOTP is valid in seconds.

IMPORTANT: This is the default and recommended setting as push provisioning needs to be completed in one minute or less.

cardSecretLength

integer, required

Default: 8 – Length of card secret 1-8

algorithm

string, required

Default: HmacSHA512 – Hashing algorithm used for TOTP generation

Possible Values:

HmacSHA1, HmacSHA256, HmacSHA512

transactionID

string, 1-255 characters, required

A unique identifier generated by the client, which must not be duplicated over time.

transactionDate

date, required

Transaction date generated by the calling client

checksum

string, 1-255 characters, required

HMAC-SHA256 hashed signature of the concatenated method name with all argument values using the terminal password as private key

<methodCall>
    <methodName>GenerateTimeBasedSecret</methodName>
    <params>
        <param>
            <value>
                <string>0085666442</string>
            </value>
        </param>
        <param>
            <value>
                <string>4523652122</string>
            </value>
        </param>
        <param>
            <value>
                <string>711415700000248</string>
            </value>
        </param>
        <param>
            <value>
                <numeric>60</numeric>
            </value>
        </param>
        <param>
            <value>
                <numeric>8</numeric>
            </value>
        </param>
        <param>
            <value>
                <string>HmacSHA512</string>
            </value>
        </param>
        <param>
            <value>
                <string>123654789654</string>
            </value>
        </param>
        <param>
            <value>
                <dateTime.iso8601>20230215T12:43:46</dateTime.iso8601>
            </value>
        </param>
        <param>
            <value>
                <string>6A401CCE9F40C338FE0AF63DD247A2BC13246CFCF1A04F6828C70F9262A3D24D</string>
            </value>
        </param>
    </params>
</methodCall>

Response

STATUS200 OK

Schema

resultCode

integer

Status code indicating transaction result

secret

string

generated TOTP

<methodResponse>
    <params>
        <param>
            <value>
                <struct>
                    <member>
                        <name>resultCode</name>
                        <value>
                            <int>1</int>
                        </value>
                    </member>
                    <member>
                        <name>secret</name>
                        <value>
                            <string>123#45236521</string>
                        </value>
                    </member>
                </struct>
            </value>
        </param>
    </params>
</methodResponse>

Back to Local API Menu

Request

Path parameters

Response

STATUS200 OK

Schema

Are you ready to use our APIs