Recurring Batch Import - ccrecimport
The ccrecimport transaction imports and processes a batch file of recurring and installment transactions.
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. Important: 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: ccrecimport | Required | 20 | alphanumeric |
ssl_import_file | Import File Describes the path, location, file name, and file extension of the import file. Important:
| Required | 255 | alphanumeric |
ssl_response_file | Import Response File Friendly Name Easy to understand file name of the import response file. Important: The value must not contain a forward slash, backward slash, colon, asterisk, question mark, quotation mark, greater than symbol, less than symbol or a pipe character. | Required | 25 | 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:
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 |
ssl_merchant_email | Merchant’s Email Address If null and ssl_do_merchant_email = T, Converge sends the email to the email address of the terminal. | Optional | 100 | alphanumeric |
ssl_result_format | Result Format When set to ASCII, Virtual Terminal generates a plain text key-value document.Defaults to HTML if not sent.Valid values: ASCII, HTML, XML | Optional | 5 | alphanumeric |
ssl_receipt_link_method | Receipt Link Method Indicates the method for displaying the receipt and data of an approved or declined transaction. Valid value: REDG - Does not display the receipt and redirects the data to the URL specified in ssl_receipt_link_url | Optional | 4 | alphanumeric |
ssl_receipt_link_url | Receipt URL Target URL of the button or the link created at the bottom of the receipt for an approved or declined transaction. Important: If ssl_result_format = ASCI and ssl_receipt_link_method = REDG, Converge ignores the value of this parameter. | Optional | 255 | alphanumeric |
ssl_error_url | Error URL The URL where the integrated application will send the errorCode, errorName, and errorMessage values. | Optional | 255 | alphanumeric |
Response
error_outline
note
The response simply indicates if the file upload was successful or not. Transactions in the file will be sent for authorization and entered into the appropriate batches in the User Interface. The import response files can be viewed and downloaded from the User Interface.
| Field name | Description |
|---|---|
ssl_result | Transaction Outcome An ssl_result = 0 indicates an imported batch file.An ssl_result = 1 indicates an unsuccessful batch file import. |
ssl_result_message | Transaction Result Message A ssl_result_message = File upload successful indicates a successful file import.A ssl_result_message = File upload failed indicates an unsuccessful file import. |
ssl_user_id | Converge User ID The user ID that submitted the transaction. Field length: 15 Data type: alphanumeric |
ssl_number_trans | Transaction Count The number of transactions imported from the file. |
ssl_response_file | Response File Name |
ssl_recurring_batch_count | Recurring Batch Count The current number of recurring transactions in the recurring batch prior to processing the file. |
| [Error] | Returned only if an error occurs. Refer to the Error Codes section for more information. |
errorCode | Error Code 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. |