Auth Only Increment - ccauthonly
The Auth Only Increment transaction lets merchants check if a customer has the necessary funds for additional charges tied to an existing Auth Only transaction - this extends an existing auth only and avoids the difficulty of managing two independent Auth Only transactions.
error_outline
note
Auth Only Increment does not work with Dynamic Currency Conversion.
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: ccauthonly | Required | 20 | alphanumeric |
ssl_txn_id | Transaction ID Unique identifier of the Auth Only ( ccauthonly) transaction to be incremented. | Required | 46 | alphanumeric |
ssl_amount | Transaction Amount The authorization amount that will be used to increment the original Auth Only transaction For terminals that are set up with the Multi Currency credit payment option, make sure that the number of decimal places are correct as some currencies have 0 (like JPY) or 3 (like BHD) decimal places. Format: Number with 2 decimals places | Required | 11 | numeric |
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/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 | Total Authorized/Approved Transaction Amount The amount includes the Tip amount, if submitted in the request. |
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). |
ssl_card_short_description | Short Card Brand Name Valid values: AMEX, CUP, DISC, MC, PP, VISA |
ssl_card_type | Payment Type Valid value: CREDITCARD |
| [Tokenization] | Returned only if Tokenization parameters are sent in the request. |
ssl_token | Token Generated from the credit card number. |
ssl_token_response | Token Generation Outcome A value of SUCCESS indicates Converge generated the token. Other values returned are FAILURE, Action Not Permitted, Invalid Token, Not Permitted, and Acct Verification Failed. |
ssl_add_token_response | Add to Card Manager Outcome Valid values: Card Added, Card Updated, Not Permitted, FAILURE - First Name - is required |
| [Address Verification Service] | Returned only if AVS parameters are sent in the request. |
ssl_avs_response | Address Verification Response Code Refer to the AVS Response Codes section for a complete list of AVS response codes. |
| [Card Verification] | Returned only if CVV / CVC / CID parameters are sent in the request. |
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 only if Invoice Number parameters are sent in the request. |
ssl_invoice_number | Invoice Number The invoice number or ticket number sent in the original request. |
| [Multi-Currency Conversion] | Returned only if MCC parameters are sent in the request. |
ssl_transaction_currency | Transaction Currency |
| [Partial Approval] | Returned only if Partial Approval parameters are sent in the request. If the customer indicates that they do not wish to continue with the additional tender type, the point of sale application must send a reversal to cancel this payment and reestablish the balance back to the card. A reversal can be achieved by sending a ccdelete in terminal-based terminals or ccvoid in host-based terminals. |
ssl_requested_amount | Requested Amount Original requested amount on partial approvals. |
ssl_balance_due | Remaining Balance The difference between the requested amount and the authorized amount, which the merchant will collect from the customer. |
ssl_account_balance | Account Balance Available balance on the card, which is 0.00 for a partially authorized transaction. |
| [Card On File] | |
ssl_oar_data | Original Authorization Response Data This data will be as received during the original authorization processing. This is a retain and return value for terminal-based settlement messages. You may store this field with the payment details from the transaction to make future Card On File transactions. |
ssl_ps2000_data | PS2000 This data will be as received during the original authorization processing. This is a retain and return value for terminal-based settlement messages. You must store this field with the payment details from the transaction to make future Card On File transactions. |
| [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_transaction_type>ccauthonly</ssl_transaction_type>
<ssl_txn_id>AA4843A-1416AF5F-9A4C-4C10-AA00-537ADF2B3E0E</ssl_txn_id>
<ssl_amount>3.00</ssl_amount>
</txn>
The increment will be added to the original auth only amount. If you do a pre auth for $1.00 and then increment ssl_amount = $3.00. Now, the new auth only total amount will be $4.00.
Response
<txn>
<ssl_approval_code>CMC720</ssl_approval_code>
<ssl_cvv2_response>M</ssl_cvv2_response>
<ssl_last_name>Doe</ssl_last_name>
<ssl_avs_zip>30328</ssl_avs_zip>
<ssl_account_balance>3.00</ssl_account_balance>
<ssl_company/>
<ssl_result_message>APPROVAL</ssl_result_message>
<ssl_country>USA</ssl_country>
<ssl_city>Atlanta</ssl_city>
<ssl_phone>9999999999</ssl_phone>
<ssl_avs_address>2 Concourse Parkway</ssl_avs_address>
<ssl_invoice_number>1234</ssl_invoice_number>
<ssl_address2/>
<ssl_first_name>John</ssl_first_name>
<ssl_amount>3.00</ssl_amount>
<ssl_state>GA</ssl_state>
<ssl_txn_id>101641221593ACBA6-BAFD-76B7-4948- B3DE68CFD0CC</ssl_txn_id>
<ssl_result>0</ssl_result>
<ssl_card_number>00********0000</ssl_card_number>
<ssl_txn_time>01/28/2022 05:14:49 PM</ssl_txn_time>
<ssl_avs_response>Z</ssl_avs_response>
</txn>