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.

In this section:

• Request
• Response
• Example

Request

Field name	Description	Required	Length	Data type
ssl_merchant_id	Merchant ID Elavon-assigned Converge account ID.	Required	15	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. error_outline important 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 completed.	Required	46	alphanumeric
ssl_amount	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	Required	11	numeric
[Card Data]	Use the appropriate card data parameters for the transaction.
ssl_card_present	Card Present Indicator Indicates whether the card is physically present during the transaction. Valid values: Y - Card present N - Card not present Recommended for hand-keyed transactions.	Optional	1	alphanumeric
ssl_ksn	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. error_outline important Required if using ssl_enc_track_data, ssl_encrypted_track1_data or ssl_encrypted_track2_data.	Conditional	20	alphanumeric
ssl_token	Credit Card Token Encrypted card data that can replace ssl_card_number. error_outline important The token must already be stored in Card Manager. + Use only if the terminal is set up with the Tokenization terminal option. * Required if ssl_merchant_initiated_unscheduled = Y.	Conditional	20	alphanumeric
ssl_pos_mode	POS Device Data Entry Capability Indicates how the POS device captures card data. Valid values: 01 - Manual entry only 02 - Magnetic swipe-capable 03 - Proximity or contactless-capable 04 - EMV chip-capable (ICC) - Contact only with magnetic stripe 05 - EMV chip-capable (ICC) - Dual interface with magnetic stripe	Optional	2	numeric
ssl_entry_mode	Transaction Entry Indicator Indicates how the track data was captured. Valid values: 01 - Key entered - Card not present 02 - Key entered - Card present 03 - Swiped (default) 04 - Proximity/Contactless	Optional	2	numeric
[Doing Business As]	Use only on terminals that are set up with the DBA Name terminal option.
ssl_dynamic_dba	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	Optional	21	alphanumeric
[Tokenization]	Use only on terminals that are set up with the Tokenization terminal option.
ssl_add_token	Add to Card Manager Indicator Indicates whether to generate and store the token in Card Manager. Valid values: Y - Authorize transaction, generate and store token N - Do not store token (Default)	Optional	1	alphanumeric
ssl_get_token	Generate Token Indicator Indicates whether to generate a token when submitting the card data. Valid values: Y - Authorize transaction and generate token N - Do not generate token (Default) If set to Y, the following parameters are mandatory: Hand-keyed - ssl_card_number - ssl_exp_date Swiped/Contactless - ssl_track_data Encrypted Swiped/Contactless - ssl_enc_track_data (Ingenico) - ssl_encrypted_track1_data (MagTek) - ssl_encrypted_track2_data (MagTek)	Optional	1	alphanumeric
[Card Verification]	Use only on terminals that are set up with the CVV2, CVC2, CID credit card payment option.
ssl_cvv2cvc2	Card Verification Value / Card Validation Code Card security code or number printed on the card and commonly used for card not present payment transactions.	Optional	4	numeric
ssl_cvv2cvc2_indicator	Card Verification Value / Card Validation Code Indicator Indicates the status of the card security code or number during the transaction. Valid values: 0 - Bypassed 1 - Present 2 - Illegible 9 - Not Present	Optional	1	numeric
[Purchasing Cards]	Use only on terminals that are set up with the Purchasing Card 2 credit card payment option.
ssl_customer_code	Customer Code or Purchase Order Number Customer ID or PO number specified in the billing statement of the cardholder.	Optional	17	alphanumeric
ssl_salestax	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.	Optional	8	alphanumeric
[Invoice Number]	Use only on terminals that are set up with the Invoice Number credit card payment option.
ssl_invoice_number	Invoice/Ticket Number Unique identifier of the invoice or ticket.	Optional	25	alphanumeric
[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	Transaction Currency The currency ISO code that the merchant applies to their goods or services. Default: USD or CAD	Optional	3	alphanumeric
[Travel Data]	Use only on terminals that are set up with the Travel Data credit card payment option.
ssl_departure_Date	Travel Departure Date Date sent to the Merchant Airline Risk Monitoring System (MARMS) to monitor risks associated with advanced booking. Format: MM/DD/YYYY	Optional	10	alphanumeric
ssl_completion_Date	Travel Completion Date Date sent to the Merchant Airline Risk Monitoring System (MARMS) to monitor risks associated with advanced booking. Format: MM/DD/YYYY	Optional	10	alphanumeric
[Card on File]
ssl_merchant_initiated_unscheduled	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: Y - Yes N - No	Optional	1	alphanumeric
ssl_oar_data	Original Authorization Response Data Include this parameter for all future Card On File transactions using Token or Card Number.	Required	60	alphanumeric
ssl_ps2000_data	PS2000 Data Include this parameter for all future Card On File transactions using Token or Card Number.	Required	22	alphanumeric
[Level 3]	Use only on terminals that are set up with the Level 3 terminal option.
ssl_level3_indicator	Level 3 Indicator Valid values: Y - Level 3 transaction (send Level 3 data to issuer) N - Only save data locally (do not send Level 3 data to issuer)	Required	1	alphanumeric
ssl_ship_to_zip	ZIP Code ZIP or postal code of the destination address.	Optional	9	alphanumeric
ssl_ship_to_country	Country Code Country ISO code of the destination address.	Optional	3	alphanumeric
ssl_shipping_amount	Freight or Shipping Amount	Optional	11	numeric
ssl_ship_from_postal_code	ZIP Code ZIP or postal code of the originating address.	Optional	9	alphanumeric
ssl_discount_amount	Discount Amount The discount amount for the entire transaction (order).	Optional	11	numeric
ssl_duty_amount	Duty Amount The total charges for any import or export duties included in the transaction.	Optional	11	numeric
ssl_national_tax_indicator	National Tax Indicator Valid values: Visa 0 - Tax not included in total purchase amount 1 - Tax included in total purchase amount MasterCard Y - Tax included in total purchase amount N - Transaction not subject to tax 0 or Space - Tax information unknown	Optional	1	alphanumeric
ssl_national_tax_amount	National or VAT Amount	Optional	11	numeric
ssl_order_date	Order Date Date when the merchant received the order. Format: YYMMDD	Optional	6	numeric
ssl_other_tax	Other Tax Amount	Optional	12	numeric
ssl_summary_commodity_code	Summary Commodity Code Indicates whether Level 3 data is in the line item detail.	Optional	4	alphanumeric
ssl_merchant_vat_number	Merchant VAT Number The identification number assigned by the taxing authority to the merchant.	Optional	20	alphanumeric
ssl_customer_vat_number	Customer VAT Number The identification number assigned by the VAT authority to the buying company.	Optional	13	alphanumeric
ssl_freight_tax_amount	VAT or Tax Amount VAT or tax applied to the freight or shipping amount.	Optional	12	numeric
ssl_vat_invoice_number	VAT Invoice Number	Optional	15	alphanumeric
ssl_tracking_number	Shipping Tracking Number	Optional	25	alphanumeric
ssl_shipping_company	Shipping Company Name	Optional	50	alphanumeric
ssl_other_fees	Other Fees	Optional	12	numeric
ssl_line_item_description	Line Item Description	Optional	35	alphanumeric
ssl_line_Item_product_code	Line Item Product Code The part or catalog number of the line item.	Optional	13	alphanumeric
ssl_line_Item_commodity_code	Line Item Commodity Code The commodity code used to classify the line item.	Optional	12	alphanumeric
ssl_line_Item_quantity	Line Item Quantity The number of purchased units for the line item.	Optional	12	numeric
ssl_line_Item_unit_of_measure	Line Item Measurement Code The unit of measure that each line item is purchased in.	Optional	3	alphanumeric
ssl_line_Item_unit_cost	Line Item Unit Cost The cost of each purchased unit for the line item.	Optional	12	numeric
ssl_line_Item_discount_indicator	Line Item Discount Indicator Indicates whether the line item is discounted. Valid values: Y - Item amount is discounted N - Item amount is not discounted	Optional	1	alphanumeric
ssl_line_Item_tax_indicator	Line Item Tax Indicator Indicates whether the line item is taxable. Valid values: Y - Item amount is taxable N - Item amount is not taxable	Optional	1	alphanumeric
ssl_line_item_discount_amount	Discount Amount The discount amount for the entire line item.	Optional	11	numeric
ssl_line_Item_tax_rate	Line Item Tax Rate	Optional	4	numeric
ssl_line_Item_tax_amount	Line Item Tax Amount The tax amount for each purchased unit.	Optional	12	numeric
ssl_line_Item_tax_type	Line Item Tax Type The type of tax applied to the line item.	Optional	4	alphanumeric
ssl_line_Item_extended_total	Line Item Extended Amount The total cost of the line item for the detail record. Computation Rule: Quantity x Unit Price	Optional	9	numeric
ssl_line_Item_total	Line Item Total Amount	Optional	12	numeric
ssl_line_Item_alternative_tax	Alternate Tax ID The alternate tax identifier description for the line item.	Optional	12	numeric
[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	eCommerce Indicator Valid values: 5 - Fully authenticated (if eci = 02 or 05) 6 - Attempted VbV (if eci = 01 or 06) 7 - Non-VbV (if eci = 07 or )	Required	1	numeric
ssl_3dsecure_value	Cardholder Authentication Verification (CAVV) (Visa) Universal Cardholder Authentication Field (UCAF) (MasterCard) Validates the integrity of the Verified by Visa (VbV) transaction data.	Required	80	Base64 Encoded
ssl_xid	eMPI Transaction ID Unique transaction identifier generated by the Elavon Merchant Plug In (eMPI) engine.	Optional	20	alphanumeric
[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	Wallet Identifier Indicates the wallet payment type offered by the merchant. Valid value: MasterPass	Required	10	alphanumeric
ssl_eWallet_shipping	Shipping Information Indicator Indicates the shipping information to use for the wallet purchase. Valid values: Y - Use MasterPass shipping information N - Use shipping information from merchant's website or payment form	Optional	1	alphanumeric
ssl_product_string	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	Optional	200	alphanumeric
ssl_callback_url	Callback URL The URL of the merchant that will host the response.	Required	200	alphanumeric
[Optional Fields]
ssl_avs_address	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.	Optional	30	alphanumeric
ssl_avs_zip	Postal or ZIP Code ZIP code on the cardholder's account or billing address. (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.	Optional	9	alphanumeric
ssl_description	Merchant-defined Transaction Description Short and custom text to describe the transaction.	Optional	255	alphanumeric
ssl_partial_auth_indicator	Partial Authorization Indicator Indicates whether the integrated application supports partial authorization or approval. Valid values: 0 - Partial authorization not supported (Default) 1 - Partial authorization supported	Optional	1	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 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

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>

• previous Auth Only - ccauthonly
• next Verification - ccverify