Delete Installment - ccdeleteinstall

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

The ccdeleteinstall transaction deletes a credit card installment record from Converge.

In this topic:

Request

Field name Description Required Length Data type
ssl_merchant_id Merchant ID
Elavon-assigned Converge account ID.
Required 15 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.
error_outline

important

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: ccdeleteinstall
Required 20 alphanumeric
ssl_installment_id Installment ID
Unique identifier of the installment record to be deleted.
Required 50 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 deleted.
A result of ERROR indicates that the installment record was not deleted.
ssl_installment_id Installment ID
Unique identifier of the deleted installment record.
error_outline

important

Returned only if ssl_result_message = SUCCESS.

ssl_recurring_batch_count Recurring Batch Count
The current number of transactions sitting in the recurring batch after the installment transaction has been deleted.
[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.