Update Recurring - ecsupdaterecurring

This section describes the message parameters for Electronic Check Update Recurring Transaction processing, which you can submit using the XML API integration method. Refer to the Integration Methods section for more information.

The ecsupdaterecurring transaction updates an existing ACH ECheck recurring payment in the Converge recurring batch.

In this section:

For the entire list of API endpoints, refer to API Endpoints.


Field nameDescriptionRequiredLengthData type
ssl_merchant_idMerchant ID
Elavon-assigned Converge account ID.
ssl_user_idConverge User ID
The user ID with Hosted Payment API User status that can send transaction requests through the terminal.
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.
ssl_transaction_typeTransaction Type
ssl_recurring_idRecurring ID
Unique identifier of the recurring payment record to be updated.
ssl_agreeAgreement Indicator
Valid values:
  • 0 - Does not agree
  • 1 - Agrees
ssl_amountTransaction Amount
The recurring payment amount.
Format: Number with 2 decimal places
ssl_aba_numberRouting or Transit Number
Unique code assigned to the bank to be able to send and receive funds from other financial institutions.
ssl_bank_account_numberBank Account Number
Unique identifier of the checking account.
ssl_bank_account_typeBank Account Type
Indicates the type of checking account.
Valid values:
  • 0 - Personal
  • 1 - Business
ssl_first_nameFirst Name
First name on the cardholder’s / customer’s account or billing address.
Important: Required if ssl_bank_account_type = 0.
ssl_last_nameLast Name
Last name on the cardholder’s / customer’s account or billing address.
Important: Required if ssl_bank_account_type = 0.
ssl_companyCompany Name
Company name on the cardholder’s / customer’s account or billing address.
Important: Required if ssl_bank_account_type = 1.
ssl_next_payment_dateNext Payment Date
The date of the next scheduled payment for the recurring record.
Format: MM/DD/YYYY
ssl_billing_cycleBilling Cycle
ssl_bill_on_halfHalf 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_monthEnd 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_paymentSkip Payment Indicator
Valid values:
  • Y - Skip payment
  • N - Do not skip payment (Default)
ssl_descriptionMerchant-defined Transaction Description
Short and custom text to describe the transaction.


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 recurring record was added.
A result of ERROR indicates that the recurring record was not added.
ssl_recurring_idRecurring ID
Unique identifier of the added recurring record.
Important: Returned only if ssl_result_message = SUCCESS.
ssl_amountRecurring Amount
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 recurring transaction has been updated.
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.



  • In this example, you will have to change the data values, such as my_merchant_id, my_user_id, my_pin, and transaction data to match your Converge account and meet the needs of your website.
  • Code samples provided are for demonstration only and should not be used for live transactions. All sensitive merchant data, including transaction amounts and your Converge credentials, should be placed in server side code.

This example demonstrates the minimum Required data to update a recurring transaction and set the billing payment to Suspended.