|
Introduction to Authorize.Net Advanced Integration Method (AIM)
Krengel Authorize utilizes AIM from Authorize.Net - a customizable payment processing solution that gives the merchant control over all the steps in processing a transaction, including:
- Collection of customer payment information through a custom application
- Generation of a receipt to the customer
- Secure transmission to the payment gateway for transaction processing
- Secure storage of cardholder information
- And more, depending on the merchant's business requirements
The security of an AIM transaction is assured through a 128-bit Secure Sockets Layer (SSL) connection between the merchant's Web server and the Authorize.Net Payment Gateway.
AIM is an ideal integration solution because it allows merchants the highest degree of customization and control over their customers' checkout experience.
Features of AIM
In addition to basic transaction processing, AIM provides merchants with several features for configuring transaction security options and further customizing their customers' checkout experience. These features are listed in the AIM Feature Selection Guide provided below.
FEATURE |
DESCRIPTION |
REQUIREMENTS |
Address Verification Service (AVS) Filter |
This feature allows merchants to compare the billing address submitted by the customer for the transaction with the address on file at the card issuing bank. Filter settings in the Merchant Interface allow the merchant to reject transactions based on the AVS response received. |
To implement AVS, the merchant must require the Address and ZIP Code fields on their custom payment form. |
Card Code Verification (CCV) Filter |
This feature allows merchants to compare the card code submitted by the customer for the transaction with the card code on file at the card issuing bank. Filter settings in the Merchant Interface allow the merchant to reject transactions based on the CCV response received. |
To implement CCV, the merchant must require the Card Code on their custom payment form. |
Itemized Order Information |
This feature allows merchants to submit details for items purchased. This information is included in the merchant transaction confirmation email, in the Transaction Details for the transaction and in QuickBooks download reports in the Merchant Interface. |
To implement Itemized Order Information, the line item field must be submitted on a per-transaction basis. |
EmailReceipt |
This feature allows merchants to opt for an automatic email receipt to be sent by the payment gateway to their customers. |
To configure the payment gateway email receipt, the merchant must require the customer email address on their custom payment form, and settings must be configured in the Email Receipts section of the Settings menu in the Merchant Interface or submitted on a per-transaction basis. |
Submitting Transactions
The payment gateway supports several credit card transaction types for transactions submitted by AIM.
To implement AIM for a merchant's Web site or proprietary business application, you will need to develop an application that performs the following:
- Securely obtains all of the information required to process a transaction (including data requirements specified by the merchant).
- Initiates a secure SSL connection from the merchant's Web server to the payment gateway transaction post location to pass transaction data in name/value pairs.
- Receives and parses the transaction response from the payment gateway and displays the results to the customer.
Credit Card Transaction Types
This topic describes the credit card transaction types supported by the payment gateway and their specific field requirements. A Krengel Technology support technician will discuss with you how your business plans to submit transactions so that you can properly integrate your payment gateway account to support your business processes.
For example, are you submitting transactions mainly through an e-commerce Web site? Do you need to integrate a custom application to allow call center representatives to enter mail order/telephone order (MOTO) transactions? Would you like the ability to verify the availability of funds on a customer's credit card account at the time of purchase and then charge the credit card at the time they ship the order?
The payment gateway supports the following credit card transaction types.
Authorization and Capture
Authorization Only
Prior Authorization and Capture
Capture Only
Credit
Unlinked Credit
Void
Visa Verification Transactions
Authorization and Capture
This is the most common type of credit card transaction and is the default payment gateway transaction type. The amount is sent for authorization, and if approved, is automatically submitted for settlement.
The unique field requirement for an Authorization and Capture is:
x_type=AUTH_CAPTURE
Authorization Only
This transaction type is sent for authorization only. The transaction will not be sent for settlement until the credit card transaction type Prior Authorization and Capture (see definition below) is submitted, or the transaction is submitted for capture manually in the Merchant Interface. For more information about capturing Authorization Only transactions in the Merchant Interface, see the Merchant Integration Guide at http://www.authorize.net/support/merchant/.
If action for the Authorization Only transaction is not taken on the payment gateway within 30 days, the authorization expires and is no longer available for capture. A new Authorization Only transaction would then have to be submitted to obtain a new authorization code.
The unique field requirement for an Authorization Only is:
x_type=AUTH_ONLY
Merchants can submit Authorization Only transactions if they want to verify the availability of funds on the customer's credit card before finalizing the transaction. This transaction type can also be submitted in the event that the merchant does not currently have an item in stock or wants to review orders before shipping goods.
Prior Authorization and Capture
This transaction type is used to complete an Authorization Only transaction that was successfully authorized through the payment gateway.
Note: An Authorization Only and a Prior Authorization and Capture together are considered one complete transaction. Once the Prior Authorization and Capture is submitted, the transaction will be sent for settlement.
The payment gateway accepts this transaction type and initiates settlement if the following conditions are met:
- The original Authorization Only transaction was submitted within the previous 30 days (Authorization Only transactions expire on the payment gateway after 30 days).
- The transaction is submitted with the valid Transaction ID (x_trans_id) of an original, successfully authorized, Authorization Only transaction.
- The original transaction is not yet captured, expired or errored.
- The amount being requested for capture is less than or equal to the original authorized amount. Please note that only a single Prior Authorization and Capture transaction may be submitted against an Authorization Only.
The unique field requirements for a Prior Authorization and Capture are:
x_type=PRIOR_AUTH_CAPTURE
x_trans_id=Transaction ID here
For this transaction type, the amount field (x_amount) is only required in the event that a Prior Authorization and Capture is submitted for an amount that is less than the amount of the original Authorization Only transaction. If no amount is submitted, the payment gateway will initiate settlement for the amount of the original authorized transaction.
Capture Only
This transaction type is used to complete a previously authorized transaction that was not originally submitted through the payment gateway or that requires voice authorization.
A Capture Only transaction is most commonly submitted in the Merchant Interface to manually accept a transaction that was declined by the payment gateway due to Address Verification Service (AVS) and/or Card Code Verification (CCV) filtering
The payment gateway accepts this transaction type and initiates settlement if the following conditions are met:
- The transaction is submitted with the valid authorization code issued to the merchant to complete the transaction.
The unique field requirements for a Capture Only are:
x_type=CAPTURE_ONLY
x_auth_code=Authorization Code here
Credit
This transaction type is used to refund a customer for a transaction that was originally processed and successfully settled through the payment gateway.
The payment gateway accepts Credits if the following conditions are met:
- The transaction is submitted with the valid Transaction ID (x_trans_id) of an original, successfully settled transaction.
- The amount being requested for refund is less than or equal to the original settled amount.
- The sum amount of multiple Credit transactions submitted against the original transaction is less than or equal to the original settled amount.
- At least the last four digits of the credit card number (x_card_num) used for the original, successfully settled transaction are submitted. An expiration date is not required.
- The transaction is submitted within 120 days of the settlement date of the original transaction.
The unique field requirements for a Credit are:
x_type=CREDIT
x_trans_id=Transaction ID here
x_card_num=Full credit card number or last four digits only here
Unlinked Credit
This transaction type is used to issue a refund for a transaction that was not originally submitted through the payment gateway. It also allows the merchant to override restrictions for submitting refunds for payment gateway transactions, for example, if the merchant is beyond the 120-day period for submitting a refund or would like to refund an amount that is greater than the original transaction amount.
The ability to submit unlinked credits is not a standard feature of a merchant's payment gateway account. To be enabled for expanded credits capability (ECC), the merchant must submit an application.
IMPORTANT: A Transaction ID must not be submitted with an Unlinked Credit. If ECC is enabled for the merchant's account, and a Transaction ID is submitted with the Unlinked Credit transaction, then the payment gateway will attempt to apply the credit to an original transaction with the Transaction ID submitted.
The unique field requirement for an Unlinked Credit is:
x_type=CREDIT
Void
This transaction type is used to cancel an original transaction that is not yet settled and prevents it from being sent for settlement. A Void can be submitted against any other transaction type.
Note: If you are not sure whether a transaction is settled, you can attempt to submit a Void first. If the Void transaction errors, the original transaction is likely settled and you can submit a Credit for the transaction.
The payment gateway accepts Voids if the following conditions are met:
- The transaction is submitted with the valid Transaction ID (x_trans_id) of an original, successfully authorized transaction.
- The original transaction is not already settled, expired or errored.
The unique field requirements for a Void are:
x_type=VOID
x_trans_id=Transaction ID here
Note: Typically, Authorization Only or Authorization and Capture are the primary transaction types submitted by an e-commerce Web site or other application. Though they most likely will not be used for the merchant's Web site integration, all other transaction types listed above may be integrated for automatic submission into an internal or enterprise application, like those used in a call center, or they may also be submitted by the merchant manually via the Virtual Terminal in the Merchant Interface.
Visa Verification Transactions
The following are required for $0 Visa verification calls:
- The transaction type must be AUTH_ONLY. All other transaction types will be rejected.
- Bill To address (x_address) and zip code (x_zip) are required to perform the AVS check.
Not all processors accept $0 Dollar Amount
|