Register Token Request

You must specify the Register Token request as follows. The structure of the request is identical for either an Online or a Batch submission. The child elements used differ depending upon whether you are registering a credit card account, a Direct Debit account, or submitting a Registration Id.

When you submit the CVV2/CVC2/CID in a registerTokenRequest, the platform encrypts and stores the value on a temporary basis for later use in a tokenized Auth/Sale transaction submitted without the value. This is done to accommodate merchant systems/workflows where the security code is available at the time of token registration, but not at the time of the Auth/Sale. If for some reason you need to change the value of the security code supplied at the time of the token registration, use an updateCardValidationNumOnToken transaction. To use the store value when submitting an Auth/Sale transaction, set the cardValidationNum value to 000.

The use of the cardValidationNum element in the registertokenRequest only applies when you submit an accountNumber element.

For credit cards:

<registerTokenRequest id="Id" reportGroup="iQ Report Group">

  <orderId>Order Id</orderId>

  <accountNumber>Card Account Number</accountNumber>

  <cardValidationNum>CVV2/CVC2/CID</cardValidationNum>

</registerTokenRequest>

For credit cards with encrypted account info:

<registerTokenRequest id="Id" reportGroup="iQ Report Group">

  <encryptionKeyId>1234567890</encryptionKeyId>

  <orderId>Order Id</orderId>

  <encryptedAccountNumber>Encrypted Account Number</encryptedAccountNumber>

  <encryptedCardValidationNum>Encrypted CVV2/CVC2/CID</encryptedCardValidationNum>

</registerTokenRequest>

For Direct Debit accounts:

<registerTokenRequest id="Id" reportGroup="iQ Report Group">

  <orderId>Order Id</orderId>

  <echeckForToken>

    <accNum>Account Number</accNum>

    <routingNum>Routing Number</routingNum>

  </echeckForToken>

</registerTokenRequest>

For Registration Ids:

<registerTokenRequest id="Id" reportGroup="iQ Report Group">

  <orderId>Order Id</orderId>

  <paypageRegistrationId>

</registerTokenRequest>

For Mobile POS transactions:

<registerTokenRequest id="Id" reportGroup="iQ Report Group">

  <orderId>Order Id</orderId>

  <mpos>

    <ksn>Key Serial Number</ksn>

    <formatId>Format of Encrypted Track</formatId>

    <encryptedTrack>Encrypted Track Data</encrytpedTrack>

    <track1Status>Track Read Status - 0 or 1</track1Status>

    <track2Status>Track Read Status - 0 or 1</track2Status>

  </mpos>

</registerTokenRequest>

For Apple Pay transactions:

<registerTokenRequest id="Id" reportGroup="iQ Report Group">

  <orderId>Order Id</orderId>

  <applepay>

    <data>Encrypted Payment Data</data>

    <header>

      <applicationData>Hash of Application Data Property</applicationData>

      <ephemeralPublicKey>Ephemeral Public Key</ephemeralPublicKey>

      <publicKeyHash>Merchant Cert Encoded Public Key</publicKeyHash>

      <transactionId>Transaction Id from Device</transactionId>

    </header>

    <signature>Signature of Payment and Header Data</signature>

    <version>Payment Token Version</version>

  </applepay>

</registerTokenRequest>

Example: Batch Register Token Request - Credit Card

<cnpRequest version="12.0" xmlns="http://www.vantivcnp.com/schema" id="123" numBatchRequests="1">

  <authentication>

    <user>userName</user>

    <password>password</password>

  </authentication>

  <batchRequest id="01234567" numTokenRegistrations="1" merchantId="000902">

    <registerTokenRequest id="99999" reportGroup="RG1">

      <orderId>F12345</orderId>

      <accountNumber>4005101001000002</accountNumber>

      <cardValidationNum>999</cardValidationNum>

    </registerTokenRequest>

  </batchRequest>

</cnpRequest>

Example: Batch Register Token Request - Direct Debit

<cnpRequest version="12.0" xmlns="http://www.vantivcnp.com/schema" id="123" numBatchRequests="1">

  <authentication>

    <user>userName</user>

    <password>password</password>

  </authentication>

  <batchRequest id="01234567" numTokenRegistrations="1" merchantId="000902">

    <registerTokenRequest id="99999" reportGroup="RG1">

      <orderId>F12345</orderId>

      <echeckForToken>

        <accNum>12345678901234567</accNum>

        <routingNum>000010101</routingNum>

      </echeckForToken>

    </registerTokenRequest>

  </batchRequest>

</cnpRequest>

Example: Batch Register Token Request - paypageRegistationId

<cnpRequest version="12.0" xmlns="http://www.vantivcnp.com/schema" id="123" numBatchRequests="1">

  <authentication>

    <user>userName</user>

    <password>password</password>

  </authentication>

  <batchRequest id="01234567" numTokenRegistrations="1" merchantId="000902">

    <registerTokenRequest id="99999" reportGroup="RG1">

      <orderId>F12345</orderId>

      <paypageRegistrationId>12345678901234567</paypageRegistrationId>

    </registerTokenRequest>

  </batchRequest>

</cnpRequest>

Example: Online Register Token Request - Encrypted Account Number and CVV

<cnpOnlineRequest version="12.5" xmlns="http://www.vantivcnp.com/schema" merchantId="yourMerchantIdentString">

  <authentication>

    <user>yourUsername</user>

    <password>yourPassword</password>

  </authentication>

  <registerTokenRequest id="002" reportGroup="encrypt">

    <encryptionKeyId>1</encryptionKeyId>

    <encryptedAccountNumber>l2PRNMUV5l9Hq7h6l/Ae8gDaiatUUfJ7DLim3+l7zfq54njTgQJ0V2ExXnIpQuTGtNlKhesg+cXz8Igx/4kJQTGss2MeCI7vwHAC19/32+p1iW2LaTLzmMj+T3jH72IEEwcWyT2UhxJts6LcXOZn1+qi1thOENIXALBcB5OUjQWJIYy0aciZu/UsX0N8YXmbJ18dZJDuyo5bkhsgzKlM5pfYvUoR0ReC39KtNWW95XR0/6w7v9I1ncREmyZQ9vr0+C8yz6O9w+1TW0xqafSWoZW02NBxmpcZ6Rnt8xJwnxLmsgNn8J0kR9Yq2XiBmAPWXmR7pi2FYkmNOsEHbWHNCw==</encryptedAccountNumber>

    <encryptedCardValidationNum>H3OM9kbPWks0OlE+rlqy5zdOllnp+Zs/2WwfXxtEvVbtlc1slWb/wiAWOaNqrNBl2BPEOfaftOHFHNH6mqNVN3kElW8u8AOstQpeA4Qf5a6j1UaaC9a/VNgFz6ln7BHn0N1VWxIh5lt1JJ31w1dHQzdpapHitqjEyUXdgir5UQJ+3QJ/+Gjf8Ucv/9b9+sPxpwJAdCMbvc1yfvxFcXWq0zX+j/RJwwMglKcFndO+o4sil1+HkZW4CKVADn54c31PA0cjQR+dV19DYkrV1WQmFYH45CDm07OkGb2D1YFVEQN/b+UeVCuqDIoUbEBS9FaeM5qT6Va4WmP29rLRNruGgA==</encryptedCardValidationNum>

  </registerTokenRequest>

</cnpOnlineRequest>ValidationNum>