Submit Installment Payment - ecsinstallsale

This section describes the message parameters for Electronic Check Submit Installment Payment transaction processing, which you can submit using the XML API integration method. Refer to the Integration Methods section for more information.

The ecsinstallsale transaction allows you to run an ACH ECheck installment payment outside of its billing cycle and increase the total number of payments.

In this section:

Request

Field nameDescriptionRequiredLengthData type
ssl_merchant_idMerchant ID
Elavon-assigned Converge account ID.
Required15numeric
ssl_user_idConverge User ID
The user ID with Hosted Payment API User status that can send transaction requests through the terminal.
Required15alphanumeric
ssl_pinTerminal 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.
Required64alphanumeric
ssl_transaction_typeTransaction Type
Value:ecsinstallsale
Required20alphanumeric
ssl_install_idInstallment Record ID
Unique identifier of the installment record to be submitted for payment.
Required--

Response

Field nameDescription
ssl_resultTransaction Outcome
An ssl_result = 0 indicates an approved transaction.
An ssl_result not equal to 0 indicates a declined and unauthorized transaction.
ssl_result_messageTransaction Result Message
A result of SUCCESS indicates that the installment record was submitted for payment.
A result of ERROR indicates that the installment record was not submitted for payment.
ssl_txn_idTransaction ID
Unique identifier of the transaction.
ssl_txn_timeProcessing 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
ssl_approval_codeTransaction Approval Code
Unique code returned that indicates the approval status of the transaction.
ssl_installment_idInstallment ID
Unique identifier of the installment record sent for payment
ssl_amountAuthorized/Approved Transaction Amount
Returned based on merchant setup.
ssl_total_installmentsTotal Number of Payments
ssl_number_of_paymentsNumber of Payments
The number of payments ran.
ssl_billing_cycleBilling Cycle
ssl_next_payment_dateNext Payment Due Date
ssl_start_payment_datePayment 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_countRecurring Batch Count
The current number of transactions sitting in the recurring batch after the installment transaction has been sent for payment.
ssl_aba_numberRouting or Transit Number
ssl_bank_account_numberMasked Bank Account Number
ssl_bank_account_typeBank Account Type
ssl_first_nameFirst Name
Returned based on merchant setup.
ssl_last_nameLast Name
Returned based on merchant setup.
ssl_companyCompany Name
Returned based on merchant setup.
ssl_descriptionMerchant-defined Transaction Description
Returned based on merchant setup.
[Error]Returned only if an error occurs. Refer to the Error Codes section for more information.
errorCodeError 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.
errorMessageError Message
Detailed explanation of the error. This field may be changed based on merchant configuration in the user interface.
errorNameError Name
Error name or reason for the error.