Add Installment - ecsaddinstall
This section describes the message parameters for Electronic Check Add Installment Transaction processing, 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 ecsaddinstall transaction adds an ACH ECheck installment payment to the Converge recurring batch.
Once added, the transaction will run automatically for the number of installments specified within the specified billing cycle on the scheduled payment day without the need to send it for authorization. Once the total number of installments is reached, the payments will stop running.
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: ecsaddinstall | Required | 20 | alphanumeric |
ssl_amount | Transaction Amount The installment payment amount. Format: Number with 2 decimal places | Required | 11 | numeric |
ssl_aba_number | Routing or Transit Number Unique code assigned to the bank to be able to send and receive funds from other financial institutions. | Required | 9 | alphanumeric |
ssl_bank_account_number | Bank Account Number Unique identifier of the checking account. | Required | 16 | numeric |
ssl_bank_account_type | Bank Account Type Indicates the type of checking account. Valid values:
| Required | 1 | numeric |
ssl_agree | Agreement Indicator Valid values:
| Required | 1 | numeric |
ssl_first_name | First Name First name on the cardholder’s / customer’s account or billing address. Important: Required if ssl_bank_account_type = 0. | Conditional | 50 | alphanumeric |
ssl_last_name | Last Name Last name on the cardholder’s / customer’s account or billing address. Important: Required if ssl_bank_account_type = 0. | Conditional | 50 | alphanumeric |
ssl_company | Company Name Company name on the cardholder’s / customer’s account or billing address. Important: Required if ssl_bank_account_type = 1. | Conditional | 50 | alphanumeric |
ssl_next_payment_date | Next Payment Date The date of the next scheduled payment for the recurring record. Format: MM/DD/YYYY | Required | 10 | alphanumeric |
ssl_total_installments | Number of Payments Total number of installment payments for the transaction. | Required | 4 | numeric |
ssl_billing_cycle | Billing Cycle Valid values: DAILY, WEEKLY, BIWEEKLY, SEMIMONTHLY, MONTHLY, BIMONTHLY, QUARTERLY, SEMESTER, SEMIANNUALLY, ANNUALLY, SUSPENDED | Required | 12 | alphanumeric |
ssl_bill_on_half | Half of the Month or Semimonthly Indicator Indicates when to process recurring payment transactions if ssl_billing_cycle = SEMIMONTHLY.Valid values:
| Conditional | 1 | numeric |
ssl_end_of_month | End of Month Indicator Indicates whether to process the recurring transaction on the last day of the month. Valid values:
| Conditional | 1 | alphanumeric |
ssl_skip_payment | Skip Payment Indicator Valid values:
| Optional | 1 | alphanumeric |
ssl_description | Merchant-defined Transaction Description Short and custom text to describe the transaction. | Optional | 255 | 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 A result of SUCCESS indicates that the installment record was added. A result of ERROR indicates that the installment record was not added. |
ssl_installment_id | Installment ID Unique identifier of the added installment record. Important: Returned only if ssl_result_message = SUCCESS. |
ssl_amount | Installment Amount |
ssl_total_installments | Number of Payments |
ssl_billing_cycle | Billing Cycle |
ssl_next_payment_date | Next Payment Due Date |
ssl_start_payment_date | Payment Start Date The date when the first payment started. If recently added, the start date is the same as the next payment due date. Format: MM/DD/YYYY |
ssl_recurring_batch_count | Recurring Batch Count The current number of transactions sitting in the recurring batch after the installment transaction has been added. |
ssl_aba_number | Routing or Transit Number |
ssl_bank_account_number | Masked Bank Account Number |
ssl_bank_account_type | Bank Account Type Indicates the type of checking account. Valid values:
|
ssl_first_name | First Name Returned based on merchant setup. |
ssl_last_name | Last Name Returned based on merchant setup. |
ssl_company | Company Name Returned based on merchant setup. |
ssl_description | Merchant-defined Transaction Description Returned based on merchant setup. |
| [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. |