Void - ccvoid
The Credit Card Void or ccvoid transaction removes a Sale, Credit or Force transaction from the open batch. Commonly used for same day returns or to correct cashier mistakes, and can only be performed before the batch is settled.
This section describes the message parameters for Credit Card Void transaction processing, which you can submit using the XML API integration method. Refer to the Integration Methods section for more information.
No funds will be deposited into the merchant’s bank account at Settlement.
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: ccvoid | Required | 20 | alphanumeric |
ssl_txn_id | Transaction ID Unique identifier of the approved Sale ( ccsale), Credit (cccredit) or Force (ccforce) transaction to be removed from the open batch. | Required | 46 | alphanumeric |
| [Optional Fields] | ||||
ssl_lane_number | Lane Number A unique identifier for point of sale devices that can be passed to satisfy Mastercard’s unique Terminal ID requirement | Optional | 8 | numeric |
Response
error_outline
note
The Void transaction returns:
- a new Transaction ID
- the original data such as billing, shipping and custom values
| 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
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>ccvoid</ssl_transaction_type>
<ssl_txn_id>AA49315-F494FC02-661E-4426-A410- A87F6249F26B</ssl_txn_id>
</txn>
Response
<txn>
<ssl_result>0</ssl_result>
<ssl_approval_code>N07033</ssl_approval_code>
<ssl_account_balance>0.00</ssl_account_balance>
<ssl_amount>1.00</ssl_amount>
<ssl_result_message>APPROVAL</ssl_result_message>
<ssl_invoice_number>PO456</ssl_invoice_number>
<ssl_description>Purchase</ssl_description>
<ssl_txn_id>AA49315-F494FC02-661E-4426-A410- A87F6249F26B</ssl_txn_id>
<ssl_card_number>00**********0000</ssl_card_number>
<ssl_txn_time>07/21/2021 03:15:31 PM</ssl_txn_time>
<ssl_avs_response/>A</ssl_avs_response>
<ssl_cvv2_response>M</ssl_cvv2_response>
</txn>