Delete - ccdelete
The Credit Card Delete or ccdelete transaction deletes and attempts a Reversal on a Credit Card Sale or Auth Only transaction.
This section describes the message parameters for Credit Card Delete transaction processing, which you can submit using the XML API integration method. Refer to the Integration Methods section for more information.
This transaction is typically used in a Partial Approval scenario. When a consumer decides not to continue with an additional tender type, the point of sale application must send a reversal to cancel the payment and restore the balance to the card. Reversal frees up the cardholders’ open to buy amounts by reducing issuer holds on available balances when transactions are not completed. This reduces declines at the point of sale and the amount of cardholder complaints that are unpleasant for all parties involved.
note
- A transaction that has been deleted from the batch cannot be recovered.
- Users must have the Batches-Void Delete user right in order to delete a transaction.
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 (AID). | 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: ccdelete | Required | 20 | alphanumeric |
ssl_txn_id | Transaction ID Unique identifier of the approved Sale ( ccsale) or Auth Only (ccauthonly) transaction to be deleted and reversed. | Required | 46 | 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 Refer to the Payment Card Response Codes section for an extensive list of possible returned messages. |
ssl_txn_id | Transaction ID Unique identifier of the transaction. |
ssl_txn_time | Processing Date and Time Indicates when Converge processed the transaction. Format: MM/DD/YYYY hh:mm:ss AM/PM Example: 03/18/2022 10:34:10 AM |
ssl_approval_code | Transaction Approval Code Unique code returned by the credit card processor that indicates the approval status of the transaction. |
ssl_invoice_number | Invoice Number The invoice number or ticket number sent in the original request. Returned based on merchant setup. |
ssl_email | Email Address The cardholder’s or customer’s email address. Returned based on merchant setup. |
| [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
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_transaction_type>ccdelete</ssl_transaction_type>
<ssl_txn_id>210422A41-E8A1718C-3E58-4861-AD97-FC92F5381CD9</ssl_txn_id>
</txn>
Response
<txn>
<ssl_service_fee_amount></ssl_service_fee_amount>
<ssl_transaction_type>DELETE</ssl_transaction_type>
<ssl_card_number>40**********0440</ssl_card_number>
<ssl_result>0</ssl_result>
<ssl_txn_id>210422A41-E8A1718C-3E58-4861-AD97-FC92F5381CD9</ssl_txn_id>
<ssl_amount>15.00</ssl_amount>
<ssl_transaction_currency></ssl_transaction_currency>
<ssl_txn_time>04/21/2022 06:03:29 AM</ssl_txn_time>
<ssl_exp_date>0424</ssl_exp_date>
<ssl_result_message>APPROVAL</ssl_result_message>
<ssl_card_short_description>VISA</ssl_card_short_description>
<ssl_credit_surcharge_amount></ssl_credit_surcharge_amount>
<ssl_customer_code></ssl_customer_code>
<ssl_card_type>CREDITCARD</ssl_card_type>
<ssl_invoice_number>90511645738260995</ssl_invoice_number>
<ssl_partner_app_id>01</ssl_partner_app_id>
</txn>