Completion - cccomplete

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

The cccomplete transaction places an approved Auth Only transaction into the open batch for settlement and converts the approved Auth Only transaction into a Sale transaction.

The supported completion types are as follows:

  • Full completion

    Send cccomplete with the Auth Only Transaction ID without any amount, if you wish to convert an existing Auth Only to Sale. The entire Auth Only transaction will move from the Auth Only batch to the Main batch for settlement.

  • Partial-completion

    Send cccomplete with the Auth Only Transaction ID with an amount that is less than the original Auth Only amount, if you wish to convert only a portion of the Auth Only to Sale. The Auth Only transaction will move from the Auth Only batch to the Main batch and the transaction will only be settled for smaller amount. The original Auth Only transaction cannot be used again.

  • Multi partial-completion

    Send cccomplete with the Auth Only Transaction ID with an amount that is less than the Auth Only amount and the Partial Shipment Indicator, this action will allow you to keep the unused portion of the Auth Only amount in the Auth Only batch, and convert only the desired portion to the Main batch. The Auth Only will remain in the Auth Only batch and multiple completions can be performed on the single Auth Only transaction until the total amount has been reached. Every completion will create a new fresh Sale.

error_outline

note

  • Transaction status will not change. A pended Auth Only will be converted to a pended Sale. Users have to login to the application in order to unpend a transaction. Transactions set to pend will not settle until they are set to unpend.
  • A completion request for an amount higher than the original Auth Only is not allowed.
  • Users must have the Batches-Edit Transactions user right in order to complete a transaction.

In this section:

Request

ssl_merchant_id
15 | numeric | required
Merchant ID
Elavon-assigned Converge account ID.
ssl_user_id
15 | alphanumeric | required
Converge User ID
The user ID with Hosted Payment API User status that can send transaction requests through the terminal.
ssl_pin
64 | alphanumeric | required
Terminal ID
Unique identifier of the terminal that will process the transaction request and submit to the Converge gateway.
Important: The ssl_user_id sending the transaction request must be associated with the terminal that will process the request.
ssl_transaction_type
20 | alphanumeric | required
Transaction Type
Value: cccomplete
ssl_txn_id
46 | alphanumeric | required
Transaction ID
Unique identifier of the approved Auth Only (ccauthonly) transaction to be placed into the open batch for settlement.
ssl_amount
11 | numeric | conditional
Transaction Amount
The full, partial, or multi-partial Auth Only amount to convert.
Completion Types:
  • Full - Blank/Null
  • Partial - Less than the original Auth Only amount
  • Multi-partial - Less than the original Auth Only amount
Format: Number with 2 decimals places
ssl_partial_shipment_flag
1 | alphanumeric | conditional
Partial Shipment Indicator
Indicates whether the integrated application supports partial shipment.
Valid values:
  • Y - Partial shipment supported
  • N - Partial shipment not supported (default)
Must be set to Y if performing a multi-partial completion.

Response

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/2010 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_amount
 
Completed Transaction Amount
 
ssl_card_number
 
Masked 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).
[Address Verification Service]
 
ssl_avs_response
 
Address Verification Response Code
Refer to the AVS Response Codes section for a complete list of AVS response codes.
[Card Verification]
 
ssl_cvv2_response
 
Card Verification Response Code
Refer to the CVV2/CVC2 Response Codes section for a complete list of CVV/CVC2 response codes.
[Invoice Number]
Returned based on merchant setup.
ssl_invoice_number
 
Invoice Number
The invoice number or ticket number sent in the original request.
[Dynamic Currency Conversion]
Returned only if the terminal is set up with the Dynamic Currency   credit card payment option.
Refer to the Dynamic Currency Conversion (DCC) section for more information on retrieving the following DCC transaction parameters.
ssl_conversion_rate
 
Conversion Rate
Exchange rate applied to the conversion of ssl_amount.
ssl_cardholder_amount
 
Cardholder Amount
Total amount in the cardholder's billing currency.
[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.

Auth Only Transaction Response

<txn>
    <ssl_result>0</ssl_result>
    <ssl_approval_code>N19032</ssl_approval_code>
    <ssl_result_message>APPROVAL</ssl_result_message>
    <ssl_txn_id>AA4843B-EEBFF0FE-0BDC-47A3-B4F6-5D752E2FBE42</ssl_txn_id>
    <ssl_txn_time>07/21/2013 05:27:42 PM</ssl_txn_time>
    <ssl_amount>3.00</ssl_amount>
    <ssl_salestax>0.01</ssl_salestax>
    <ssl_account_balance>0.00</ssl_account_balance>
    <ssl_card_number>00**********0000</ssl_card_number>
    <ssl_cvv2_response>M</ssl_cvv2_response>
    <ssl_avs_response>A</ssl_avs_response>
    <ssl_invoice_number>1234</ssl_invoice_number>
    <ssl_first_name>John</ssl_first_name>
    <ssl_last_name>Doe</ssl_last_name>
    <ssl_avs_address>123 Main</ssl_avs_address>
    <ssl_city>Atlanta</ssl_city>
    <ssl_avs_zip>30123</ssl_avs_zip>
    <ssl_state>GA</ssl_state>
    <ssl_country>USA</ssl_country>
    <ssl_dynamic_dba>123456789012*ABCCORP</ssl_dynamic_dba>
</txn>

Full Completion Transaction

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_description>Keyed Sale API</ssl_description>
    <ssl_transaction_type>cccomplete</ssl_transaction_type>
    <ssl_txn_id>AA4843B-EEBFF0FE-0BDC-47A3-B4F6-5D752E2FBE42</ssl_txn_id>
</txn>

Response

<txn>
    <ssl_result>0</ssl_result>
    <ssl_approval_code>N19032</ssl_approval_code>
    <ssl_result_message>APPROVAL</ssl_result_message>
    <ssl_txn_id>AA4843B-EEBFF0FE-0BDC-47A3-B4F6-5D752E2FBE42</ssl_txn_id>
    <ssl_txn_time>07/21/2013 05:19:38 PM</ssl_txn_time>
    <ssl_amount>3.00</ssl_amount>
    <ssl_salestax>0.01</ssl_salestax>
    <ssl_account_balance>0.00</ssl_account_balance>
    <ssl_card_number>00**********0000</ssl_card_number>
    <ssl_cvv2_response>M</ssl_cvv2_response>
    <ssl_avs_response>A</ssl_avs_response>
    <ssl_invoice_number>1234</ssl_invoice_number>
    <ssl_first_name>John</ssl_first_name>
    <ssl_last_name>Doe</ssl_last_name>
    <ssl_avs_address>123 Main</ssl_avs_address>
    <ssl_city>Atlanta</ssl_city>
    <ssl_avs_zip>30123</ssl_avs_zip>
    <ssl_state>GA</ssl_state>
    <ssl_country>USA</ssl_country>
    <ssl_dynamic_dba>123456789012*ABCCORP</ssl_dynamic_dba>
</txn>