Transaction Email - txnemail
This section describes the message parameters for End of Day Transaction Email processing, which you can submit using the XML API integration method. Refer to the Integration Methods section for more information.
The txnemail
transaction initiates or resends an email to the merchant or customer for a specific transaction.
error_outline
important
The terminal must be setup for emails and to receive emails.
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: txnemail | Required | 20 | alphanumeric |
ssl_txn_id | Transaction ID Unique identifier of the original transaction. | Required | 46 | alphanumeric |
ssl_email | Email Address The cardholder’s or customer’s email address. Send this parameter if:
| Optional | 100 | alphanumeric |
ssl_update_email | Update Email Address Indicator Indicates whether to modify the cardholder’s email address after sending the order confirmation email. Valid values:
Important: If ssl_update_email = Y, send the new email address using the ssl_email parameter. | Optional | 1 | alphanumeric |
ssl_do_customer_email | Send Email to Customer Indicator Indicates whether to send emails to customers when transactions are approved or declined. Valid values:
ssl_do_customer_email is null.Default value - Set in terminal: E-mail Form - Email Notification Setup - Email Options - Notify Customer of Transaction Approval / Notify Customer of Transaction Decline | Optional | 1 | alphanumeric |
ssl_do_merchant_email | Send Email to Merchant Indicator Indicates whether to send emails to the merchant when transactions are approved or declined. Valid values:
Defaults to T if ssl_do_merchant_email is null.Default value - Set in terminal: E-mail Form - Email Notification Setup - Email Options - Notify Merchant of Transaction Approval / Notify Merchant of Transaction Decline | Optional | 1 | 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 Transaction Email 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 |
[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. |