Card API/Card API REFERENCE/ActivateToken

ActivateToken

Used to activate a token for a digitization that has been approved and provisioned, but requires additional cardholder authentication prior to activation. It is expected that a cardholder will complete the authentication process using an issuer’s call center or using an issuer-supplied mobile application, and only then should the issuer use this API to activate the token.

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

tokenUniqueReference

string, 48 characters, required

The unique reference of the token to be activated

activationCode

string, required

Required when card scheme is VISA (empty string otherwise)

reasonCode

string, required

Reason for the activation. Valid values:
“A” = Cardholder successfully authenticated prior to activation
“C” = Cardholder successfully authenticated with a customer service agent prior to activation

comment

string, 1-500 characters, required

Description of the activation or empty string

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, required

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

<?xml version="1.0"?>

  <methodCall>

    <methodName>ActivateToken</methodName>

    <params>

      <param>

        <value>

          <string>0006125612</string>

        </value>

      </param>

      <param>

        <value>

          <string>testReference123</string>

        </value>

      </param>     

      <param>

        <value>

          <string>767761230000071</string>

        </value>

      </param>

      <param>

        <value>

          <string>DWSPMC00123456010906a349d9ca4eb1a4d53e3c90a11d9c</string>

        </value>

      </param>

      <param>

        <value>

          <string>123456</string>

        </value>

      </param>

      <param>

        <value>

          <string>A</string>

        </value>

      </param>

      <param>

        <value>

          <string>Cardholder authenticated sucessfully</string>

        </value>

      </param>

      <param>

        <value>

          <string>fb1234c9-2fc9-467b-87e4-55eaf12d06f2</string>

        </value>

      </param>

      <param>

        <value>

          <dateTime.iso8601>20200101T09:00:00</dateTime.iso8601>

        </value>

      </param>

      <param>

        <value>

          <string>36a5ca8e88f7ee0a05ee5c1234567b204883e662</string>

        </value>

      </param>

    </params>

  </methodCall>

Response

STATUS200 OK

Schema

resultCode

integer

Status code indicating transaction result

resultText

string

Resulting text provides further context to the resultCode

<?xml version="1.0" encoding="UTF-8"?>
<methodResponse>
    <params>
        <param>
            <value>
                <struct>
                    <member>
                        <name>resultCode</name>
                        <value>
                            <int>1</int>
                        </value>
                    </member>
                    <member>
                        <name>resultText</name>
                        <value>
                            <string>Approved</string>
                        </value>
                    </member>
                </struct>
            </value>
        </param>
    </params>
</methodResponse>

ActivateToken

Request

Path parameters

Response

STATUS200 OK

Schema

Are you ready to use our APIs