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:

Request


ssl_merchant_id 15 \| numeric \| required	Merchant ID Elavon-assigned Converge account ID.
ssl_user_id 15 \| alphanumeric \| required	Converge User ID The user ID with Hosted Payment API User status that can send transaction requests through the terminal.
ssl_pin 64 \| alphanumeric \| required	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.
ssl_transaction_type 20 \| alphanumeric \| required	Transaction Type Value: `ecsaddinstall`
ssl_amount 11 \| numeric \| required	Transaction Amount The installment payment amount. Format: Number with 2 decimals places
ssl_aba_number 9 \| alphanumeric \| required	Routing or Transit Number Unique code assigned to the bank to be able to send and receive funds from other financial institutions.
ssl_bank_account_number 16 \| numeric \| required	Bank Account Number Unique identifier of the checking account.
ssl_bank_account_type 1 \| numeric \| required	Bank Account Type Indicates the type of checking account. Valid values: `0` - Personal `1` - Business
ssl_agree 1 \| numeric \| required	Agreement Indicator Valid values: `0` - Does not agree `1` - Agrees
ssl_first_name 20 \| alphanumeric \| conditional	First Name First name on the cardholder's / customer's account or billing address. Important: Required if `ssl_bank_account_type` = 0.
ssl_last_name 30 \| alphanumeric \| conditional	Last Name Last name on the cardholder's / customer's account or billing address. Important: Required if `ssl_bank_account_type` = 0.
ssl_company 50 \| alphanumeric \| conditional	Company Name Company name on the cardholder's / customer's account or billing address. Important: Required if `ssl_bank_account_type` = 1.
ssl_next_payment_date 10 \| alphanumeric \| required	Next Payment Date The date of the next scheduled payment for the recurring record. Format: MM/DD/YYYY
ssl_total_installments 4 \| numeric \| required	Number of Payments Total number of installment payments for the transaction.
ssl_billing_cycle 12 \| alphanumeric \| required	Billing Cycle Valid values: `DAILY`, `WEEKLY`, `BIWEEKLY`, `SEMIMONTHLY`, `MONTHLY`, `BIMONTHLY`, `QUARTERLY`, `SEMESTER`, `SEMIANNUALLY`, `ANNUALLY`, `SUSPENDED`
ssl_bill_on_half 1 \| numeric \| conditional	Half of the Month or Semimonthly Indicator Indicates when to process recurring payment transactions if `ssl_billing_cycle` = SEMIMONTHLY. Valid values: `1` - 1st and 15th of the month `2` - 15th and last day of the month
ssl_end_of_month 1 \| alphanumeric \| conditional	End of Month Indicator Indicates whether to process the recurring transaction on the last day of the month. Valid values: `Y` - Yes `N` - No Select Y to process the recurring transaction: If `ssl_billing_cycle` = MONTHLY, BIMONTHLY, QUARTERLY, SEMESTER or SEMIANNUALLY and the Start Payment Date is April 30, June 30, September 30, November 30, February 28 (non-Leap year) or February 29 (Leap year). If `ssl_billing_cycle` = ANNUALLY and the Start Payment Date is February 28 (non-Leap year) or February 29 (Leap year).
ssl_skip_payment 1 \| alphanumeric \| optional	Skip Payment Indicator Valid values: `Y` - Skip payment `N` - Do not skip payment (Default)
ssl_description 255 \| alphanumeric \| optional	Merchant-defined Transaction Description Short and custom text to describe the transaction.

Response


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: `0` - Personal `1` - Business
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.