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 topic:
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: ccupdateinstall |
ssl_installment_id 50 | alphanumeric | required | Installment ID Unique identifier of the installment record to be updated. |
[Card Data] | |
ssl_card_number 18 | numeric | required | Card Number Card Number as it appears on the credit card. Important: Required when adding an installment record using a card number. |
ssl_exp_date 4 | numeric | required | Card's Expiry Date Date when the card becomes invalid. Important: Required if ssl_card_number is not null.Format: MMYY |
[Payment Schedule] | |
ssl_amount 11 | numeric | required | Transaction Amount The Installment amount that includes the Net and Sales Tax amounts. Format: Number with 2 decimals places |
ssl_total_installments 4 | numeric | optional | Number of Payments Total number of installment payments for a transaction. |
ssl_next_payment_date 10 | alphanumeric | optional | Next Payment Date The date of the next scheduled payment for the installment record. Format: MM/DD/YYYY |
ssl_billing_cycle 12 | alphanumeric | optional | Billing Cycle Valid values: DAILY , WEEKLY , BIWEEKLY , SEMIMONTHLY , MONTHLY , BIMONTHLY , QUARTERLY , SEMESTER , SEMIANNUALLY , ANNUALLY , SUSPENDED |
ssl_bill_on_half 1 | numeric | conditional | Half of the Month or Semimonthly Indicator Indicates when to process installment payment transactions if ssl_billing_cycle = SEMIMONTHLY.Valid values:
|
ssl_end_of_month 1 | alphanumeric | conditional | End of Month Indicator Indicates whether to process the installment transaction on the last day of the month. Valid values:
|
ssl_skip_payment 1 | alphanumeric | optional | Skip Payment Indicator Valid values:
|
[Optional Fields] | |
ssl_avs_address 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. |
ssl_avs_zip 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. |
ssl_first_name 20 | alphanumeric | optional | First Name First name on the cardholder's / customer's account or billing address. |
ssl_last_name 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. |
ssl_customer_code 17 | alphanumeric | optional | Customer Code or Purchase Order Number Customer ID or PO number specified in the billing statement of the cardholder. |
ssl_salestax 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. |
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 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) Example: MANYMAG*BAKERS MONTHLY |
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 installment record was updated. A result of ERROR indicates that the installment record was not updated. |
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 updated 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 ran 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. |