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:
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: ccauthonly |
ssl_txn_id 46 | alphanumeric | required | Transaction ID Unique identifier of the Auth Only ( ccauthonly ) transaction to be completed. |
ssl_amount 11 | numeric | required | Transaction Amount The authorization amount that includes the Net and Sales Tax amounts. 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 |
[Card Data] | Use the appropriate card data parameters for the transaction. |
ssl_card_present 1 | alphanumeric | optional | Card Present Indicator Indicates whether the card is physically present during the transaction. Valid values:
|
ssl_ksn 20 | alphanumeric | conditional | Key Serial Number Unique identifier generated from the swiped payment card and returned by the encrypting device. The KSN encrypts the PAN data through the DUKPT method. Important: Required if using ssl_enc_track_data , ssl_encrypted_track1_data or ssl_encrypted_track2_data . |
ssl_token 20 | alphanumeric | conditional | Credit Card Token Encrypted card data that can replace ssl_card_number . Important:
|
ssl_pos_mode 2 | numeric | optional | POS Device Data Entry Capability Indicates how the POS device captures card data. Valid values:
|
ssl_entry_mode 2 | numeric | optional | Transaction Entry Indicator Indicates how the track data was captured. Valid values:
|
[Doing Business As] | Use only on terminals that are set up with the DBA Name terminal option. |
ssl_dynamic_dba 21 | alphanumeric | optional | Doing Business As Name Merchant-defined descriptors that replace the merchant's business name on credit card statements. Format: Prefix*Descriptor Length: Prefix = 3, 7, or 12, Asterisk = 1, Descriptor = 21 - (Prefix + Asterisk) Example: MANYMAG*BAKERS MONTHLY |
[Tokenization] | Use only on terminals that are set up with the Tokenization terminal option. |
ssl_add_token 1 | alphanumeric | optional | Add to Card Manager Indicator Indicates whether to generate and store the token in Card Manager. Valid values:
|
ssl_get_token 1 | alphanumeric | optional | Generate Token Indicator Indicates whether to generate a token when submitting the card data. Valid values:
|
[Card Verification] | Use only on terminals that are set up with the CVV2, CVC2, CID credit card payment option. |
ssl_cvv2cvc2 4 | numeric | optional | Card Verification Value / Card Validation Code Card security code or number printed on the card and commonly used for card not present payment transactions. |
ssl_cvv2cvc2_indicator 1 | numeric | optional | Card Verification Value / Card Validation Code Indicator Indicates the status of the card security code or number during the transaction. Valid values:
|
[Purchasing Cards] | Use only on terminals that are set up with the Purchasing Card 2 credit card payment option. |
ssl_customer_code 17 | alphanumeric | optional | Customer Code or Purchase Order Number Customer ID or PO number specified in the billing statement of the cardholder. |
ssl_salestax 8 | alphanumeric | optional | Sales Tax Tax amount to add to the purchase or sales amount. For a tax exempt transaction, enter 0.00. Format: Amount with 2 decimal places. |
[Invoice Number] | Use only on terminals that are set up with the Invoice Number credit card payment option. |
ssl_invoice_number 25 | alphanumeric | optional | Invoice/Ticket Number Unique identifier of the invoice or ticket. |
[Multi-Currency Conversion] | Use only on terminals that are set up with the Multi Currency credit card payment option. Refer to the Multi-Currency Conversion (MCC) section for more information on processing MCC transactions. |
ssl_transaction_currency 3 | alphanumeric | optional | Transaction Currency The currency ISO code that the merchant applies to their goods or services. Default: USD or CAD |
[Travel Data] | Use only on terminals that are set up with the Travel Data credit card payment option. |
ssl_departure_Date 10 | alphanumeric | optional | Travel Departure Date Date sent to the Merchant Airline Risk Monitoring System (MARMS) to monitor risks associated with advanced booking. Format: MM/DD/YYYY |
ssl_completion_Date 10 | alphanumeric | optional | Travel Completion Date Date sent to the Merchant Airline Risk Monitoring System (MARMS) to monitor risks associated with advanced booking. Format: MM/DD/YYYY |
[Card On File] | |
ssl_merchant_initiated_unscheduled 1 | alphanumeric | optional | Merchant Initiated Unscheduled Transaction Indicator Indicates the transaction was initiated by a merchant using a stored credential (token or stored card number) for a fixed or variable amount that does not occur on a scheduled or regularly occurring transaction date. Valid values:
|
ssl_oar_data 60 | alphanumeric | required | Original Authorization Response Include this parameter for all future Card On File transactions using Token or Card Number. |
ssl_ps2000_data 22 | alphanumeric | required | PS2000 Data Include this parameter for all future Card On File transactions using Token or Card Number. |
[Level 3] | Use only on terminals that are set up with the Level 3 terminal option. |
ssl_level3_indicator 1 | alphanumeric | required | Level 3 Indicator Valid values:
|
ssl_ship_to_zip 9 | alphanumeric | optional | ZIP Code ZIP or postal code of the destination address. |
ssl_ship_to_country 3 | alphanumeric | optional | Country Code Country ISO code of the destination address. |
ssl_shipping_amount 11 | numeric | optional | Freight or Shipping Amount |
ssl_ship_from_postal_code 9 | alphanumeric | optional | ZIP Code ZIP or postal code of the originating address. |
ssl_discount_amount 11 | numeric | optional | Discount Amount The discount amount for the entire transaction (order). |
ssl_duty_amount 11 | numeric | optional | Duty Amount The total charges for any import or export duties included in the transaction. |
ssl_national_tax_indicator 1 | alphanumeric | optional | National Tax Indicator Visa
|
ssl_national_tax_amount 11 | numeric | optional | National or VAT Amount |
ssl_order_date 6 | numeric | optional | Order Date Date when the merchant received the order. Format: YYMMDD |
ssl_other_tax - | - | optional | Other Tax Amount |
ssl_summary_commodity_code - | - | optional | Summary Commodity Code Indicates whether Level 3 data is in the line item detail. |
ssl_merchant_vat_number - | - | optional | Merchant VAT Number The identification number assigned by the taxing authority to the merchant. |
ssl_customer_vat_number - | - | optional | Customer VAT Number The identification number assigned by the VAT authority to the buying company.. |
ssl_freight_tax_amount - | - | optional | VAT or Tax Amount VAT or tax applied to the freight or shipping amount. |
ssl_vat_invoice_number - | - | optional | VAT Invoice Number |
ssl_tracking_number - | - | optional | Shipping Tracking Number |
ssl_shipping_company - | - | optional | Shipping Company Name |
ssl_other_fees - | - | optional | Other Fees |
ssl_line_item_description 25 | alphanumeric | optional | Line Item Description |
ssl_line_Item_product_code - | - | optional | Line Item Product Code The part or catalog number of the line item. |
ssl_line_Item_commodity_code - | - | optional | Line Item Commodity Code The commodity code used to classify the line item. |
ssl_line_Item_quantity - | - | optional | Line Item Quantity The number of purchased units for the line item. |
ssl_line_Item_unit_of_measure - | - | optional | Line Item Measurement Code The unit of measure that each line item is purchased in. |
ssl_line_Item_unit_cost - | - | optional | Line Item Unit Cost The cost of each purchased unit for the line item. |
ssl_line_Item_discount_indicator 1 | alphanumeric | optional | Line Item Discount Indicatot Indicates whether the line item is discounted.
|
ssl_line_Item_tax_indicator 1 | alphanumeric | optional | Line Item Tax Indicator Indicates whether the line item is taxable.
|
ssl_line_Item_tax_rate - | - | optional | Line Item Tax Rate |
ssl_line_Item_tax_amount - | - | optional | Line Item Tax Amount The tax amount for each purchased unit. |
ssl_line_Item_tax_type - | - | optional | Line Item Tax Type The type of tax applied to the line item. |
ssl_line_Item_extended_total - | - | optional | Line Item Extended Amount The total cost of the line item for the detail record. Computation Rule: Quantity x Unit Price |
ssl_line_Item_total - | - | optional | Line Item Total Amount |
ssl_line_Item_alternative_tax - | - | optional | Alternate Tax ID The alternate tax identifier description for the line item. |
[3D Secure] | Use only on terminals that are set up with eMPI Merchant Numbers. Refer to the 3D Secure section for more information on retrieving the following Issuer Authentication parameters. |
ssl_eci_ind 1 | numeric | required | eCommerce Indicator Valid values:
|
ssl_3dsecure_value 80 | Base64 Encoded | required | Cardholder Authentication Verification (CAVV) (Visa) Universal Cardholder Authentication Field (UCAF) (MasterCard) Validates the integrity of the Verified by Visa (VbV) transaction data. |
ssl_xid 20 | alphanumeric | optional | eMPI Transaction ID Unique transaction identifier generated by the Elavon Merchant Plug In (eMPI) engine. |
[MasterPass] | Use only on terminals that are set up with the MasterPass processing option, Market Segment set to Internet, and Region set to Canada. Refer to the MasterPass section for more information on processing MasterPass wallet transactions. |
ssl_eWallet 10 | alphanumeric | required | Wallet Identifier Indicates the wallet payment type offered by the merchant. Valid value: MasterPass |
ssl_eWallet_shipping 1 | alphanumeric | optional | Shipping Information Indicator Indicates the shipping information to use for the wallet purchase. Valid values:
|
ssl_product_string 200 | alphanumeric | optional | Product String List of products purchased from the merchant website. All the products appear as Line Items on the MasterPass website along with the total amount. Format: Unit Price::Quantity::Description::Image URL Multi-Product Format: Unit Price::Quantity::Description::Image URL | Unit Price::Quantity::Description::Image URL |
ssl_callback_url - | alphanumeric | - | Callback URL TBD |
[Optional Fields] | |
ssl_avs_address 30 | alphanumeric | optional | Address Line 1 Commonly the house number and street name on the cardholder's / customer's account or billing address. Address Verification Service (AVS) data compared with the address on the card issuer's file. Recommended for hand-keyed transactions to qualify for better interchange rates. |
ssl_avs_zip 9 | alphanumeric | optional | Postal or ZIP Code ZIP code on the cardholder's account or billing address. Address Verification Service (AVS) data compared with the postal or ZIP code on the card issuer's file. Recommended for hand-keyed transactions to qualify for better interchange rates. |
ssl_description 255 | alphanumeric | optional | Merchant-defined Transaction Description Short and custom text to describe the transaction. |
ssl_partial_auth_indicator 1 | numeric | optional | Partial Authorization Indicator Indicates whether the integrated application supports partial authorization or approval. Valid values:
|
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 | Total Authorized/Approved Transaction Amount Returned based on merchant setup. |
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 are AMEX , CUP , DISC , MC , PP , and VISA . |
ssl_card_type | Payment Type Valid value: CREDITCARD Valid values are |
[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 generted 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 are Card Added , Card Updated , Not Permitted , and FAILURE - First Name - is requried . |
[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 | OAR 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. |
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
<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>Authorization for 3.00</ssl_description>
<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>
<ssl_salestax>0.01</ssl_salestax>
<ssl_cvv2cvc_indicator>1</ssl_cvv2cvc_indicator>
<ssl_cvv2cvc2>123</ssl_cvv2cvc2>
<ssl_customer_code>CORP</ssl_customer_code>
<ssl_invoice_number>1234</ssl_invoice_number>
<ssl_first_name>John</ssl_first_name>
<ssl_last_name>Doe</ssl_last_name>
<ssl_avs_address>2 Concourse Parkway</ssl_avs_address>
<ssl_city>Atlanta</ssl_city>
<ssl_state>GA</ssl_state>
<ssl_avs_zip>30328</ssl_avs_zip>
<ssl_country>USA</ssl_country>
<ssl_phone>9999999999</ssl_phone>
<ssl_ship_to_state>GS</ssl_ship_to_state>
<ssl_ship_to_zip>30328</ssl_ship_to_zip>
<ssl_ship_to_address1>2 Concourse Parkway</ssl_ship_to_address1>
<ssl_ship_to_last_name>Doe</ssl_ship_to_last_name>
<ssl_ship_to_city>Atlanta</ssl_ship_to_city>
<ssl_ship_to_first_name>John</ssl_ship_to_first_name>
</txn>
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/2014 05:14:49 PM</ssl_txn_time>
<ssl_avs_response>Z</ssl_avs_response>
</txn>