Delete Recurring - ccdeleterecurring
This topic describes the message parameters for Credit Card Delete Recurring transaction processing, which you can submit using the XML API integration method. Refer to the Integration Methods section for more information.
The ccdeleterecurring transaction deletes a credit card recurring record from Converge.
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: ccdeleterecurring | Required | 20 | alphanumeric |
ssl_recurring_id | Recurring ID Unique identifier of the recurring payment record to be deleted. | Required | 50 | alphanumeric |
Response
| Field name | Description |
|---|---|
ssl_result | Transaction Outcome An ssl_result = 0 indicates a deleted recurring record. |
ssl_result_message | Transaction Result Message A result of SUCCESS indicates that the recurring record was deleted. A result of ERROR indicates that the recurring record was not deleted. |
ssl_recurring_id | Recurring ID Unique identifier of the deleted recurring record. Important: - Returned only if ssl_result_message = SUCCESS.- No authorization or automatic payment can be run on the deleted Recurring ID. |
ssl_recurring_batch_count | Recurring Batch Count The current number of transactions sitting in the recurring batch after the recurring 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. |
Example
error_outline
important
- In this example, you will have to change the data values, such as
my_merchant_id,my_user_id,my_pin, and transaction data to match your Converge account and meet the needs of your website. - Code samples provided are for demonstration only and should not be used for live transactions. All sensitive merchant data, including transaction amounts and your Converge credentials, should be placed in server side code.
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_test_mode>false</ssl_test_mode>
<ssl_transaction_type>ccdeleterecurring</ssl_transaction_type>
<ssl_recurring_id>210422A40-4B6EC169-EA4A-4075-B6F7-E39F156FCD4C</ssl_recurring_id>
</txn>
Response
<txn>
<ssl_recurring_batch_count>131</ssl_recurring_batch_count>
<ssl_recurring_id>210422A40-4B6EC169-EA4A-4075-B6F7-E39F156FCD4C</ssl_recurring_id>
<ssl_result_message>SUCCESS</ssl_result_message>
<ssl_transaction_type>CCDELETERECURRING</ssl_transaction_type>
<ssl_result>0</ssl_result>
<ssl_card_type></ssl_card_type>
<ssl_partner_app_id>01</ssl_partner_app_id>
</txn>