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.
ccupdateinstall transaction updates a credit card installment record in Converge.
In this topic:
|Field name||Description||Required||Length||Data type|
Elavon-assigned Converge account ID.
|Converge user ID|
The user ID with Hosted Payment API user status that can send transaction requests through the terminal.
Unique identifier of the terminal that will process the transaction request and submit to the Converge gateway.
Unique identifier of the installment record to be updated.
Card number as it appears on the credit card.
Required when adding an installment record using a card number.
|Card’s Expiry Date|
Date when the card becomes invalid.
The Installment amount that includes the Net and Sales Tax amounts.
Format: Number with 2 decimal places
|Number of Payments|
Total number of installment payments for a transaction.
|Next Payment Date|
The date of the next scheduled payment for the installment record.
|Half of the Month or Semimonthly Indicator|
Indicates when to process installment payment transactions if
|End of Month Indicator|
Indicates whether to process the installment transaction on the last day of the month.
Select Y to process the installment transaction:
|Skip Payment Indicator|
|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.
|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.
First name on the cardholder’s / customer’s account or billing address.
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.|
|Customer Code or Purchase Order Number|
Customer ID or PO number specified in the billing statement of the cardholder.
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.|
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.|
|Doing Business As Name|
Merchant-defined descriptors that replace the merchant’s business name on credit card statements.
Length: Prefix = 3, 7, or 12, Asterisk = 1, Descriptor = 21 - (Prefix + Asterisk)
Example: MANYMAG*BAKERS MONTHLY
|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).
Unique identifier of the added installment record.
Important: Returned only if
|Total Number of Payments|
|Number of Payments|
The current number of payments run on the system. Returned by Converge.
|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.
|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.|
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.
Detailed explanation of the error. This field may be changed based on merchant configuration in the user interface.
Error name or reason for the error.