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.
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.
|Field name||Description||Required||Length||Data type|
Elavon-assigned Converge Account ID (AID).
|Required||6 or 7||numeric|
|Converge User ID|
The user ID with Hosted Payment API User status that can send transaction requests through the terminal.
Unique identifier of the terminal that will process the transaction request and submit to the Converge gateway.
|[Card Data]||Use the appropriate card data parameters for the transaction.|
Card Number as it appears on the gift card.
Required for hand-keyed transactions.
|Card’s Expiry Date|
Date when the card becomes invalid.
|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.
Required for swiped transactions.
|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.
|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.
Required if using
|Transaction Result Message|
Refer to the Gift Card Response Codes section for an extensive list of possible returned messages.
Unique identifier of the transaction.
|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
|Transaction Approval Code|
Unique code returned by the credit card processor that indicates the approval status of the transaction.
|Masked Card Number|
|Card’s Expiry Date|
Returned based on merchant setup.
|Gift Card Token|
Generated from the card number.
Returned if transaction was approved.
Not returned if the transaction was failed or rejected.
|Token Generation Outcome|
A value of
|[Error]||Returned only if an error occurs. Refer to the Error Codes section for more information.|
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.
Detailed explanation of the error. This field may be changed based on merchant configuration in the user interface.
Error name or reason for the error.
- In this example, you will have to change the data values, such as
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.
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>