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:
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: ecsinstallsale | Required | 20 | alphanumeric |
ssl_install_id | Installment Record ID Unique identifier of the installment record to be submitted for payment. | Required | - | - |
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 submitted for payment. A result of ERROR indicates that the installment record was not submitted for payment. |
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 |
ssl_approval_code | Transaction Approval Code Unique code returned that indicates the approval status of the transaction. |
ssl_installment_id | Installment ID Unique identifier of the installment record sent for payment |
ssl_amount | Authorized/Approved Transaction Amount Returned based on merchant setup. |
ssl_total_installments | Total Number of Payments |
ssl_number_of_payments | Number of Payments The number of payments ran. |
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 sent for payment. |
ssl_aba_number | Routing or Transit Number |
ssl_bank_account_number | Masked Bank Account Number |
ssl_bank_account_type | Bank Account Type |
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. |