Update Installment - ccupdateinstall

This topic describes the message parameters for Credit Card Update Installment transaction processing, which you can submit using the XML API integration method. Refer to the Integration Methods section for more information.

The ccupdateinstall transaction updates a credit card installment record in Converge.

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.	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. 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 Valid value: `ccupdateinstall`	Required	20	alphanumeric
`ssl_installment_id`	Installment ID Unique identifier of the installment record to be updated.	Required	50	alphanumeric
[Card data]
`ssl_card_number`	Card number Card number as it appears on the credit card. Required when adding an installment record using a card number.	Required	18	numeric
`ssl_exp_date`	Card’s Expiry Date Date when the card becomes invalid. Format: MMYY Required if `ssl_card_number` is not null.	Required	4	numeric
[Payment Schedule]
`ssl_amount`	Transaction Amount The Installment amount that includes the Net and Sales Tax amounts. Format: Number with 2 decimal places	Required	11	numeric
`ssl_total_installments`	Number of Payments Total number of installment payments for a transaction.	Optional	4	numeric
`ssl_next_payment_date`	Next Payment Date The date of the next scheduled payment for the installment record. Format: MM/DD/YYYY	Optional	10	alphanumeric
`ssl_billing_cycle`	Billing Cycle Valid values: `DAILY`, `WEEKLY`, `BIWEEKLY`, `SEMIMONTHLY`, `MONTHLY`, `BIMONTHLY`,`QUARTERLY`, `SEMESTER`, `SEMIANNUALLY`, `ANNUALLY`, `SUSPENDED`	Optional	12	alphanumeric
`ssl_bill_on_half`	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	Conditional	1	numeric
`ssl_end_of_month`	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).	Conditional	1	alphanumeric
`ssl_skip_payment`	Skip Payment Indicator Valid values: `Y` - Skip payment `N` - Do not skip payment (Default)	Optional	1	alphanumeric
[Optional Fields]
`ssl_avs_address`	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.	Optional	30	alphanumeric
`ssl_avs_zip`	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.	Optional	9	alphanumeric
`ssl_first_name`	First Name First name on the cardholder’s / customer’s account or billing address.	Optional	50	alphanumeric
`ssl_last_name`	Last Name Last name on the cardholder’s / customer’s account or billing address.	Optional	50	alphanumeric
[Purchasing Cards]	Use only on terminals that are set up with the Purchasing Card 2 credit card payment option.
`ssl_customer_code`	Customer Code or Purchase Order Number Customer ID or PO number specified in the billing statement of the cardholder.	Optional	17	alphanumeric
`ssl_salestax`	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.	Optional	8	alphanumeric
[Invoice Number]	Returned only if Invoice Number parameters are sent in the request.
`ssl_invoice_number`	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.
`ssl_dynamic_dba`	Doing Business As Name Merchant-defined descriptors that replace the merchant’s business name on credit card statements. Format: PrefixDescriptor Length:* Prefix = 3, 7, or 12, Asterisk = 1, Descriptor = 21 - (Prefix + Asterisk) Important: DBA Prefix must be set using DBA Payment Fields Settings UI if ssl_dynamic_dba is used. Example: MANYMAG*BAKERS MONTHLY	Conditional	21	alphanumeric
`ssl_dynamic_dba_address`	Dynamic DBA Address The dynamic doing business as street address for this transaction. This value allows a merchant use an alternate address for this transaction.	Optional	30	alphanumeric
`ssl_dynamic_dba_auth_type`	Merchant ID The dynamic doing business as authorization type. Valid values: `F` - Final `P` - Pre-authorize	Optional	1	alphanumeric
`ssl_dynamic_dba_city`	Dynamic City Name This value allows a merchant use an alternate city as part of the address for this transaction	Optional	13	alphanumeric
`ssl_dynamic_dba_country`	Dynamic Country ISO Code This value allows a merchant specify an alternate country as part of the address for this transaction.	Optional	3	alphanumeric
`ssl_dynamic_dba_email`	Dynamic Email Address This value allows a merchant specify an alternate email address for this transaction.	Optional	70	alphanumeric
`ssl_dynamic_dba_mcc`	Dynamic Merchant Category Code This value allows a merchant specify an alternate merchant category for this transaction.	Optional	22	numeric
`ssl_dynamic_dba_phone`	Dynamic Phone Number This value allows a merchant specify an alternate phone number for this transaction.	Optional	20	alphanumeric
`ssl_dynamic_dba_postal`	Dynamic Postal or ZIP Code This value allows a merchant set an alternate postal code for a transaction.	Optional	9	alphanumeric
`ssl_dynamic_dba_state`	Dynamic State Code This value allows a merchant set an alternate state code for a transaction.	Optional	2	alphanumeric
`ssl_dynamic_dba_submid`	Dynamic Sub-merchant ID This value allows a merchant set an alternate sub-merchant ID for a transaction.	Optional	22	numeric
`ssl_dynamic_dba_taxid`	Dynamic Merchant Tax ID This value allows a merchant set an alternate Tax ID for this transaction.	Optional	14	alphanumeric

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 added. A result of ERROR indicates that the installment record was not added.
`ssl_card_short_description`	Short Card Brand Name Valid values: `AMEX`, `CUP`, `DISC`, `MC`, `PP`, and `VISA`
`ssl_card_number`	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).
`ssl_installment_id`	Installment ID Unique identifier of the added installment record. Important: Returned only if `ssl_result_message` = SUCCESS.
`ssl_amount`	Installment Amount
`ssl_total_installments`	Total Number of Payments
`ssl_number_of_payments`	Number of Payments The current number of payments run on the system. Returned by Converge.
`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 updated.
[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

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

xmldata=
<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_test_mode>false</ssl_test_mode>
    <ssl_transaction_type>ccupdateinstall</ssl_transaction_type>
    <ssl_installment_id>250422A40-E41AEC86-F481-4BDC-B2ED-891017425C1F</ssl_installment_id>
    <ssl_card_number>4111111111111111</ssl_card_number>
    <ssl_exp_date>12/22</ssl_exp_date>
    <ssl_amount>10.00</ssl_amount>
</txn>

Response

<txn>
    <ssl_last_name></ssl_last_name>
    <ssl_billing_cycle>BIWEEKLY</ssl_billing_cycle>
    <ssl_company></ssl_company>
    <ssl_number_of_payments>0</ssl_number_of_payments>
    <ssl_phone></ssl_phone>
    <ssl_card_number>41**********1111</ssl_card_number>
    <ssl_result>0</ssl_result>
    <ssl_ship_to_last_name></ssl_ship_to_last_name>
    <ssl_email></ssl_email>
    <ssl_avs_zip>95391</ssl_avs_zip>
    <ssl_amount>10.00</ssl_amount>
    <ssl_total_installments>10</ssl_total_installments>
    <ssl_transaction_currency>CAD</ssl_transaction_currency>
    <ssl_exp_date>1222</ssl_exp_date>
    <ssl_card_short_description>VISA</ssl_card_short_description>
    <ssl_address2></ssl_address2>
    <ssl_country></ssl_country>
    <ssl_card_type>creditcard</ssl_card_type>
    <ssl_installment_id>250422A40-E41AEC86-F481-4BDC-B2ED-891017425C1F</ssl_installment_id>
    <ssl_transaction_type>CCUPDATEINSTALL</ssl_transaction_type>
    <ssl_start_payment_date>04/30/2022</ssl_start_payment_date>
    <ssl_next_payment_date>04/30/2022</ssl_next_payment_date>
    <ssl_avs_address>first street</ssl_avs_address>
    <ssl_ship_to_first_name></ssl_ship_to_first_name>
    <ssl_ship_to_company></ssl_ship_to_company>
    <ssl_ship_to_state></ssl_ship_to_state>
    <ssl_recurring_batch_count>136</ssl_recurring_batch_count>
    <ssl_state></ssl_state>
    <ssl_ship_to_country></ssl_ship_to_country>
    <ssl_ship_to_zip></ssl_ship_to_zip>
    <ssl_city></ssl_city>
    <ssl_result_message>SUCCESS</ssl_result_message>
    <ssl_first_name></ssl_first_name>
    <ssl_ship_to_phone></ssl_ship_to_phone>
    <ssl_ship_to_city></ssl_ship_to_city>
    <ssl_ship_to_address1></ssl_ship_to_address1>
    <ssl_ship_to_address2></ssl_ship_to_address2>
    <ssl_skip_payment>N</ssl_skip_payment>
    <ssl_partner_app_id>01</ssl_partner_app_id>
</txn>

Cash Advance

Apple Pay

Magento Guide

Update Installment - ccupdateinstall

Request

Response

Example

Request

Response