Generate Token - ccgettoken

This section describes the message parameters for Credit Card Tokenization, which you can submit using the Hosted Payments, Checkout.js, and XML API integration methods. Refer to the Integration Methods section for more information.

The ccgettoken transaction generates a token from a card number or an existing recurring/installment in the recurring batch. The token generated can be used in place of a credit card number in any subsequent transactions. Additionally, you can request to add the generated token to Card Manager.

This transaction is supported only when a terminal is setup for tokenization for hand-keyed cards only. Refer to the Tokenization section for more information.

In this section:

For the entire list of API endpoints, refer to API Endpoints.

Request

Response

Examples

Basic Token Generation Transaction

Request

xmldata=
<txn>
    <ssl_merchant_id>my_merchant_id</ssl_merchant_id>
    <ssl_user_id>my_user_id</ssl_user_id>
    <ssl_pin>my_pin</ssl_pin>
    <ssl_transaction_type>ccgettoken</ssl_transaction_type>
    <ssl_card_number>0000000000000000</ssl_card_number>
    <ssl_exp_date>1222</ssl_exp_date>
    <ssl_avs_address>7300</ssl_avs_address>
    <ssl_avs_zip>12345</ssl_avs_zip>
    <ssl_verify>N</ssl_verify>
</txn>

Response

<txn>
    <ssl_result>0</ssl_result>
    <ssl_token_response>SUCCESS</ssl_token_response>
    <ssl_token>7876275006683003</ssl_token>
</txn>

Token Generation with Card Verification

Request

xmldata=
<txn>
    <ssl_merchant_id>my_merchant_id</ssl_merchant_id>
    <ssl_user_id>my_user_id</ssl_user_id>
    <ssl_pin>my_pin</ssl_pin>
    <ssl_transaction_type>ccgettoken</ssl_transaction_type>
    <ssl_card_number>0000000000000000</ssl_card_number>
    <ssl_exp_date>1222</ssl_exp_date>
    <ssl_avs_address>7300</ssl_avs_address>
    <ssl_avs_zip>12345</ssl_avs_zip>
    <ssl_verify>Y</ssl_verify>
</txn>

Response

<txn>
    <ssl_transaction_type>ccgettoken</ssl_transaction_type>
    <ssl_result>0</ssl_result>
    <ssl_token_response>SUCCESS</ssl_token_response>
    <ssl_token>7876275006683003</ssl_token>
    <ssl_result_message>SUCCESS</ssl_result_message>
    <ssl_avs_response>A<ssl_avs_response>
    <ssl_cvv2_response>M</ssl_cvv2_response>
</txn>

BIN Lookup as a Parameter

Request

xmldata=
<txn>
    <ssl_merchant_ID>my_merchant_id</ssl_merchant_ID>
    <ssl_user_id>my_user_ID</ssl_user_id>
    <ssl_pin>my_pin</ssl_pin>
    <ssl_transaction_type>CCGETTOKEN</ssl_transaction_type>
    <ssl_card_number>my_card_number</ssl_card_number>
    <ssl_exp_date>1222/</ssl_exp_date>
    <ssl_bin_lookup>Y</ssl_bin_lookup>     
</txn>

Response

<txn>
    <ssl_last_name/>
    <Description/>
    <ssl_company/>
    <ssl_phone/>
    <ssl_card_number>47**********1955</ssl_card_number>
    <ssl_result>0</ssl_result>
    <ssl_txn_id/>
    <ssl_avs_response/>
    <ssl_approval_code/>
    <ssl_email/>
    <ssl_avs_zip/>
    <ssl_txn_time>09/02/2021 09:24:56 AM</ssl_txn_time>
    <ssl_exp_date>1222</ssl_exp_date>
    <ssl_card_short_description>VISA</ssl_card_short_description>
    <ssl_address2/>
    <ssl_token_response>SUCCESS</ssl_token_response>
    <custom3/>
    <ssl_credit_surcharge_amount/>
    <custom1/>
    <InvoiceNumber/>
    <custom2/>
    <ssl_customer_code/>
    <ssl_country/>
    <ssl_card_type>CREDITCARD</ssl_card_type>
    <ssl_transaction_type>GETTOKEN</ssl_transaction_type>
    <ssl_salestax/>
    <ssl_avs_address/>
    <ssl_customer_id/>
    <ssl_account_balance>0.00</ssl_account_balance>
    <ssl_state/>
    <old_txn_id/>
    <ssl_city/>
    <ssl_result_message/>
    <Custom_1/>
    <ssl_first_name/>
    <ssl_invoice_number/>
    <ssl_cvv2_response/>
    <ssl_token>7388883093161955</ssl_token> 
    <ssl_bin_lookup_response>SUCCESS</ssl_bin_lookup_response> 
    <debit>Y</debit>
    <surchargeAllowed>N</surchargeAllowed>
    <fundingSource/>
    <pinlessDebitEnabled>N</pinlessDebitEnabled>
    <hsa>N</hsa>
    <billPaymentSupport>N</billPaymentSupport>
    <businessCard>N</businessCard>
    <cardProductTypeCode/>
    <countryCode/>
    <dbIntchFraudInd/>
    <ecommSupport>N</ecommSupport>
    <institutionName/>
    <internationalSupport>N</internationalSupport>
    <networkRoutingCode/>
    <posEligible>N</posEligible>
    <prepaidSupport>N</prepaidSupport>
    <signatureSupport>N</signatureSupport>
    <quickServeSupport>N</quickServeSupport>
    <octeligible/>
</txn>

• previousToken Update - ccupdatetoken
• nextToken Delete - ccdeletetoken