Generate Token - egcgettoken
This section describes the message parameters for Gift Card Token Generation transaction processing, which you can submit using the XML API integration method. Refer to the Integration Methods section for more information.
The egcgettoken transaction generates a token from a gift card number. The token generated can be used in place of a gift card number in any subsequent transactions. This transaction type is supported only when a terminal is setup for tokenization. Refer to the Tokenization section for more information.
In this section:
For the entire list of API endpoints, refer to API Endpoints.
Request
| Field name | Description | Required | Length | Data type |
|---|---|---|---|---|
ssl_merchant_id | Merchant ID Elavon-assigned Converge Account ID (AID). | Required | 6 or 7 | numeric |
ssl_user_id | Converge User ID The user ID with Hosted Payment API User status that can send transaction requests through the terminal. | Required | 15 | alphanumeric |
ssl_pin | Terminal ID Unique identifier of the terminal that will process the transaction request and submit to the Converge gateway. The ssl_user_id sending the transaction request must be associated with the terminal that will process the request. | Required | 64 | alphanumeric |
ssl_transaction_type | Transaction Type Value: egcgettoken | Required | 20 | alphanumeric |
| [Card Data] | Use the appropriate card data parameters for the transaction. | |||
ssl_card_number | Card Number Card Number as it appears on the gift card. error_outline important Required for hand-keyed transactions. | Conditional | 18 | numeric |
ssl_exp_date | Card’s Expiry Date Date when the card becomes invalid. Format: MMYY error_outline important Required if | Conditional | 4 | numeric |
ssl_track_data | Raw Track I and/or II Data Track data captured from the card’s magnetic stripe. The data includes beginning and ending sentinels, card’s expiry date, cardholder’s first and last name. error_outline important Required for swiped transactions. | Conditional | 76 | alphanumeric |
ssl_enc_track_data | Encrypted Raw Track I and/or II Data Encrypted Track I and/or II data captured from the card’s magnetic stripe when using an Ingenico encrypting device. The data includes beginning and ending sentinels, card’s expiry date, cardholder’s first and last name. | Conditional | 160 | alphanumeric |
ssl_ksn | Key Serial Number Unique identifier generated from the swiped payment card and returned by the encrypting device. The KSN encrypts the PAN data through the DUKPT method. error_outline important Required if using | Conditional | 20 | alphanumeric |
Response
| Field name | Description |
|---|---|
ssl_result | Transaction Outcome An ssl_result = 0 indicates an approved transaction.An ssl_result not equal to 0 indicates a declined and unauthorized transaction. |
ssl_result_message | Transaction Result Message Refer to the Gift Card Response Codes section for an extensive list of possible returned messages. |
ssl_txn_id | Transaction ID Unique identifier of the transaction. |
ssl_txn_time | Processing Date and Time Indicates when Converge processed the transaction. Format: MM/DD/YYYY hh:mm:ss AM/PM Example: 03/18/2010 10:34:10 AM |
ssl_approval_code | Transaction Approval Code Unique code returned by the credit card processor that indicates the approval status of the transaction. |
ssl_card_number | Masked Card Number |
ssl_exp_date | Card’s Expiry Date Returned based on merchant setup. |
ssl_token | Gift Card Token Generated from the card number. Returned if transaction was approved. Not returned if the transaction was failed or rejected. |
ssl_token_response | Token Generation Outcome A value of SUCCESS indicates Converge generated the token. Other values returned are FAILURE, Action Not Permitted, Invalid Token, Not Permitted, and Acct Verification Failed. |
| [Error] | Returned only if an error occurs. Refer to the Error Codes section for more information. |
errorCode | Error Code Typically, when the transaction failed validation or the request is incorrect. This will prevent the transaction from going to authorization. This is a numeric field. |
errorMessage | Error Message Detailed explanation of the error. This field may be changed based on merchant configuration in the user interface. |
errorName | Error Name Error name or reason for the error. |
Example
error_outline
important
- In this example, you will have to change the data values, such as
my_merchant_id,my_user_id,my_pin, and transaction data to match your Converge account and meet the needs of your website. - Code samples provided are for demonstration only and should not be used for live transactions. All sensitive merchant data, including your Converge credentials, should be placed in server side code.
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>egcgettoken</ssl_transaction_type>
<ssl_card_number>41**********1111</ssl_card_number>
<ssl_exp_date>1224</ssl_exp_date>
<ssl_security_code>1234</ssl_security_code>
</txn>