Submit Installment Payment - ccinstallsale

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

The ccinstallsale transaction allows you to run a credit card installment payment outside of its billing cycle. This will increase the payment number.

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:ccinstallsale
Required20alphanumeric
ssl_installment_idInstallment ID
Unique identifier of the installment record to be authorized.
Required50alphanumeric
[Tokenization]Use only on terminals that are set up with the Tokenization terminal option.
ssl_add_tokenAdd to Card Manager Indicator
Indicates whether to generate and store the token in Card Manager.
Valid values:
- Y - Authorize transaction, generate and store token
- N - Do not store token (Default)
Optional1alphanumeric
ssl_first_nameFirst Name
First name on the cardholder’s / customer’s account or billing address.
Required if ssl_add_token is set to Y.
Conditional20alphanumeric
ssl_last_nameLast Name
Last name on the cardholder’s / customer’s account or billing address.
Required if ssl_add_token is set to Y.
Conditional30alphanumeric
ssl_get_tokenGenerate Token Indicator
Indicates whether to generate a token when submitting the card data.
Valid values:
- Y - Authorize transaction and generate token
- N - Do not generate token (Default)
Optional1alphanumeric
[Card On File]
ssl_merchant_initiated_unscheduledMerchant-Initiated Unscheduled Transaction Indicator
Indicates the transaction was initiated by a merchant using a stored credential (token or stored card number) for a fixed or variable amount that does not occur on a scheduled or regularly occurring transaction date.
Valid values:
- Y - Yes
- N - No
Optional1alphanumeric

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
Refer to the Payment Card Response Codes section for an extensive list of possible returned messages.
ssl_txn_idTransaction ID
Unique identifier of the transaction.
ssl_txn_timeProcessing Date and Time
Indicates when Converge processed the transaction.
Format: MM/DD/YYYY hh:mm:ss AM/PM
Example: 03/18/2010 10:34:10 AM
ssl_approval_codeTransaction Approval Code
Unique code returned by the credit card processor that indicates the approval status of the transaction.
ssl_amountTotal Authorized/Approved Transaction Amount
Returned based on merchant setup.
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_exp_dateCard’s Expiry Date
Returned based on merchant setup.
ssl_installment_idInstallment ID
Unique identifier of the submitted installment record.
Important: Returned only if ssl_result_message = SUCCESS.
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_number_of_paymentsNumber of Payments
The current number of payments run on the system. Returned by Converge.
ssl_total_installmentsTotal Number of Payments
ssl_invoice_numberInvoice Number
The invoice number or ticket number sent in the original request. Returned based on merchant setup.
[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.