Add Installment - ccaddinstall

This topic describes the message parameters for Credit Card 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 ccaddinstall transaction adds a credit card installment record to the Converge recurring batch. Once added, the transaction will run automatically within the specified billing cycle on the scheduled payment day without the need to send it for authorization.

In this topic:


15 | numeric | required
Merchant ID
Elavon-assigned Converge account ID.
15 | alphanumeric | required
Converge User ID
The user ID with Hosted Payment API User status that can send transaction requests through the terminal.
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.
20 | alphanumeric | required
Transaction Type
Value: ccaddinstall
[Card Data]
Use the appropriate card data parameters for the transaction.
18 | numeric | conditional
Card Number
Card Number as it appears on the credit card.
Important: Required when adding an installment record using a card number.
4 | numeric | conditional
Card's Expiry Date
Date when the card becomes invalid.
Important: Required if ssl_card_number is not null.
Format: MMYY
20 | alphanumeric | conditional
Credit Card Token
Encrypted card data that can replace ssl_card_number.
  • Required when adding an installment record using a token.
  • If token is stored in Card Manager, the expiration date, first name, last name, and AVS data on file are used.
  • Use only if the terminal is set up with the Tokenization   terminal option.
46 | alphanumeric | required
Transaction ID
Unique identifier of the approved Sale (ccsale), Auth Only (ccauthonly), Force (ccforce), or Return (ccreturn) transaction.
  • Required when adding an installment record based on a previously approved transaction.
  • Only applicable to XML API.
[Payment Schedule]
11 | numeric | required
Transaction Amount
The Installment amount that includes the Net and Sales Tax amounts.
Format: Number with 2 decimals places
4 | numeric | required
Number of Payments
Total number of installment payments for a transaction.
10 | alphanumeric | required
Next Payment Date
The date of the next scheduled payment for the installment record.
Format: MM/DD/YYYY
12 | alphanumeric | required
Billing Cycle
1 | numeric | conditional
Half of the Month or Semimonthly Indicator
Indicates when to process installment payment transactions if ssl_billing_cycle = SEMIMONTHLY.
Valid values:
  • 1 - 1st and 15th of the month
  • 2 - 15th and last day of the month
1 | alphanumeric | conditional
End of Month Indicator
Indicates whether to process the installment transaction on the last day of the month.
Valid values:
  • Y - Yes
  • N - No
Select Y to process the installment 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).
1 | alphanumeric | optional
Skip Payment Indicator
Valid values:
  • Y - Skip payment
  • N - Do not skip payment (Default)
[Optional Fields]
30 | alphanumeric | optional
Address Line 1
Commonly the house number and street name on the cardholder's / customer's account or billing address.
Address Verification Service (AVS) data compared with the address on the card issuer's file.
9 | alphanumeric | optional
Postal or ZIP Code
ZIP code on the cardholder's account or billing address.
Address Verification Service (AVS) data compared with the postal or ZIP code on the card issuer's file.
20 | alphanumeric | optional
First Name
First name on the cardholder's / customer's account or billing address.
30 | alphanumeric | optional
Last Name
Last name on the cardholder's / customer's account or billing address.
[Purchasing Cards]
Use only on terminals that are set up with the Purchasing Card 2   credit card payment option.
17 | alphanumeric | optional
Customer Code or Purchase Order Number
Customer ID or PO number specified in the billing statement of the cardholder.
8 | alphanumeric | optional
Sales Tax
Tax amount to add to the purchase or sales amount. For a tax exempt transaction, enter 0.00.
Format: Amount with 2 decimal places.
[Invoice Number]
Returned only if Invoice Number  parameters are sent in the request.
Invoice Number
The invoice number or ticket number sent in the original request.
[Doing Business As]
Use only on terminals that are set up with the DBA Name   terminal option.
21 | alphanumeric | optional
Doing Business As Name
Merchant-defined descriptors that replace the merchant's business name on credit card statements.
Format: Prefix*Descriptor 
Length: Prefix = 3, 7, or 12,  Asterisk = 1,  Descriptor = 21 - (Prefix + Asterisk)


Transaction Outcome
An ssl_result = 0 indicates an approved transaction.
An ssl_result not equal to 0 indicates a declined and unauthorized transaction.
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.
Masked Card Number
Converge only returns the first 2 or last 4 digits of the regular PAN, or the last 4 digits of the actual card number if it is an association token (example, ApplePay).
Installment ID
Unique identifier of the added installment record.
Important: Returned only if ssl_result_message = SUCCESS.
Installment Amount
Total Number of Payments
Billing Cycle
Next Payment Due 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
Recurring Batch Count
The current number of transactions sitting in the recurring batch after the installment transaction has been added.
Returned only if an error occurs. Refer to the Error Codes section for more information.
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.
Error Message
Detailed explanation of the error. This field may be changed based on merchant configuration in the user interface.
Error 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.


    <ssl_avs_address>123 Main</ssl_avs_address>


    <ssl_avs_address>123 Main</ssl_avs_address>