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:

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.
The ssl_user_id sending the transaction request must be associated with the terminal that will process the request.
Required64alphanumeric
ssl_transaction_typeTransaction Type
Valid value:ccaddinstall
Required20alphanumeric
[Card data]Use the appropriate card data parameters for the transaction.
ssl_card_numberCard number
Card number as it appears on the credit card.

important

Required when adding an installment record using a card number.

Conditional18numeric
ssl_exp_dateCard’s Expiry Date
Date when the card becomes invalid.
Format: MMYY
Required if ssl_card_number is not null.
Conditional4numeric
ssl_tokenCredit 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.
Conditional20alphanumeric
ssl_txn_idTransaction 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.
Required46alphanumeric
[Payment Schedule]
ssl_amountTransaction Amount
The Installment amount that includes the Net and Sales Tax amounts.
Format: Number with 2 decimals places
Required11numeric
ssl_total_installmentsNumber of Payments
Total number of installment payments for a transaction.
Required4numeric
ssl_next_payment_dateNext Payment Date
The date of the next scheduled payment for the installment record.
Format: MM/DD/YYYY
Required10alphanumeric
ssl_billing_cycleBilling Cycle
Valid values:DAILY, WEEKLY, BIWEEKLY, SEMIMONTHLY, MONTHLY, BIMONTHLY,QUARTERLY, SEMESTER, SEMIANNUALLY, ANNUALLY, SUSPENDED
Required12alphanumeric
ssl_bill_on_halfHalf 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
Conditional1numeric
ssl_end_of_monthEnd 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).
Conditional1alphanumeric
ssl_skip_paymentSkip Payment Indicator
Valid values:
- Y - Skip payment
- N - Do not skip payment (Default)
Optional1alphanumeric
[Optional Fields]
ssl_avs_addressAddress 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.
Optional30alphanumeric
ssl_avs_zipPostal 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.
Optional9alphanumeric
ssl_first_nameFirst Name
First name on the cardholder’s / customer’s account or billing address.
Optional20alphanumeric
ssl_last_nameLast Name
Last name on the cardholder’s / customer’s account or billing address.
Optional30alphanumeric
[Purchasing Cards]Use only on terminals that are set up with the Purchasing Card 2 credit card payment option.
ssl_customer_codeCustomer Code or Purchase Order Number
Customer ID or PO number specified in the billing statement of the cardholder.
Optional17alphanumeric
ssl_salestaxSales 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.
Optional8alphanumeric
[Invoice Number]Returned only if Invoice Number parameters are sent in the request.
ssl_invoice_numberInvoice 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.
ssl_dynamic_dbaDoing 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)
Example: MANYMAG*BAKERS MONTHLY
Optional21alphanumeric

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 added.
A result of ERROR indicates that the installment record was not added.
ssl_card_numberMasked 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).
ssl_installment_idInstallment ID
Unique identifier of the added installment record.

important

Returned only if ssl_result_message = SUCCESS.

ssl_amountInstallment Amount
ssl_total_installmentsTotal Number of Payments
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.
[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.

Example

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.

Request

<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_card_number>0000000000000000</ssl_card_number>
    <ssl_exp_date>1215</ssl_exp_date>
    <ssl_amount>5.00</ssl_amount>
    <ssl_transaction_type>ccaddinstall</ssl_transaction_type>
    <ssl_customer_code>FF1234</ssl_customer_code>
    <ssl_billing_cycle>WEEKLY</ssl_billing_cycle>
    <ssl_next_payment_date>01/30/2014</ssl_next_payment_date>
    <ssl_total_installments>10</ssl_total_installments>
    <ssl_first_name>John</ssl_first_name>
    <ssl_last_name>Doe</ssl_last_name>
    <ssl_avs_address>123 Main</ssl_avs_address>
    <ssl_city>Atlanta</ssl_city>
    <ssl_state>GA</ssl_state>
    <ssl_avs_zip>30123</ssl_avs_zip>
    <ssl_country>USA</ssl_country>
</txn>

Response

<txn>
    <ssl_last_name>Doe</ssl_last_name>
    <ssl_result_message>SUCCESS</ssl_result_message>
    <ssl_country>USA</ssl_country>
    <ssl_city>Atlanta</ssl_city>
    <ssl_number_of_payments>0</ssl_number_of_payments>
    <ssl_billing_cycle>WEEKLY</ssl_billing_cycle>
    <ssl_start_payment_date>01/30/2014</ssl_start_payment_date>
    <ssl_transaction_type>CCADDINSTALL</ssl_transaction_type>
    <ssl_total_installments>10</ssl_total_installments>
    <ssl_avs_zip>30123</ssl_avs_zip>
    <ssl_exp_date>1215</ssl_exp_date>
    <ssl_avs_address>123 Main</ssl_avs_address>
    <ssl_salestax>0</ssl_salestax>
    <ssl_next_payment_date>01/30/2014</ssl_next_payment_date>
    <ssl_address2/>
    <ssl_skip_payment>N</ssl_skip_payment>
    <ssl_first_name>John</ssl_first_name>
    <ssl_recurring_batch_count>23</ssl_recurring_batch_count>
    <ssl_amount>5.00</ssl_amount>
    <ssl_state>GA</ssl_state>
    <ssl_card_number>00**********0000</ssl_card_number>
    <ssl_installment_id>AA49315-AB9B8587-ECE6-445A-A2A4-3B00A9985C0A</ssl_installment_id>
</txn>