Submit Recurring Payment - ecsrecurringsale

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

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

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: ecsrecurringsale
ssl_recurring_id
50 | alphanumeric | required
Recurring ID
Unique identifier of the recurring payment record to be submitted for payment.

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 recurring record was submitted for payment.
A result of ERROR  indicates that the recurring 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_recurring_id
 
Recurring ID
Unique identifier of the recurring record sent for payment.
ssl_amount
 
Authorized/Approved Transaction Amount
Returned based on merchant setup.
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 recurring 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.

Example

error_outline
important
  • 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 send a recurring sale outside of the billing cycle.

<txn>
    <ssl_merchant_id>my_merchant_id</ssl_merchant_id>
    <ssl_user_id>my_user_id</ssl_user_id>
    <ssl_pin>my_pin</ssl_pin>
    <ssl_transaction_type>ecsrecurringsale</ssl_transaction_type>
    <ssl_recurring_id>190115A15-E123C27A-CC10-44E6-811E-185097739FD2</ssl_recurring_id>
</txn>