AIM Guide

Title Page
Advanced Integration Method (AIM)

Card-Not-Present Transactions
Developer Guide
December 2015
Authorize.Net Developer Support

http://developer.authorize.net
Authorize.Net LLC 082007 Ver.2.0
Authorize.Net LLC (“Authorize.Net”) has made efforts to ensure the accuracy and completeness of the
information in this document. However, Authorize.Net disclaims all representations, warranties and conditions,
whether express or implied, arising by statute, operation of law, usage of trade, course of dealing or otherwise,
with respect to the information contained herein. Authorize.Net assumes no liability to any party for any loss or
damage, whether direct, indirect, incidental, consequential, special or exemplary, with respect to (a) the
information; and/or (b) the evaluation, application or use of any product or service described herein.
Authorize.Net disclaims any and all representation that its products or services infringe upon any existing or
future intellectual property rights. Authorize.Net owns and retains all right, title and interest in and to the
Authorize.Net intellectual property, including without limitation, its patents, marks, copyrights and technology
associated with the Authorize.Net services. No title or ownership of any of the foregoing is granted or otherwise
transferred hereunder. Authorize.Net reserves the right to make changes to any information herein without
further notice.
Authorize.Net Trademarks:
Advanced Fraud Detection Suite™
Authorize.Net®
Authorize.Net Your Gateway to IP Transactions™
Authorize.Net Verified Merchant Seal™
Automated Recurring Billing™
eCheck.Net®
2
CONTENTS
Contents
Recent Revisions to This Document 6
About This Guide 7

Audience and Purpose 7
Conventions 7
Note, Important, and Warning Statements 7
Text and Command ConventionsDeveloper Support 8
Chapter 1 Introduction 9
AIM Minimum Requirements 9
Payment Card Industry (PCI) Data Security Standard 10
Managing Integration Settings 10
Features of AIM 11
eCheck.Net 12
PayPal Express Checkout 13
Payment Processors 13
North American Payment Processors 13
European Payment Processors 15
Asia-Pacific Processors 15
EVOSnap 16
Accepted Authorization/Settlement Currencies 16
Accepted Billing Currencies 16
Accepted Card Types 16
EVOSnap Supported Services 17
Software Development Kits 20
Chapter 2 Submitting Transactions 21

Minimum Field Requirements 22
Market Type Requirements 24
E-commerce 24
MOTO (Mail Order/Telephone Order) 24
AIM Developer Guide | December 2015 3

Contents
Retail 25
Credit Card Transaction Types 25
Authorization and Capture 26
Authorization Only 26
Prior Authorization and Capture 27
Capture Only 27
Credit (Refund) 28
Unlinked Credit 28
Void 29
Visa Verification Transactions 30
Partial Authorization Transactions 30
Using the Merchant Interface 32
Chapter 3 Transaction Data Requirements 33

Transaction Post Location 33
AIM Transaction Submission API 34
Merchant Information 34
Transaction Information 35
Order Information 38
Itemized Order Information 39
Customer Information 40
Shipping Information 42
Additional Shipping Information (Level 2 Data) 43
x_tax 44
x_freight 44
x_duty 44
x_tax_exempt 45
x_po_num 45
Cardholder Authentication 45
Merchant-Defined Fields 47
Chapter 4 Transaction Response 49

Fields in the Payment Gateway Response 51
Response for Duplicate Transactions 56
AIM Transaction Response Types 57
Version 3.0 57
Version 3.1 57
Configuring the Transaction Version 58
Response Code Details 58
Email Receipt 72

Contents
Chapter 5 Test Transactions 74

Testing to Generate Specific Transaction Results 75
Appendix A Fields by Transaction Type 77

Minimum Required Fields 77
Required Fields for Additional AIM Features 78
Best Practice Fields 79
Appendix B API Fields 80

REVISIONS
Recent Revisions to This
Document
Date Revision
December 2015 This revision contains only editorial changes and no technical updates.
October 2015 Added a note about TLS to "AIM Minimum Requirements," page 9.
August 2015 Updated EVOSnap information in "Payment Processors," page 13.
July 2015 Added a section on EVOSnap to "Payment Processors," page 13.
Added a new transaction POST location to "Transaction Post Location,"
page 33.
April 2015 Added CAD to FDMS in "North American Payment Processors," page 13.
Changed authentication indicator 1 to optional for MasterCard SecureCode
in "Valid Value Combinations for MasterCard SecureCode Fields," page 47.
Removed a note stating that the processor EVO does not support partial
authorizations. EVO now supports partial authorizations.

ABOUT GUIDE
About This Guide
Audience and Purpose

This guide is for developers who integrate payment systems with the Authorize.Net
Payment Gateway using the Advanced Integration Method (AIM) API.
Conventions
Note, Important, and Warning Statements
A Note contains helpful suggestions or references to material not contained in

the document.
Note
An Important statement contains information essential to successfully

completing a task or learning a concept.
Important

About This Guide
Text and Command ConventionsDeveloper

Convention Usage
bold  Field and service names in text; for example:
Include the x_market_type field.
 Items that you are instructed to act upon; for example:
Click Save.
italic  Filenames and pathnames. For example:
Add the filter definition and mapping to your web.xml file.
 Placeholder variables for which you supply particular values.
monospace  XML elements.
 Code examples and samples.
 Text that you enter in an API environment; for example:
Set the davService_run field to true.
Support
The following resources can help you successfully integrate a merchant web site or other
application to the Authorize.Net Payment Gateway.
 The Developer Center provides sandbox accounts, sample code, FAQs, and
troubleshooting tools.
 Developer training videos cover a variety of topics.
 The developer community provides answers to questions from other Authorize.Net
developers.
 Ask us a question at our Developer Support page.
 Search our knowledge base for answers to commonly asked questions.
To submit suggestions for improving or correcting this guide, send email to

documentation@authorize.net.

CHAPTER
Introduction
1
AIM is a payment processing solution you can customize to give a merchant control over
all of the steps in processing a transaction:
 Collecting customer payment information through a custom application
 Generating a receipt to the customer
 Securely transmitting data to the payment gateway for transaction processing
 Securely storing cardholder information
 And more, depending on the merchant’s business requirements
For merchants who prefer a payment solution that collects, transmits, and
stores cardholder data, Authorize.Net recommends the Server Integration
Note Method (SIM). For more information, see the Server Integration Method (SIM)
Developer Guide.
SIM does not require merchants to purchase and install an SSL/TLS digital
certificate, which reduces the complexity of securely handling and storing
cardholder information, simplifying compliance with the Payment Card
Industry (PCI) Data Security Standard.
AIM Minimum Requirements

Before you begin, consult with the merchant to ensure that the following AIM requirements
are met. We strongly recommend that you work closely with merchants to ensure that any
other business and web site requirements are considered in their AIM integrations; for
example, bank or processor requirements and web site design preferences.
 The merchant must have a merchant bank account that allows Internet transactions.
 The merchant’s web site must have server-side scripting or CGI capabilities such as
ASP Classic, C#, Cold Fusion, Java, Perl, PHP, or VB.Net.
 The merchant must be able to securely store payment gateway account data, such as
their API Login ID or Transaction Key.
 The merchant must have a valid SSL or TLS certificate and their web site must be
capable of initiating both client- and server-side connections.

Chapter 1 Introduction
After June 30th 2016, the PCI Security Standards Council will require that all
merchants use TLS certificate version 1.1 or later. Authorize.Net recommends
Note as a best practice that you use the latest available version of TLS, and that you
upgrade your solution as soon as possible. For more information, see:
https://www.pcisecuritystandards.org/documents/Migrating_from_SSL_
Early_TLS_Information%20Supplement_v1.pdf
Payment Card Industry (PCI) Data

Security Standard
Using AIM involves transmitting sensitive cardholder data using the merchant’s
web server. Therefore, if the merchant stores cardholder information, it must be
Important stored securely and in accordance with the Payment Card Industry (PCI) Data
Security Standard. For more information about PCI and other industry standard
processing practices, see the Standards, Compliance, and Security training
video.
Merchants who need a solution that collects, transmits, and stores cardholder
data should use the Server Implementation Method (SIM). For more
Note information about SIM, see the Server Integration Method (SIM) Developer
Guide.
Managing Integration Settings

When integrating to the payment gateway, be aware that most settings for a merchant’s
integration can be configured and managed in one of two ways:
 Included in each transaction request using the application programming interface

(API), as described in this guide.

 Configured in the Merchant Interface and applied to all transactions.
The Authorize.Net Merchant Interface is a secure web site on which merchants

can manage their payment gateway account settings, including their web site
Note integration settings. Review the Merchant Integration Guide for information on
managing the merchant’s payment gateway integration using the Merchant
Interface.
Transaction settings that are submitted in a transaction request override transaction

settings that are configured in the Merchant Interface. However, some integration settings
must be that are configured in the Merchant Interface. To help maintain a robust
integration, review with the merchant the integration settings that can be configured in the
Merchant Interface and the settings that can be posted per transaction. See Appendix A,
"Fields by Transaction Type," on page 77 for a list of fields that can be submitted per
transaction.
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 table below. Discuss these features
with your merchant and select the appropriate features for their integration.
Table 1 Features of AIM
Features Description Requirements

Address Verification Service Enables merchants to compare the To implement AVS, the merchant must
(AVS) Filter billing address submitted by the require the Address and ZIP Code fields
customer for the transaction with the on their custom payment form.
address on file at the card issuing
For more information about AVS, see
bank. Filter settings in the Merchant
the Merchant Integration Guide.
Interface enable the merchant to
reject transactions based on the
AVS response received.
Card Code Verification (CCV) Enables merchants to compare the To implement CCV, the merchant must
Filter card code submitted by the require the card code on their custom
customer for the transaction with the payment form.
card code on file at the card-issuing
For more information about CCV, see
bank. Filter settings in the Merchant
the Merchant Integration Guide.
Interface enable the merchant to
reject transactions based on the
CCV response received.

Table 1 Features of AIM (Continued)
Features Description Requirements

Itemized Order Information Enables merchants to submit details To implement Itemized Order
for items purchased. This Information, the line item field must be
information is included in the submitted for each transaction.
customer’s confirmation email, in
See "Itemized Order Information,"
the Transaction Details for the
page 39, for details.
transaction, and in QuickBooks
download reports in the Merchant
Interface.
Email Receipt Enables merchants to have the To configure the payment gateway
payment gateway send an email receipt, merchants must require
automatic email receipt to their the customer email addresses on their
customers. custom payment form. Merchants must
navigate to Merchant Interface > Setting
> Email Receipts to configure settings,
or they must be submit them for each
transaction.
See "Email Receipt," page 72, for
details.
eCheck.Net
In addition to processing credit card transactions, the payment gateway also supports
electronic check transactions with our eCheck.Net product. Contact the merchant to
determine whether eCheck.Net is enabled for their payment gateway account, and if it is
not, whether they would like to have it enabled. If eCheck.Net is enabled, you must ensure
that the merchant’s web site integration supports all eCheck.Net field requirements. See
the eCheck.Net Developer Guide for more information.

PayPal Express Checkout

You can use AIM or AIM XML to implement PayPal Express Checkout as an alternative
payment method. See PayPal Express Checkout Services Using AIM or PayPal Express
Checkout Services Using AIM XML.
Payment Processors
The merchant’s payment processor determines the card types and currencies that the
merchant can support.
North American Payment Processors

Authorize.Net supports the following payment processors, card types, and currencies.
Table 2 North American Payment Processors, Accepted Card Types,

and Accepted Currencies
Payment Processor Accepted Card Types Accepted Currencies

Chase Paymentech Tampa  American Express United States Dollar (USD)
 Diners Club Canadian Dollar (CAD)
 Discover
 JCB
 Mastercard
 Visa
Elavon  American Express United States Dollar (USD)
 Discover
 JCB
 Mastercard
 Visa
EVO Payments  American Express United States Dollar (USD)
 Discover
 JCB
 Mastercard
 Visa

Table 2 North American Payment Processors, Accepted Card Types,

and Accepted Currencies (Continued)

First Data Merchant Services (FDMS) Omaha,  American Express United States Dollar (USD)
Nashville, and EFSNet
 Discover
 JCB
 Mastercard
 Visa
Global Payments  American Express United States Dollar (USD)
 Discover
 JCB
 Mastercard
 Visa
Heartland Payment Systems  American Express United States Dollar (USD)
 Diners Club
 Discover
 JCB
 Mastercard
 Visa
TSYS Acquiring Solutions  American Express United States Dollar (USD)
 Diners Club
 Discover
 JCB
 Mastercard
 Visa
WorldPay Atlanta  American Express United States Dollar (USD)
 Diners Club
 Discover
 JCB
 Mastercard
 Visa

European Payment Processors

Authorize.Net supports the following European payment processors, card types, and
currencies.
Table 3 European Payment Processors, Accepted Card Types,


AIB Merchant Services  Mastercard British Pounds (GBP)
 Visa Euro (EUR)
United States Dollar (USD)
Barclaycard  JCB British Pounds (GBP)
 Mastercard Euro (EUR)
 Visa
First Data Merchant Solutions (MSIP platform)  Mastercard British Pounds (GBP)
 Visa
HSBC Merchant Services  Mastercard British Pounds (GBP)
 Visa Euro (EUR)
Lloyds Bank Cardnet  Mastercard British Pounds (GBP)
 Visa
Streamline  JCB British Pounds (GBP)
 Mastercard Euro (EUR)
 Visa United States Dollar (USD)
Asia-Pacific Processors
Authorize.Net supports the following Asia-Pacific payment processors for Card-Not-
Present (CNP) transactions.
Table 4 Asia-Pacific Payment Processor, Accepted Card Types,


FDI Australia  Mastercard Australian Dollar (AUD)
 Visa New Zealand Dollar (NZD)
Westpac  Mastercard Australian Dollar (AUD)
 Visa

EVOSnap
There are multiple EVOSnap processing platforms. If you use the U.S. Dollar (USD), you
are assigned to EVOSnap U.S. If you use any other currencies, you are assigned to
EVOSnap International.
Accepted Authorization/Settlement Currencies

 USD—U.S. Dollar
 CAD—Canada Dollar
 CHF—Swiss Franc
 DKK—Danish Krone
 EUR—Euro
 GBP—British Pound
 NOK—Norway Krone
 PLN—Poland złoty (MasterCard Only)
 SEK—Sweden Krone
 ZAR—South African Rand
Accepted Billing Currencies

 USD—U.S. Dollar
 AUD—Australian Dollar
 GBP—British Pound
Accepted Card Types

 Visa
 MasterCard
 American Express
 JCB
 Diners Club—Supported for U.S. services only.
Unsupported Services
Apple Pay and soft descriptors are not supported by EVOSnap.

EVOSnap Supported Services

U.S. Services
Table 5 Authorize.Net Services Supported by EVOSnap U.S.
Service E-Commerce MOTO Retail

Transaction Types
Authorization only X X X
Authorization and capture (sale) X X X
Capture X X X
Void X X X
Credit (refund) X X X
Features
AVS X X X
CVV2/CVC2/CID X X X
3DS X
Purchase card—level 2 X X X
Partial Approvals (Partial Authorization) X X X
Supported card types: X X X
 Visa
 Mastercard
 American Express
 Discover
 JCB
 Diners Club
Duplication Rules
EVO platform always checks for duplicate transactions based on:
 Same Terminal ID
 Same Card Number
 Same Dollar Amount
Duplicates are flagged when they occur within an hour of each other.
Magstripe
Track 2 data is supported only for card-present transactions.
Level 2 Support

PO# is required when any level 2 data is submitted. Level 2 data includes tax, duty, and
freight information.
Billing Address
When any billing fields are submitted, all must be submitted.
 First name
 Last name
 Address
 City
 State/province (only required if country is US or Canada)
 Country
 ZIP/postal code
Other Field Requirements
The employeeId field is required; however, if a value is not passed with the field,
Authorize.Net sends a default value of 0000 to the processor.
Consolidated Accounts
The Consolidated Accounts feature is not supported on the EVOSnap platform. Multiples
market types require multiple accounts.
Automated Recurring Billing
Merchants using Automated Recurring Billing must be approved by their merchant service
provider, also known as their acquirer.

International Services
Table 6 Authorize.Net Services Supported by EVOSnap International
Service MOTO E-Commerce

Authorize X X
Authorize and Capture X X
Capture X X
Void X X
Credit X X
AVS—Visa and American Express X X
only.
CVV2/CVC2/CID X X
3DS X
Not Supported
 Retail
 Level 2 data
 Soft descriptors
 Partial authorization
 Consolidated accounts (MOTO/E-Commerce)—separate accounts are required.
 Automated recurring billing and customer information manager
CVV
EVOSnap requires CVV for all international transactions. CVV must be enabled in the
Authorize.Net merchant interface’s Virtual Terminal settings.
To enable CVV:
Step 1 Navigate to the Authorize.Net merchant interface.

Step 2 Choose Accounts > Settings > Transaction Format Settings > Virtual Terminal.
Step 3 Check the View/Edit box for Card Code.
Step 4 Click Submit.
Other EVOSnap Considerations

International AVS Behavior
Transactions are declined if the submitted address data does not match. Merchants can
override this behavior on a per-transaction basis, if permitted by EVOSnap. Merchant

accounts are configured to either use or not use AVS processing when they are boarded.
If the account is configured to not use AVS processing, AVS is not performed, even if the
data is included. If the merchant account is configured to use AVS every transaction must
include AVS data, unless the merchant is authorized by EVOSnap to override the AVS
processing.
API
Customer code is required. If not present, customer code is populated with 0000. Country
code must be in ISO format. For example, GBR, CHE, AUS.
Error Codes
 RTC 350
Description—EVOSnap: country must be a valid three-character value if specified.
Message—country must be a valid three-character value if specified.
 RTC 351
Description—EVOSnap: employee ID cannot be more than 6 characters in length, 4
for a retail transaction.
Message—employee ID must be 1 to %x characters in length.
Note—the %x is replaced with a 6 for E-Commerce and MOTO transaction types and
4 for retail transaction types.
Billing Information
When any billing information is submitted, all billing fields must be provided.
For information on setting the currency using the AIM API, see x_currency_code, page 36.
Software Development Kits

Authorize.Net offers software development kits (SDKs) that present an alternate object-
oriented model, in several popular languages. To use these SDKs, the merchant’s
transaction version must be set to 3.1. The SDK performs the core payment activities such
as error handling and parsing, network communication, and data encoding in the
background.
The SDK provides utilities to help developers build payment flows for each of the
integration methods. You can download the SDKs:
http://developer.authorize.net/downloads/

CHAPTER
Submitting Transactions
2
The payment gateway supports several credit card transaction types for transactions
submitted using AIM.
To implement AIM for a merchant’s web site or proprietary business application, you need
to develop an application that:
 Securely obtains all of the information required to process a transaction (including

data requirements specified by the merchant).
 Initiates an SSL/TLS 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.
You can develop the application in one of two ways:
 By yourself using the information provided in this document.

 Using Authorize.Net sample code available for free from our Developer Center.
If you choose to use sample code, be aware that to achieve a successful

implementation, the code must be modified with the merchant’s specific
Important payment gateway account information. Be sure to carefully review the
readme.txt files and comments included in each file of sample code in order to
achieve a successful integration.
Developer test accounts with API login IDs and transaction keys are also available to help
you test your integration with the Authorize.Net Payment Gateway:
http://developer.authorize.net/testaccount

Chapter 2 Submitting Transactions
Minimum Field Requirements

The following table contains the minimum fields required for submitting a credit card
transaction request to the payment gateway using AIM. The data fields are name/value
pairs with the following syntax:
x_name_of_field=value of field
Table 7 Minimum AIM Fields
Field Name Description

x_login Value: Merchant’s unique API Login ID.
Format: 20-characters maximum.
Notes: API Login ID that the merchant obtained from the Merchant
Interface. Must be stored securely.
The API Login ID and Transaction Key together provide access to the
payment gateway.
See the Merchant Integration Guide for more information.
x_tran_key Value: Merchant’s unique Transaction Key.
Format: 16-character maximum.
Notes: Transaction Key that the merchant obtained from the Merchant
Interface must be stored securely.
The API Login ID and Transaction Key together provide access to the
payment gateway.
x_type Value: Type of credit card transaction.
Format: AUTH_CAPTURE (default), AUTH_ONLY, CAPTURE_ONLY,
CREDIT, PRIOR_AUTH_CAPTURE, VOID
Notes: If the value submitted does not match a supported value, the
transaction is rejected. If this field is not submitted or the value is blank,
the payment gateway processes the transaction as AUTH_CAPTURE.
x_amount Value: Amount of the transaction.
Format: 15 digit-maximum, with a decimal point (no dollar symbol). For
example, 8.95.
Notes: This is the total amount and must include tax, shipping, and any
other charges.

Table 7 Minimum AIM Fields (Continued)

x_card_num Value: Customer’s credit card number
Format: 13 to 16 digits without spaces. When x_type=CREDIT, only the
last four digits are required.
Notes: It is sensitive cardholder information and must be stored securely
and in accordance with the Payment Card Industry (PCI) Data Security
Standard.
For more information about PCI compliance, see the Standards,
Compliance, and Security training video.
x_exp_date Value: Customer’s credit card expiration date
Format; MMYY, MM/YY, MM-YY, MMYYYY, MM/YYYY, MM-YYYY
Notes: It is sensitive cardholder information and must be stored securely
and in accordance with the Payment Card Industry (PCI) Data Security
Standard.
For more information about PCI compliance, see the Standards,
Compliance, and Security training video.
x_trans_id Value: Payment-gateway-assigned transaction ID of an original
transaction
Notes: Required only for CREDIT, PRIOR_AUTH_CAPTURE, and VOID
transactions. Do not include this field if you are providing the x_split_
tender_id field.
For more information about transaction types, see "Credit Card
Transaction Types," page 25.
x_split_tender_id Value: Payment-gateway-assigned ID that links the current authorization
request to the original authorization request.
Format: Numeric
Notes: This value applies only to partial authorization transactions and is
returned in the reply message from the original authorization request.
For more information, see "Partial Authorization Transactions," page 30.
x_auth_code Value: Authorization code of an original transaction not authorized on the
payment gateway
Format: 6 characters
Notes: Required only for CAPTURE_ONLY transactions. See "Credit
Card Transaction Types," page 25.
x_relay_response Value: FALSE
Format: FALSE, F, NO, N
Notes: SIM applications use relay response. Set this field to false if you
are using AIM.

Table 7 Minimum AIM Fields (Continued)

x_delim_data Value: Indicates whether a delimited transaction response is required
Format: TRUE, T, YES, Y
Notes: A value of TRUE indicates a request for delimited response from
the payment gateway. Because all AIM transactions are direct response, a
value of TRUE is required.
Submit this field for each transaction to ensure that transaction responses
are returned in the correct format.
See Chapter 4, "Transaction Response," on page 49 for more about
delimited responses.
European payment processors require additional fields. For more information,

see "Customer Information," page 40.
Note
Market Type Requirements

The market type is defined by how the cardholder interacts with a merchant. For example,
the information collected by a merchant when the customer physically swipes the card in a
retail situation is different than when the customer enters the card number and expiration
date into an e-commerce website. Standard Authorize.Net accounts support three market
types. Listed below are their definitions and unique required fields:
E-commerce
This market type is used for any transaction where the customer enters their card data
through a website or software application. The following fields are required when the
market type is e-commerce:
 x_market_type = 0
 x_card_num
 x_exp_date
MOTO (Mail Order/Telephone Order)

This market type is used for orders where the customer provides the card number and
expiration date to the merchant through a phone ordering service or offline form such as a
catalog order. The following fields are required when the market type is MOTO:
 x_card_num

 x_exp_date
Retail
This market type is distinctly different from the other two and is used in a scenario where
the customer is physically present with the merchant (or a terminal controlled by the
merchant). Generally, retail transactions involve the card being swiped through a magnetic
track reader and this raw track data is submitted for the transaction. The following fields
are required when the market type is Retail:
 x_device_type
plus the following:
 x_track1 or x_track2
or
 x_card_num and x_exp_date
While Authorize.Net supports all market types, the same cannot be said for all
merchant accounts. We recommend checking with your merchant account
Note provider to confirm that your account is configured to accept all of the market
types that are relevant to your business.
The payment processor EVO does not support Track 1 data. EVO also does
not support consolidated accounts; you must have separate e-commerce and
Note retail market types.
Credit Card Transaction Types

This section describes the credit card transaction types supported by the payment
gateway and their specific field requirements. Talk to your merchant about how they plan
to submit transactions so that you can integrate their payment gateway account to best
support their business processes.
For example, you may need to determine whether the merchant:
 Submits transactions mainly through an e-commerce web site.

 Needs to integrate a custom application to allow call center representatives to enter
mail order/telephone order (MOTO) transactions.
 Would like to verify the availability of funds on a customer’s credit card account at the
time of purchase and then charge the credit card when the order is shipped.

Some of the field requirements listed in this section for each credit card
transaction type are in addition to the minimum field requirements already set
Note forth above for ALL transactions submitted to the payment gateway. For a list of
all fields that are required for each credit card transaction type, see
Appendix A, "Fields by Transaction Type," on page 77.
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, it is
automatically submitted for settlement.
The unique field requirement for an Authorization and Capture transaction:
x_type=AUTH_CAPTURE
Authorization Only
This transaction type is sent for authorization only. The transaction is not sent for
settlement until the Prior Authorization and Capture credit card transaction type is
submitted (see definition below), 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.
If no action is taken on the Authorization Only transaction on the payment gateway within
30 days, the authorization expires and is no longer available for capture. A new
Authorization Only transaction then has to be submitted to obtain a new authorization
code.
The unique field requirement for an Authorization Only transaction:
x_type=AUTH_ONLY
Merchants can submit Authorization Only transactions when 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 if 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.
An Authorization Only and a Prior Authorization and Capture together are

considered one complete transaction. After the Prior Authorization and Capture
Note is submitted, the transaction is 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 or expired, or it generated an error.
 The amount being requested for capture is less than or equal to the original
authorized amount. Only a single Prior Authorization and Capture transaction can be
submitted against an Authorization Only transaction.
The unique field requirements for a Prior Authorization and Capture transaction are:
x_type=PRIOR_AUTH_CAPTURE
x_trans_id=Transaction ID
For this transaction type, the amount field (x_amount) is required only if a Prior
Authorization and Capture transaction 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 initiates 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.
The payment gateway accepts this transaction type and initiates settlement if 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 transaction:
x_type=CAPTURE_ONLY
x_auth_code=Authorization Code

For instructions on how to perform a Capture Only transaction in the Merchant Interface,
see the Merchant Integration Guide.
Credit (Refund)
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:

successfully settled transaction.
 The amount being requested for refund is less than or equal to the original settled
amount.
 The sum 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 transaction:
x_type=CREDIT
x_trans_id=Transaction ID
x_card_num=Full credit card number or last four digits only
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 enables 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 obtain the expanded credits capability (ECC), the merchant must
submit an application, which can be found at http://www.authorize.net/files/ecc.pdf.
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
Important Unlinked Credit transaction, the payment gateway attempts to apply the credit
to an original transaction with the transaction ID submitted.
The unique field requirement for an Unlinked Credit:
x_type=CREDIT
Void
This transaction type can be used to cancel either an original transaction that is not yet
settled or an entire order composed of more than one transaction. A Void prevents the
transaction or the order from being sent for settlement. A Void can be submitted against
any other transaction type.
If you are not sure whether a transaction is settled, you can attempt to submit a
Void first. If the Void transaction results in an error, the original transaction is
Note likely settled, and you can submit a Credit for the transaction.
The payment gateway accepts Voids if the following conditions are met:

successfully authorized transaction. To void an entire order, submit the split tender ID
(x_split_tender_id).
 The original transaction is not already settled or expired, or it generated an error.
The unique field requirements for a Void transaction:
 x_type=void
 x_trans_id=Transaction ID, or x_split_tender_id=Split Tender ID
Typically, Authorization Only or Authorization and Capture are the primary

transaction types submitted by an e-commerce web site or other
Note application. Although they most likely will not be used for the merchant’s
web site integration, all other transaction types listed above can be
integrated for automatic submission into an internal or enterprise
application, like those used in a call center, or they can also be submitted
by the merchant manually using the Virtual Terminal in the Merchant
Interface.

Visa Verification Transactions

For zero dollar 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 in order to perform the AVS
check.
Not all processors accept a zero dollar amount.
The payment processor EVO does not support Visa Verification transactions.
Note
Partial Authorization Transactions

A split tender order is an order in which two or more transactions are used to cover the
total amount.
Merchants must indicate that they can handle the extra processing either by selecting the
Partial Authorization option in the account settings of the Merchant Interface, or by
sending an x_allow_partial_auth=true value with an individual transaction. Without this
flag, the transaction would be handled as any other and would be either fully authorized or
declined due to lack of funds on the card.
When the first transaction is successfully approved for a partial amount of the total order, a
split tender ID is generated and returned to the merchant in the response. This ID must be
passed back with each of the remaining transactions of the group, using the x_split_
tender_id=<value> element. If you include both a split tender ID and a transaction ID on
the same request, an error results.
If successfully authorized, all transactions in the group are held until the final transaction
of the group is successfully authorized.
If the merchant needs to release the group of transactions before the final transaction is
approved (if the balance is paid by cash, for example), send a PRIOR_AUTH_CAPTURE
request and include the split tender ID instead of a transaction ID.
If the merchant needs to void the group before completion, send a void request using the
split tender ID instead of a transaction ID. This action voids all the transactions in the
group.
The following rules apply to partial authorization transactions:
 The merchant can choose to accept partial authorization transactions by selecting an

option in the Merchant Interface. Alternatively, partial authorization transactions can
be submitted by including a new API field (x_allow_partial_auth) in the initial request
that enables partial authorization for that specific request.

 When an authorization is granted for an amount less than the purchase amount, a
split tender ID is provided in addition to the Transaction ID. The split tender ID is used
on subsequent payments for that purchase.
 The transaction is not submitted for settlement until either the merchant submits
payments adding up to the full requested amount or until the merchant indicates that
the transaction has been completed (when all or part of the remaining balance is paid
in cash).
 You can void all transactions in an order using a split tender ID, or you can void
individual transactions using a transaction ID.
 The split tender ID cannot be submitted together with a transaction ID; only one or the
other can be submitted.
Table 8 Unique Field Requirements for Partial Authorization

Transactions
Field Request or Description

Response
x_allow_partial_auth=TRUE Request, optional The default value is set in the
Merchant Interface; you can use this
parameter to authorize individual
transactions if the option is set to
False in the Merchant Interface.
Including this field in the transaction
request overrides the merchant’s
account configuration.
x_prepaid_balance_on_card Response The authorized amount remaining on
the card.
x_prepaid_requested_amount Response The amount requested.
x_split_tender_id Response The split tender ID provided when the
first partial authorization transaction
was issued. Use this ID when
submitting subsequent transactions
related to the same group order.
x_split_tender_status Response Indicates whether or not the
transaction is complete. This
parameter is sent to the merchant
during relay response processing. It
is not included in the delimited
response.
x_card_type Response Indicates whether or not the
transaction is complete. This
parameter is sent to the merchant
during relay response processing. It
is not included in the delimited
response.

Using the Merchant Interface

The Merchant Interface enables merchants to manage transactions, capture Authorization
Only transactions, void transactions, and issue refunds. These transaction types can also
be managed automatically using the API if you are integrating a custom application to the
payment gateway. However, for most integrations, these transaction types can be more
conveniently and easily managed in the Merchant Interface.
For more information on submitting transactions in the Merchant Interface, see the
Merchant Integration Guide or click Help in the top right corner of the Merchant Interface.

CHAPTER
Transaction Data
Requirements
3
The standard payment gateway Application Programming Interface (API) consists of

required information fields (introduced in the previous section) and additional optional
fields that can be submitted to the payment gateway for real-time transaction processing.
Transaction Post Location

The merchant’s web site should POST transaction requests to the following payment
gateway URL:
https://secure2.authorize.net/gateway/transact.dll
The following is a legacy but supported URL.
https://secure.authorize.net/gateway/transact.dll
Do not use an IP address when submitting transactions.
Note
If you are using an Authorize.Net developer test account, test transactions

are posted to a staging environment at https://test.authorize.net/gateway/
Note transact.dll. If you do not have a developer test account, you can sign up for
one at http://developer.authorize.net.
Transactions should be sent using HTTP POST, not HTTP GET. HTTP
GET sends information in clear text and is therefore not secure.
Note For more information, see RFC 2616, section 15.1.3.

Chapter 3 Transaction Data Requirements
AIM Transaction Submission API

The following tables list the transaction data fields that can be submitted using the
transaction request string. Some of these fields can also be configured in the Merchant
Interface. For more information about configuring these settings in the Merchant Interface,
see the Merchant Integration Guide.
Fields are name/value pairs with this syntax:
x_name_of_field = value of the field
Merchant Information
Table 9 Merchant Information

x_login Required
Value: The merchant’s unique API Login ID.
Notes: The merchant API Login ID is provided in the Merchant Interface
and must be stored securely.
The API Login ID and Transaction Key together provide the merchant
authentication required for access to the payment gateway.
x_tran_key Required
Value: The merchant’s unique Transaction Key
Notes: The merchant Transaction Key is provided in the Merchant
Interface and must be stored securely.
The API Login ID and Transaction Key together provide the merchant
authentication required for access to the payment gateway.
x_allow_partial_Auth Optional
Value: True, False
Notes: Indicates whether the transaction is enabled for partial
authorization. Including this field in the transaction request overrides
your account configuration.
For more information, see "Partial Authorization Transactions," page 30.
x_response_format Value: Set to 2. The 0 and 1 values are now deprecated.
Note: This field overrides the default response format.

Transaction Information
Table 10 Transaction Information

x_version Required
Value: The merchant’s transaction version.
Format: 3.0, 3.1
Notes: Indicates to the system the set of fields that will be
included in the response:
3.0 is the default version.
3.1 allows the merchant to use the Card Code feature and the
Partial Authorization feature, and is the current standard version.
It is highly recommended that you submit this field per
transaction to be sure that the formats of transaction requests
and the responses you receive are consistent.
For more information, see Appendix A, "Fields by Transaction
Type," on page 77.
x_type Optional
Value: The type of credit card transaction.
Format: AUTH_CAPTURE (default), AUTH_ONLY, CAPTURE_
ONLY, CREDIT, PRIOR_AUTH_CAPTURE, VOID
Notes: If the value submitted does not match a supported value,
the transaction is rejected. If this field is not submitted, or the
value is blank, the payment gateway processes the transaction
as an AUTH_CAPTURE.
x_method Optional
Value: The payment method.
Format: CC or ECHECK
Notes: The method of payment for the transaction, CC (credit
card) or ECHECK (electronic check). If this field is not submitted
or is blank, the value defaults to CC.
For more information about eCheck.Net transaction
requirements, see the eCheck.Net Developer Guide.
x_market_type Optional
Value: One of the following:
 0 for e-commerce
 1 for moto
 2 for retail
Notes: If your account type is Card Present, the default is 2 and

only 2 can be used. If your account type is blended, the default is
0, but x_market_type can be overridden.

Table 10 Transaction Information (Continued)

x_recurring_billing Optional
Value: The recurring billing status.
Format: TRUE, FALSE,T, F, YES, NO, Y, N,1, 0
Notes: Indicating marker used by merchant account providers to
identify transactions that originate from merchant hosted
recurring billing applications. This value is not affiliated with
Automated Recurring Billing.
x_amount Required
Value: The amount of the transaction .
Format: 15-digit maximum with a decimal point (no dollar
symbol). For example, 8.95.
Notes: This is the total amount and must include tax, shipping,
and any other charges. The amount can either be hard coded or
posted to a script.
x_currency_code Optional
Value: AUD, USD, CAD, EUR, GBP, or NZD.
Format: 3-character string.
Notes: The default currency is selected by the merchant’s
gateway and/or payment processor.
x_card_num Required
Value: The customer’s credit card number
Format: 13 to 16 digits without spaces. When x_type=CREDIT,
only the last four digits are required.
Warning This is sensitive cardholder information and must be
stored securely and in accordance with the Payment Card
For more information about PCI, see the Standards, Compliance,
and Security training video.
x_exp_date Required
Value: The customer’s credit card expiration date
Format: MMYY, MM/YY, MM-YY, MMYYYY, MM/YYYY, MM-
YYYY
Warning This is sensitive cardholder information and must be
stored securely and in accordance with the Payment Card
For more information about PCI, see the Standards, Compliance,
and Security training video.


x_card_code Optional
Value: The 3- or 4-digit number on the back of a credit card (on
the front for American Express).
Format: Numeric
Notes: This field is required if the merchant would like to use the
Card Code Verification (CCV) security feature. For more
information, see the Merchant Integration Guide.
Warning Cardholder information must be stored securely and
in accordance with the Payment Card Industry (PCI) Data
Security Standard.
See the Standards, Compliance, and Security training video for
more information.
x_trans_id Conditional
Required only for CREDIT, PRIOR_ AUTH_ CAPTURE, and
VOID transactions
Value: The payment gateway assigned transaction ID of an
original transaction.
For more information about transaction types, see "Credit Card
Transaction Types," page 25.
x_split_tender_id Conditional
Value: The payment gateway-assigned ID assigned when the
original transaction includes two or more partial payments. This is
the identifier that is used to group transactions that are part of a
split tender order.
Notes: If the first transaction results in a partial authorization, the
payment gateway returns this ID to the merchant. The merchant
must pass this ID back with each subsequent transaction that will
be part of the group of transactions sent to obtain the entire
amount of the order. The payment gateway does not calculate
new amounts; the merchant’s software calculates new amounts.
For more information about partial authorization transactions, see
"Partial Authorization Transactions," page 30.
x_auth_code Conditional
Required only for CAPTURE_ ONLY transactions.
Value: The authorization code of an original transaction not
authorized on the payment gateway
Notes: See "Credit Card Transaction Types," page 25.


x_test_request Optional
Value: The request to process test transactions.
Format: TRUE, FALSE, T, F, YES, NO, Y, N, 1, 0
Notes: Indicates whether the transaction should be processed as
a test transaction.
See Chapter 5, "Test Transactions," on page 74 of this guide for
more information.
x_duplicate_window Optional
Value: The period of time after the submission of a transaction
during which a duplicate transaction cannot be submitted.
Format: Any value between 0 and 28800 (no comma)
Notes: Indicates in seconds the period of time after a transaction
is submitted during which the payment gateway checks for a
duplicate transaction. The maximum time allowed is 8 hours
(28800 seconds).
If a value less than 0 is sent, the payment gateway defaults to 0
seconds. If a value greater than 28800 is sent, the payment
gateway defaults to 28800. If no value is sent, the payment
gateway defaults to 2 minutes (120 seconds).
If this field is present in the request with or without a value, an
enhanced duplicate transaction response is sent. See "Response
for Duplicate Transactions," page 56.
Order Information
Table 11 Order Information

x_invoice_num Optional
Value: The merchant-assigned invoice number for the transaction.
Format: 20-character maximum (no symbols).
Notes: The invoice number must be created dynamically on the merchant
server or provided per transaction. The payment gateway does not
perform this function.
x_description Optional
Value: The transaction description.
Notes: The description must be created dynamically on the merchant
server or provided per transaction. The payment gateway does not
perform this function.

Itemized Order Information

Based on their business requirements, merchants can choose to submit itemized order
information with a transaction using the optional x_line_item field. Itemized order
information is not submitted to the processor and is not currently returned with the
transaction response. This information is displayed on the Transaction Detail page and in
QuickBooks download file reports in the Merchant Interface.
The value for the x_line_item field can include delimited item information. Item
information must be delimited by a bracketed pipe <|>. Line item values must be included
in the order listed below.
The following table describes the Item Information elements of the x_line_item field. A
code example is presented after the table.
Table 12 Delimited x_line_item Information
Item Information
Description
Elements
Item ID<|> Required
Value: The ID assigned to an item.
Format: 31-character maximum
Item Name<|> Required
Value: The name of an item.
Item Description<|> Optional
Value: A detailed description of an item.
Item Quantity<|> Required
Value: The quantity of the item on this order.
Format: Maximum of 2 decimal places. Must be a positive number.
Item Price (unit cost)<|> Required
Value: Cost of an item per unit, excluding tax, freight, and duty.
Format: Maximum of 2 decimal places. Must be a positive number.
The dollar sign ($) is not allowed in delimited information.
Item Taxable Optional (FALSE by default)
Value: Indicates whether the item is subject to tax.
The merchant can submit a maximum of 30 distinct line items containing itemized order
information for each transaction. All field separators are required whether or not the field
has a value. In the example below, the item description field after golf balls<|> has no
value, yet the bracketed pipe remains.

Example Submitting Itemized Order Information

x_line_item=item1<|>golf balls<|><|>2<|>18.95<|>Y
x_line_item=item2<|>golf bag<|>Wilson golf carry bag,

red<|>1<|>39.99<|>Y
x_line_item=item3<|>book<|>Golf for Dummies<|>1<|>21.99<|>Y
For Prior Authorization and Capture transactions, if line item information was
submitted with the original transaction, adjusted information can be submitted if
Note the transaction changed. If no adjusted line item information is submitted, the
information submitted with the original transaction applies.
Customer Information
Table 13 Customer Information

x_first_name Required only when using a European payment processor.
Value: The first name associated with the customer’s billing address
Format: 50-character maximum (no symbols)
x_last_name Required only when using a European payment processor.
Value: The last name associated with the customer’s billing address
x_company Optional
Value: The company associated with the customer’s billing address
x_address Required only when using a European payment processor.
Value: The customer’s billing address
Required if the merchant would like to use the Address Verification Service
security feature.
For more information on AVS, see the Merchant Integration Guide.
x_city Required only when using a European payment processor.
Value: The city of the customer’s billing address
x_state Required only when using a European payment processor.
Value: The state of the customer’s billing address
Format: 40-character maximum (no symbols) or a valid 2-character state
code

Table 13 Customer Information (Continued)

x_zip Required only when using a European payment processor.
Value: The ZIP code of the customer’s billing address
Required if the merchant would like to use the Address Verification Service
security feature.
For more information on AVS, see the Merchant Integration Guide.
x_country Required only when using a European payment processor.
Value: The country of the customer’s billing address
x_phone Optional
Value: The phone number associated with the customer’s billing address
Format: 25-digit maximum (no letters). For example, (123)123-1234
x_fax Optional
Value: The fax number associated with the customer’s billing address
x_email Required only when using a European payment processor.
Value: The customer’s valid email address
Format: 255-character maximum. For example, janedoe@customer.com
Notes: The email address to which the customer’s copy of the email receipt
is sent when the Email Receipts option is configured in the Merchant
Interface. The email is sent to the customer only if the email address format
is valid.
For more information about email receipts, see the Merchant Integration
Guide.
x_cust_id Optional
Value: The merchant assigned customer ID
Notes: The unique identifier that represents the customer associated with
the transaction.
The customer ID must be created dynamically on the merchant server or
provided per transaction. The payment gateway does not perform this
function.

Table 13 Customer Information (Continued)

x_customer_ip Optional
Value: The customer’s IP address
Format: 15-character maximum (no letters). For example, 255.255.255.255
Notes: IP address of the customer initiating the transaction. If this value is
not passed, it defaults to 255.255.255.255.
This field is required with customer-IP-based Advanced Fraud Detection
Suite (AFDS) filters. For more information about AFDS, see the Merchant
Integration Guide.
If your payment processor is EVO and you submit one of the following fields,
you must submit them all.
Note  x_first_name
 x_last_name
 x_address
 x_city
 x_state
 x_zip
Shipping Information
Table 14 Shipping Information

x_ship_to_first_name Optional
Value: The first name associated with the customer’s shipping
address
x_ship_to_last_name Optional
Value: The last name associated with the customer’s shipping
address
x_ship_to_company Optional
Value: The company associated with the customer’s shipping
address

Table 14 Shipping Information (Continued)

x_ship_to_address Optional
Value: The customer’s shipping address
x_ship_to_city Optional
Value: The city of the customer’s shipping address
x_ship_to_state Optional
Value: The state of the customer’s shipping address
Format: 40-character maximum (no symbols) or a valid two-character
state code
x_ship_to_zip Optional
Value: The ZIP code of the customer’s shipping address
x_ship_to_country Optional
Value: The country of the customer’s shipping address
If your payment processor is EVO and you submit one of the following fields,
you must submit them all.
Note  x_ship_to_first_name
 x_ship_to_last_name
 x_ship_to_address
 x_ship_to_city
 x_ship_to_state
 x_ship_to_zip
Additional Shipping Information (Level 2 Data)

The following sections describe shipping information field names and their child elements.
Delimited tax, freight, and duty information is not returned in the transaction response or in
the merchant confirmation email. This information is displayed only on the Transaction
Detail page in the Merchant Interface.

x_tax
This optional field can contain either the valid tax amount or delimited tax information.
When submitting delimited tax information, you must delimit values with a bracketed pipe
<|> in the order shown below. The total amount of the transaction in x_amount must
include this amount.
The delimited tax information elements are:
 tax item name<|>

 tax description<|>
 tax amount: the dollar sign ($) is not allowed within delimited information. The total
amount of the transaction in x_amount must include this amount.
Example 1
x_tax=Tax1<|>state tax<|>0.09
x_freight
This optional field can contain either the valid freight amount or delimited freight
information. When submitting delimited freight information, you must delimit values with a
bracketed pipe <|>, as shown in the example below. The total amount of the transaction
inthe x_amount field must include this amount.
The delimited freight information elements are:
 tax item name<|>

 tax description<|>
 tax amount: The dollar sign ($) is not allowed within delimited information. The total
amount of the transaction in the x_amount field must include this amount.
Example 2 x_freight
x_freight=Freight<|>ground overnight<|>12.95
x_duty
This optional field can contain either the valid duty amount or delimited duty information.
When submitting delimited duty information, you must delimit values with a pipe <|>, as
shown in the example below. The total amount of the transaction in the x_amount field
must include this amount.
The delimited duty information elements are:
 duty item name<|>

 freight description<|>
 freight amount: the dollar sign ($) is not allowed within delimited information. The total
amount of the transaction in the x_amount field must include this amount.
Example 3 x_duty
x_duty=Duty1<|>export<|>15.00
x_tax_exempt
This optional field can contain the tax exempt status of the order.
The values of this field can include: TRUE, FALSE, T, F, YES, NO, Y, N, 1, 0.
x_po_num
This optional field can contain the merchant-assigned purchase order number, up to 25
characters, no symbols. The purchase order number must be created dynamically on the
merchant server or provided per transaction. The payment gateway does not perform this
function.
If your payment processor is EVO and you submit Level 2 data, you must also
submit the x_po_num field.
Note
Cardholder Authentication
The payment gateway supports the transmission of authentication fields for the following
cardholder authentication programs:
 Verified by Visa
 MasterCard SecureCode
Merchants using a third-party cardholder authentication solution can submit the following
authentication values with Visa and/or MasterCard transactions.
The cardholder authentication fields are currently supported only through the
Chase Paymentech, FDMS Nashville, Global Payments, and TSYS
Note processors for Visa and MasterCard transactions. Cardholder authentication
information submitted for transactions processed through any other processor
is ignored.

Table 15 Cardholder Authentication Fields

x_authentication_indicator Optional
Value: The electronic commerce indicator (ECI) value for
a Visa transaction; or the universal cardholder
authentication field indicator (UCAF) for a MasterCard
transaction obtained by the merchant after the
authentication process.
Format: Special characters included in this value must be
URL encoded.
Notes: Required only for AUTH_ONLY and AUTH_
CAPTURE transactions processed through cardholder
authentication programs. When submitted with other
transaction types, this value is ignored.
This field is currently supported through Chase
Paymentech, FDMS Nashville, Global Payments, and
TSYS.
x_cardholder_authentication_value Optional
Value: The cardholder authentication verification value
(CAVV) for a Visa transaction; or accountholder
authentication value (AVV)/ universal cardholder
authentication field (UCAF) for a MasterCard transaction
obtained by the merchant after the authentication process.
Format: Special characters included in this value must be
URL encoded.
Notes: Required only for AUTH_ONLY and AUTH_
CAPTURE transactions processed through cardholder
authentication programs. When submitted with other
transaction types, this value is ignored.
This field is currently supported through Chase
Paymentech, FDMS Nashville, Global Payments, and
TSYS.
Invalid combinations of the x_authentication_indicator and x_cardholder_

authentication_value fields cause the transaction to generate an error.

Valid value combinations for these fields are as follows:
Table 16 Valid Value Combinations for Verified by Visa Fields
Authentication Cardholder Authentication Value

Indicator
5 Not null
6 Not null
6 Null/Blank
7 Null/Blank
7 Not null (some international issuers can provide a CAVV value when
ECI is 7)
Null/Blank Null/Blank
Table 17 Valid Value Combinations for MasterCard SecureCode Fields
Authentication Cardholder Authentication Value

Indicator
0 Blank/Null
2 Not null
1 Optional
Null Null
For example, when the MasterCard value for the x_authentication_indicator field is 1,
the value for the x_cardholder_authentication_value field is optional.
The authentication verification value returned by Visa or MasterCard is included in the

transaction response from the payment gateway and is also included on the Transaction
Detail page for the transaction in the Merchant Interface.
Merchant-Defined Fields
Merchants can also choose to include merchant-defined fields to further customize the
information included with a transaction. Merchant-defined fields are any fields that are not
recognized by the payment gateway as standard application programming interface (API)
fields.
For example, the merchant might want to provide a field in which customers provide
specific shipping instructions and product color information. All you need to do is submit a

custom field name and any accompanying text with the transaction request string—for
example, shipping_instructions and product_color.
Standard payment gateway fields that are misspelled are treated as merchant-
defined fields.
Note
Merchant-defined data fields are not intended to and must not be used to
capture personally identifying information. Accordingly, the merchant is
Warning prohibited from capturing, obtaining, and/or transmitting any personally
identifying information in or by means of the merchant-defined data fields.
Personally identifying information includes, but is not limited to, name, address,
credit card number, social security number, driver's license number, state-
issued identification number, passport number, and card verification numbers
(CVV, CVC2, CVV2, CID, CVN). If Authorize.Net discovers that the merchant is
capturing and/or transmitting personally identifying information by means of the
merchant-defined data fields, whether or not intentionally, CyberSource will
immediately suspend the merchant's account, which will result in a rejection of
any and all transaction requests submitted by the merchant after the point of
suspension.

CHAPTER
Transaction Response
4
The transaction response from the payment gateway is returned as a delimited string and
provides information about the status of a transaction—whether it was accepted or
declined—as well as information included in the transaction request.
Fields in the response are delimited by a character that is specified in the transaction
request string (x_delim_char) or configured in the Merchant Interface. The merchant
server can parse this data to customize receipt messages that can be displayed or
emailed to the customer. Transaction results are also provided in the payment gateway
merchant confirmation email and on the Transaction Detail page for the transaction in the
Merchant Interface.
You can use the following fields to customize the format of the payment gateway
transaction response. You can also configure these settings in the Merchant Interface. For
more information about configuring these settings in the Merchant Interface, see the
Merchant Integration Guide.
Fields are name/value pairs with the syntax:
x_name_of_field=value of the field&

Chapter 4 Transaction Response
Table 18 Response Request Fields

x_delim_char Value: The delimiting character
Format: A single symbol. For example:
, (comma)
| (pipe)
“ (double quotes)
‘ (single quote)
: (colon)
; (semicolon)
/ (forward slash)
\ (back slash)
- (hyphen)
* (asterisk)
Notes: The character used to separate fields in the transaction response. The
payment gateway uses the character passed in this field, or if no value is
passed, the value is stored in the Merchant Interface.
If this field is passed, and the value is null, it overrides the value stored in the
Merchant Interface, and there is no delimiting character in the transaction
response.
Submit this field for each transaction to ensure that transaction responses are
returned in the correct format.
x_encap_char Value: The encapsulating character
Format: A single symbol. For example:
| (pipe)
“ (double quotes)
‘ (single quote)
: (colon)
; (semicolon)
/ (forward slash)
\ (back slash)
- (hyphen)
* (asterisk)
Notes: The character used to encapsulate the fields in the transaction
response. It is necessary only if your delimiting character could possibly be
included in any field values.
The payment gateway uses the character passed in this field, or if no value is
passed, it uses the value stored in the Merchant Interface.

Fields in the Payment Gateway

Response
The following table lists the fields returned in the response from the payment gateway in
the order that they are listed in the response.
Table 19 Payment Gateway Response Fields
Order Field Name Description

1 Response Code Value: The overall status of the transaction
Format:
 1 = Approved
 2 = Declined
 3 = Error
 4 = Held for review
2 Response Value: A code used by the payment gateway for internal
Subcode transaction tracking
3 Response Value: A code that represents more details about the result of
Reason Code the transaction
Format: Numeric
Notes: See "Response Code Details," page 58, for a listing of
response reason codes.
4 Response Value: A brief description of the result that corresponds with the
Reason Text response reason code
Format: Text
Notes: You can generally use this text to display a transaction
result or error to the customer. However, review "Response
Code Details," page 58, to identify any specific texts you do not
want to pass to the customer.
5 Authorization Value: The authorization or approval code
Code

Table 19 Payment Gateway Response Fields (Continued)

6 AVS Response Value: The Address Verification Service (AVS) response code
Format:
 A = Address (Street) matches, ZIP does not
 B = Address information not provided for AVS check
 E = AVS error
 G = Non-U.S. Card Issuing Bank
 N = No Match on Address (Street) or ZIP
 P = AVS not applicable for this transaction
 R = Retry—System unavailable or timed out
 S = Service not supported by issuer
 U = Address information is unavailable
 W = Nine digit ZIP matches, Address (Street) does not
 X = Address (Street) and nine digit ZIP match
 Y = Address (Street) and five digit ZIP match
 Z = Five digit ZIP matches, Address (Street) does not
Notes: Indicates the result of the AVS filter.
For more information about AVS, see the Merchant Integration
Guide.
7 Transaction ID Value: The payment gateway-assigned identification number for
the transaction
Format: When x_test_request is set to a positive response, or
when Test Mode is enabled on the payment gateway, this value
is 0.
Notes: This value must be used for any follow-on transactions
such as a CREDIT, PRIOR_AUTH_CAPTURE, or VOID.
8 Invoice Number Value: The merchant-assigned invoice number for the
transaction
9 Description Value: The transaction description
10 Amount Value: The amount of the transaction
Format: 15-digit maximum
11 Method Value: The payment method
CC or ECHECK
12 Transaction Type Value: The type of credit card transaction
Format: AUTH_CAPTURE, AUTH_ONLY, CAPTURE_ONLY,
CREDIT, PRIOR_AUTH_CAPTURE, VOID


13 Customer ID Value: The merchant-assigned customer ID
14 First Name Value: The first name associated with the customer’s billing
address
15 Last Name Value: The last name associated with the customer’s billing
address
16 Company Value: The company associated with the customer’s billing
address
17 Address Value: The customer’s billing address
18 City Value: The city of the customer’s billing address
19 State Value: The state of the customer’s billing address
Format: 40-character maximum (no symbols) or a valid
2-character state code
20 ZIP Code Value: The ZIP code of the customer’s billing address
21 Country Value: The country of the customer’s billing address
22 Phone Value: The phone number associated with the customer’s billing
address
Format: 25-character maximum (no letters). For example,
(123)123-1234
23 Fax Value: The fax number associated with the customer’s billing
address
Format: 25-digit maximum (no letters). For example, (123)123-
1234
24 Email Address Value: The customer’s valid email address
25 Ship To First Value: The first name associated with the customer’s shipping
Name address
26 Ship To Last Value: The last name associated with the customer’s shipping
Name address


27 Ship To Value: The company associated with the customer’s shipping
Company address
28 Ship To Address Value: The customer’s shipping address
29 Ship To City Value: The city of the customer’s shipping address
30 Ship To State Value: The state of the customer’s shipping address
Format: 40-character maximum (no symbols) or a valid 2-
character state code
31 Ship To ZIP Value: The ZIP code of the customer’s shipping address
Code
32 Ship To Country Value: The country of the customer’s shipping address
33 Tax Value: The tax amount charged
Format: Numeric
Notes: Delimited tax information is not included in the
transaction response.
34 Duty Value: The duty amount charged
Format: Numeric
Notes: Delimited duty information is not included in the
35 Freight Value: The freight amount charged
Format: Numeric
Notes: Delimited freight information is not included in the
36 Tax Exempt Value: The tax exempt status
37 Purchase Order Value: The merchant-assigned purchase order number
Number
38 MD5 Hash Value: The payment gateway-generated MD5 hash value that
can be used to authenticate the transaction response.
Notes: Optional. Transaction responses are returned using SSL/
TLS, so this field is useful mainly as a redundant security check.


39 Card Code Value: The card code verification (CCV) response code
Response
Format:
 M = Match
 N = No Match
 P = Not Processed
 S = Should have been present
 U = Issuer unable to process request
Notes: Indicates the result of the CCV filter.

For more information about CCV, see the Merchant Integration
Guide.
40 Cardholder Value: The cardholder authentication verification response code
Authentication
Format: Blank or not present = CAVV not validated
Verification
Response  0—CAVV not validated because erroneous data was
submitted
 1—CAVV failed validation
 2—CAVV passed validation
 3—CAVV validation could not be performed; issuer attempt
incomplete
 4—CAVV validation could not be performed; issuer system
error
 5—Reserved for future use
 6—Reserved for future use
 7—CAVV attempt—failed validation—issuer available (U.S.-
issued card/non-U.S acquirer)
 8—CAVV attempt—passed validation—issuer available (U.S.-
issued card/non-U.S. acquirer)
 9—CAVV attempt—failed validation—issuer unavailable
(U.S.-issued card/non-U.S. acquirer)
 A—CAVV attempt—passed validation—issuer unavailable
(U.S.-issued card/non-U.S. acquirer)
 B—CAVV passed validation, information only, no liability shift
51 Account Number Value: Last 4 digits of the card provided
Format: Alphanumeric (XXXX6835)
Notes: This field is returned with all transactions.
52 Card Type Value: Visa, MasterCard, American Express, Discover, Diners
Club, JCB
Format: Text


53 Split Tender ID Value: The value that links the current authorization request to
the original authorization request. This value is returned in the
reply message from the original authorization request
Format: Alphanumeric
Notes: Split Tender ID is returned only in the reply message for
the first transaction that receives a partial authorization.
54 Requested Value: Amount requested in the original authorization
Amount
Format: Numeric
Notes: Requested amount is present if the current transaction is
for a prepaid card or if a x_split_tender_id element was sent in.
55 Balance On Card Value: Balance on the debit card or prepaid card
Format: Numeric
Notes: Can be a positive or negative number. Balance On Card
has a value only if the current transaction is for a prepaid card.
Response for Duplicate Transactions

You can specify the period (“window”) of time after a transaction is submitted during which
the payment gateway checks for a duplicate transaction (based on credit card number,
invoice number, amount, billing address information, transaction type, etc.) using the
duplicate window field (x_duplicate_window). The value for this field can range from 0 to
28800 seconds (maximum of 8 hours).
If the transaction request does not include the duplicate window field, and the payment
gateway detects a duplicate transaction within the default window of 2 minutes, the
payment gateway response will contain the response code of 3 (processing error) with a
response reason code of 11 (duplicate transaction) with no additional details.
If the transaction request does include the duplicate window field and value, and the
payment gateway detects a duplicate transaction within the window of time specified, the
payment gateway response for the duplicate transaction will include the response code
and response reason code listed above, as well as information about the original
transaction (as outlined below).
If the original transaction was declined, and a value was passed in the duplicate window
field, the payment gateway response for the duplicate transaction will include the following
information for the original transaction:
 AVS result
 CCV result
 Transaction ID

If the original transaction was approved, and a value was passed in the duplicate window
field, the payment gateway response will also include the authorization code for the
original transaction. All duplicate transactions submitted after the duplicate window are
processed normally, whether specified in the transaction request or after the payment
gateway’s default 2-minute duplicate window.
AIM Transaction Response Types

There are two versions of the AIM response string, version 3.0 and version 3.1.
Version 3.0
The version 3.0 response contains system fields from position 1 to 38 and echoes
merchant-defined fields from 39 on, in the order received by the system.
The following are examples of a 3.0 transaction query string and response:
Example 4 3.0 Transaction Query String

https://test.authorize.net/gateway/transact.dll?x_
login=YourAPILogin&x_tran_key=YourTransactionKey&x_delim_
data=true&x_relay_response=false&x_card_num=4111111111111111&x_exp_
date=1010&x_amount=1.00&merchant_defined_field1=merchant-defined-
field_1&merchant_defined_field2=merchant_defined_field_2
Example 5 3.0 Transaction Query Response

1,1,1,This transaction has been
approved.,iKUUAm,Y,2149207036,,,1.00,CC,auth_
capture,,,,,,,,,,,,,,,,,,,,,,,,,,433AF62576BFC33D0B7B8A75FB229220,me
rchant defined field 1,merchant defined field 2
Version 3.1
The version 3.1 response string contains 68 system fields with field number 39
representing the Card Code (CVV2/CVC2/CID) response code. Merchant-defined fields
are echoed from field 69 onward. Merchants wishing to use the Card Code feature and
merchants who accept partial authorization transactions must use transaction version 3.1.

Example 6 3.1 Transaction Query String

https://test.authorize.net/gateway/transact.dll?x_
login=99W58L5veksj&x_tran_key=2jL4g9447PQJd3uF&x_delim_data=true&x_
relay_response=false&x_card_num=4111111111111111&x_exp_date=1010&x_
amount=1.00&merchant_defined_field1=merchant defined field
1&merchant_defined_field2=merchant defined field 2
Example 7 3.1 Transaction Query Response

1,1,1,This transaction has been
approved.,tt9ieF,Y,2149207083,,,1.00,CC,auth_
capture,,,,,,,,,,,,,,,,,,,,,,,,,,DE9F3FAD313D32144FA7EDF4B27CCE02,,2
,,,,,,,,,,,,,,,,,,,,,,,,,,,,,merchant defined field 1,merchant
defined field 2
Configuring the Transaction Version

To configure the transaction version:
Step 1 Log on to the Merchant Interface.
Step 2 From the main menu, choose Settings.
Step 3 In the Transaction Response section click Transaction Version.
Step 4 In the Transaction Version drop-down menu, choose a transaction version.
Step 5 Click Submit.
You can also configure the transaction version per transaction by using the x_version
element.
You can upgrade only to a higher transaction version.
Note
Response Code Details

The following tables list the response codes and response reason texts that are returned
for each transaction. In addition to the information in this document, Authorize.Net
provides the Reason Response Code Tool to help you troubleshoot errors.

 Response Code indicates the overall status of the transaction with possible values of
approved, declined, errored, or held for review.
 Response Reason Code is a numeric representation of a more specific reason for

the transaction status.
 Response Reason Text details the specific reason for the transaction status. This
information can be returned to the merchant and/or customer to provide more
information about the status of the transaction.
Table 20 Response Codes
Response Description
Code
1 This transaction has been approved.
2 This transaction has been declined.
3 There has been an error processing this transaction.
4 This transaction is being held for review.
Table 21 Response Reason Code Text
Response Response Response Reason Text Notes

Code Reason
Code
1 1 This transaction has been approved.
2 2 This transaction has been declined.
2 3 This transaction has been declined.
2 4 This transaction has been declined. The code returned from the processor
indicating that the card used needs to
be picked up.
3 5 A valid amount is required. The value submitted in the amount field
did not pass validation for a number.
3 6 The credit card number is invalid.
3 7 The credit card expiration date is The format of the date submitted was
invalid. incorrect.
3 8 The credit card has expired.
3 9 The ABA code is invalid. The value submitted in the x_bank_
aba_code field did not pass validation
or was not for a valid financial
institution.
3 10 The account number is invalid. The value submitted in the x_bank_
acct_num field did not pass validation.

Table 21 Response Reason Code Text (Continued)

Code Reason
Code
3 11 A duplicate transaction has been A transaction with identical amount and
submitted. credit card information was submitted
two minutes prior.
3 12 An authorization code is required but A transaction that required x_auth_
not present. code to be present was submitted
without a value.
3 13 The merchant API Login ID is invalid or
the account is inactive.
3 14 The Referrer or Relay Response URL The Relay Response or Referrer URL
is invalid. does not match the merchant’s
configured value(s) or is absent.
Applicable only to SIM and WebLink
APIs.
3 15 The transaction ID is invalid. The transaction ID value is non-
numeric or was not present for a
transaction that requires it (i.e., VOID,
PRIOR_AUTH_CAPTURE, and
CREDIT).
3 16 The transaction was not found. The transaction ID sent in was properly
formatted but the gateway had no
record of the transaction.
3 17 The merchant does not accept this The merchant was not configured to
type of credit card. accept the credit card submitted in the
transaction.
3 18 ACH transactions are not accepted by The merchant does not accept
this merchant. electronic checks.
3 19 - 23 An error occurred during processing.
Please try again in 5 minutes.
3 24 The Nova Bank Number or Terminal ID
is incorrect. Call Merchant Service
Provider.
3 25 - 26 An error occurred during processing.
2 27 The transaction resulted in an AVS
mismatch. The address provided does
not match billing address of cardholder.
2 28 The merchant does not accept this The Merchant ID at the processor was
type of credit card. not configured to accept this card type.
2 29 The Paymentech identification
numbers are incorrect. Call Merchant
Service Provider.


Code Reason
Code
2 30 The configuration with the processor is
invalid. Call Merchant Service Provider.
2 31 The FDC Merchant ID or Terminal ID is The merchant was incorrectly set up at
incorrect. Call Merchant Service the processor.
Provider.
3 32 This reason code is reserved or not
applicable to this API.
3 33 FIELD cannot be left blank. The word FIELD will be replaced by an
actual field name. This error indicates
that a field the merchant specified as
required was not filled in. See the Form
Fields section of the Merchant
Integration Guide for details.
2 34 The VITAL identification numbers are The merchant was incorrectly set up at
incorrect. Call Merchant Service the processor.
Provider.
2 35 An error occurred during processing. The merchant was incorrectly set up at
Call Merchant Service Provider. the processor.
3 36 The authorization was approved, but
settlement failed.
2 37 The credit card number is invalid.
2 38 The Global Payment System The merchant was incorrectly set up at
identification numbers are incorrect. the processor.
Call Merchant Service Provider.
3 40 This transaction must be encrypted.
2 41 This transaction has been declined. Only merchants set up for the
FraudScreen.Net service would
receive this decline. This code will be
returned if a given transaction’s fraud
score is higher than the threshold set
by the merchant.
3 43 The merchant was incorrectly set up at The merchant was incorrectly set up at
the processor. Call your Merchant the processor.
Service Provider.
2 44 This transaction has been declined. The card code submitted with the
transaction did not match the card
code on file at the card issuing bank
and the transaction was declined.


Code Reason
Code
2 45 This transaction has been declined. This error would be returned if the
transaction received a code from the
processor that matched the rejection
criteria set by the merchant for both the
AVS and Card Code filters.
3 46 Your session has expired or does not
exist. You must log in to continue
working.
3 47 The amount requested for settlement This occurs if the merchant tries to
may not be greater than the original capture funds greater than the amount
amount authorized. of the original authorization-only
transaction.
3 48 This processor does not accept partial The merchant attempted to settle for
reversals. less than the originally authorized
amount.
3 49 A transaction amount greater than The transaction amount submitted was
$[amount] will not be accepted. greater than the maximum amount
allowed.
3 50 This transaction is awaiting settlement Credits or refunds can only be
and cannot be refunded. performed against settled transactions.
The transaction against which the
credit/refund was submitted has not
been settled, so a credit cannot be
issued.
3 51 The sum of all credits against this
transaction is greater than the original
transaction amount.
3 52 The transaction was authorized, but
the client could not be notified; the
transaction will not be settled.
3 53 The transaction type was invalid for If x_method = ECHECK, x_type
ACH transactions. cannot be set to CAPTURE_ONLY.
3 54 The referenced transaction does not
meet the criteria for issuing a credit.
3 55 The sum of credits against the The transaction is rejected if the sum of
referenced transaction would exceed this credit and prior credits exceeds the
the original debit amount. original debit amount
3 56 This merchant accepts ACH The merchant processes eCheck.Net
transactions only; no credit card transactions only and does not accept
transactions are accepted. credit cards.
3 57 - 63 An error occurred in processing.


Code Reason
Code
2 65 This transaction has been declined. The transaction was declined because
the merchant configured their account
through the Merchant Interface to
reject transactions with certain values
for a Card Code mismatch.
3 66 This transaction cannot be accepted The transaction did not meet gateway
for processing. security guidelines.
3 68 The version parameter is invalid. The value submitted in x_version was
invalid.
3 69 The transaction type is invalid. The value submitted in x_type was
invalid.
3 70 The transaction method is invalid. The value submitted in x_method was
invalid.
3 71 The bank account type is invalid. The value submitted in x_bank_acct_
type was invalid.
3 72 The authorization code is invalid. The value submitted in x_auth_code
was more than six characters in length.
3 73 The driver’s license date of birth is The format of the value submitted in x_
invalid. drivers_license_dob was invalid.
3 74 The duty amount is invalid. The value submitted in x_duty failed
format validation.
3 75 The freight amount is invalid. The value submitted in x_freight failed
format validation.
3 76 The tax amount is invalid. The value submitted in x_tax failed
format validation.
3 77 The SSN or tax ID is invalid. The value submitted in x_customer_
tax_id failed validation.
3 78 The Card Code (CVV2/CVC2/CID) is The value submitted in x_card_code
invalid. failed format validation.
3 79 The driver’s license number is invalid. The value submitted in x_drivers_
license_num failed format validation.
3 80 The driver’s license state is invalid. The value submitted in x_drivers_
license_state failed format validation.
3 81 The requested form type is invalid. The merchant requested an integration
method not compatible with the AIM
API.
3 82 Scripts are only supported in version The system no longer supports version
2.5. 2.5; requests cannot be posted to
scripts.


Code Reason
Code
3 83 The requested script is either invalid or The system no longer supports version
no longer supported. 2.5; requests cannot be posted to
scripts.
3 91 Version 2.5 is no longer supported.
3 92 The gateway no longer supports the
requested method of integration.
3 97 This transaction cannot be accepted. Applicable only to SIM API.
Fingerprints are valid only for a short
period of time. If the fingerprint is more
than one hour old or more than 15
minutes into the future, it will be
rejected. This code indicates that the
transaction fingerprint has expired.
3 98 This transaction cannot be accepted. Applicable only to SIM API. The
transaction fingerprint has already
been used.
3 99 This transaction cannot be accepted. Applicable only to SIM API. The server-
generated fingerprint does not match
the merchant-specified fingerprint in
the x_fp_hash field.
3 100 The eCheck.Net type is invalid. Applicable only to eCheck.Net. The
value specified in the x_echeck_type
field is invalid.
3 101 The given name on the account and/or Applicable only to eCheck.Net. The
the account type does not match the specified name on the account and/or
actual account. the account type do not match the
NOC record for this account.


Code Reason
Code
3 102 This request cannot be accepted. A password or Transaction Key was
submitted with this WebLink request.
This is a high security risk.
3 103 This transaction cannot be accepted. A valid fingerprint, Transaction Key, or
password is required for this
transaction.
3 104 This transaction is currently under Applicable only to eCheck.Net. The
review. value submitted for country failed
validation.
review. values submitted for city and country
failed validation.
review. value submitted for company failed
validation.
review. value submitted for bank account
name failed validation.
review. values submitted for first name and last
review. values submitted for first name and last
review. value submitted for bank account
name does not contain valid
characters.
3 116 The authentication indicator is invalid. This error applies only to Verified by
Visa and MasterCard SecureCode
transactions. The ECI value for a Visa
transaction; or the UCAF indicator for a
MasterCard transaction submitted in
the x_authentication_indicator field
is invalid.
3 117 The cardholder authentication value is This error applies only to Verified by
invalid. Visa and MasterCard SecureCode
transactions. The CAVV for a Visa
transaction; or the AVV/UCAF for a
MasterCard transaction is invalid.


Code Reason
Code
3 118 The combination of authentication This error applies only to Verified by
indicator and cardholder authentication Visa and MasterCard SecureCode
value is invalid. transactions. The combination of
authentication indicator and cardholder
authentication value for a Visa or
MasterCard transaction is invalid. For
more information, see "Cardholder
Authentication," page 45.
3 119 Transactions having cardholder This error applies only to Verified by
authentication values cannot be Visa and MasterCard SecureCode
marked as recurring. transactions. Transactions submitted
with a value in x_authentication_
indicator and x_recurring_
billing=yes will be rejected.
3 120 An error occurred during processing. The system-generated void for the
Please try again. original timed-out transaction failed.
(The original transaction timed out
while waiting for a response from the
authorizer.)
Please try again. original errored transaction failed. (The
original transaction experienced a
database error.)
Please try again. original errored transaction failed. (The
original transaction experienced a
processing error.)
3 123 This account has not been given the The transaction request must include
permission(s) required for this request. the API Login ID associated with the
payment gateway account.
2 127 The transaction resulted in an AVS The system-generated void for the
mismatch. The address provided does original AVS-rejected transaction
not match billing address of cardholder. failed.
3 128 This transaction cannot be processed. The customer’s financial institution
does not currently allow transactions
for this account.
3 130 This payment gateway account has IFT: The payment gateway account
been closed. status is Blacklisted.
3 131 This transaction cannot be accepted at IFT: The payment gateway account
this time. status is Suspended-STA.
3 132 This transaction cannot be accepted at IFT: The payment gateway account
this time. status is Suspended-Blacklist.


Code Reason
Code
2 141 This transaction has been declined. The system-generated void for the
original FraudScreen-rejected
transaction failed.
original card code-rejected and AVS-
rejected transaction failed.
3 152 The transaction was authorized, but The system-generated void for the
the client could not be notified; the original transaction failed. The
transaction will not be settled. response for the original transaction
could not be communicated to the
client.
original card code-rejected transaction
failed.
3 170 An error occurred during processing. Concord EFS—Provisioning at the
Please contact the merchant. processor has not been completed.
2 171 An error occurred during processing. Concord EFS—This request is invalid.
Please contact the merchant.
2 172 An error occurred during processing. Concord EFS—The store ID is invalid.
Please contact the merchant.
3 173 An error occurred during processing. Concord EFS—The store key is
Please contact the merchant. invalid.
2 174 The transaction type is invalid. Please Concord EFS—This transaction type is
contact the merchant. not accepted by the processor.
3 175 The processor does not allow voiding Concord EFS—This transaction is not
of credits. allowed. The Concord EFS processing
platform does not support voiding
credit transactions. Debit the credit
card instead of voiding the credit.
3 180 An error occurred during processing. The processor response format is
Please try again. invalid.
Please try again. original invalid transaction failed. (The
original transaction included an invalid
processor response format.)
4 193 The transaction is currently under The transaction was placed under
review. review by the risk management
system.


Code Reason
Code
2 200 This transaction has been declined. This error code applies only to
merchants on FDC Omaha. The credit
card number is invalid.
merchants on FDC Omaha. The
expiration date is invalid.
transaction type is invalid.
merchants on FDC Omaha. The value
submitted in the amount field is invalid.
department code is invalid.
merchants on FDC Omaha. The value
submitted in the merchant number field
is invalid.
merchant is not on file.
merchant account is closed.
merchant is not on file.
merchants on FDC Omaha.
Communication with the processor
could not be established.
merchant type is incorrect.
cardholder is not on file.
merchants on FDC Omaha. The bank
configuration is not on file.


Code Reason
Code
merchant assessment code is
incorrect.
merchants on FDC Omaha. This
function is currently unavailable.
encrypted PIN field format is invalid.
merchants on FDC Omaha. The ATM
term ID is invalid.
transaction experienced a general
message format problem.
merchants on FDC Omaha. The PIN
block format or PIN availability value is
invalid.
merchants on FDC Omaha. The ETC
void is unmatched.
primary CPU is not available.
merchants on FDC Omaha. The SE
number is invalid.
merchants on FDC Omaha. Duplicate
auth request (from INAS).
transaction experienced an unspecified
error.
merchants on FDC Omaha. Re-enter
the transaction.


Code Reason
Code
3 243 Recurring billing is not allowed for this The combination of values submitted
eCheck.Net type. for x_recurring_billing and x_
echeck_type is not allowed.
3 244 This eCheck.Net type is not allowed for The combination of values submitted
this Bank Account Type. for x_bank_acct_type and x_echeck_
type is not allowed.
3 245 This eCheck.Net type is not allowed The value submitted for x_echeck_
when using the payment gateway type is not allowed when using the
hosted payment form. payment gateway hosted payment
form.
3 246 This eCheck.Net type is not allowed. The merchant’s payment gateway
account is not enabled to submit the
eCheck.Net type.
3 247 This eCheck.Net type is not allowed. The combination of values submitted
for x_type and x_echeck_type is not
allowed.
3 248 The check number is invalid. Invalid check number. Check number
is limited to15 alphanumeric
characters.
2 250 This transaction has been declined. This transaction was submitted from a
blocked IP address.
2 251 This transaction has been declined. The transaction was declined as a
result of triggering a Fraud Detection
Suite filter.
4 252 Your order has been received. Thank The transaction was accepted, but is
you for your business! being held for merchant review. The
merchant can customize the customer
response in the Merchant Interface.
4 253 Your order has been received. Thank The transaction was accepted and was
you for your business! authorized, but is being held for
merchant review. The merchant can
customize the customer response in
the Merchant Interface.
2 254 Your transaction has been declined. The transaction was declined after
manual review.
3 261 An error occurred during processing. The transaction experienced an error
Please try again. during sensitive data encryption and
was not processed. Try again.
3 270 The line item [item number] is invalid. A value submitted in x_line_item for
the item referenced is invalid.


Code Reason
Code
3 271 The number of line items submitted is The number of line items submitted
not allowed. A maximum of 30 line exceeds the allowed maximum of 30.
items can be submitted.
3 288 Merchant is not registered as a The merchant has not indicated
Cardholder Authentication participant. participation in any Cardholder
This transaction cannot be accepted. Authentication Programs in the
Merchant Interface.
3 289 This processor does not accept zero Your credit card processing service
dollar authorization for this card type. does not yet accept zero dollar
authorizations for Visa credit cards.
You can find your credit card processor
listed on your merchant profile.
3 290 One or more required AVS values for When submitting authorization
zero dollar authorization were not requests for Visa, you must enter the
submitted. address and zip code fields.
4 295 The amount of this request was only The merchant must have partial
partially approved on the given prepaid authorization enabled in the Merchant
card. Additional payments are required Interface in order to receive this error.
to complete the balance of this
transaction.
3 296 The specified Split Tender ID is not
valid.
3 297 A Transaction ID and a Split Tender ID
cannot both be used in a single
transaction request.
3 300 The device ID is invalid. The value submitted for x_device_id is
invalid.
3 301 The device batch ID is invalid. The value submitted for x_device_
batch_id is invalid.
3 302 The reversal flag is invalid. The value submitted for x_reversal is
invalid.
3 303 The device batch is full. Please close The current device batch must be
the batch. closed manually from the POS device.
3 304 The original transaction is in a closed The original transaction has been
batch. settled and cannot be reversed.
3 305 The merchant is configured for auto- This merchant is configured for auto-
close. close and cannot manually close
batches.
3 306 The batch is already closed. The batch is already closed.
1 307 The reversal was processed The reversal was processed
successfully. successfully.


Code Reason
Code
1 308 Original transaction for reversal not The transaction submitted for reversal
found. was not found.
3 309 The device has been disabled. The device has been disabled.
1 310 This transaction has already been This transaction has already been
voided. voided.
1 311 This transaction has already been This transaction has already been
captured captured.
2 315 The credit card number is invalid. This is a processor-issued decline.
2 316 The credit card expiration date is This is a processor-issued decline.
invalid.
2 317 The credit card has expired. This is a processor-issued decline.
2 318 A duplicate transaction has been This is a processor-issued decline.
submitted.
2 319 The transaction cannot be found. This is a processor-issued decline.
Email Receipt
Merchants can choose to send an email receipt generated by the payment gateway to
customers who provide an email address with their transaction. The email receipt includes
a summary and results of the transaction. To the customer, this email appears to be sent
from the merchant contact that is configured as the Email Sender in the Merchant
Interface.
To send the customer email receipt, submit the API fields that appear in the following
table, with the transaction request string. These settings can also be configured in the
Merchant Interface.
For more information about configuring these settings, see the Merchant Integration
Guide.
Fields are name/value pairs with this syntax:
x_name_of_field=value of the field

Table 22 Email Receipt Fields

x_email Value: The customer’s valid email address
Notes: The email address to which the customer’s copy of the email receipt is sent when
the Email Receipts option is configured in the Merchant Interface. The email is sent to
the customer only if the email address format is valid.
x_email_customer Value: The customer email receipt status
Notes: Indicates whether an email receipt should be sent to the customer.
If the x_email_customer field is set to TRUE, the payment gateway sends an email to
the customer after the transaction is processed using the customer email address
submitted with the transaction. If FALSE, no email is sent to the customer.
If no value is submitted, the payment gateway looks up the configuration in the Merchant
Interface and sends an email only if the merchant has enabled the setting. If this field is
not submitted and the setting is disabled in the Merchant Interface, no email is sent.
x_header_email_ Value: The email receipt header
receipt
Format: Plain text
Notes: This text appears as the header of the email receipt sent to the customer.
x_footer_email_receipt Value: The email receipt footer
Format: Plain text
Notes: This text appears as the footer on the email receipt sent to the customer.
x_merchant_email Value: Any valid email address
Only one email address per variable is allowed.
Notes: Email address to which the merchant’s copy of the customer confirmation email
should be sent. If a value is submitted, an email is sent to this address as well as to the
address(es) configured in the Merchant Interface.
Warning If it is included, it can subject the merchant to unsolicited email on their
business email address because it announces the location to which the receipt is
returned and hints at the location to which relay response or silent post information may
be sent.
In addition, the merchant can receive a transaction confirmation email from the payment
gateway at the completion of each transaction, which includes order information and the
results of the transaction. Merchants can sign up for confirmation emails in the Merchant
Interface. For more information, see the Merchant Integration Guide.

CHAPTER
Test Transactions
5
Test the payment gateway integration carefully before going live to ensure successful and
smooth transaction processing.
Ideally, you should test your integration in the following phases:
Phase 1: Testing in the test environment

In this environment, test transactions are posted to https://test.authorize.net/gateway/
transact.dll. Although this is a staging environment, its behavior mimics the live payment
gateway. Transactions submitted to the test environment using a developer test account
are not submitted to financial institutions for authorization and are not stored in the
Merchant Interface.
In order to use this environment, you must have an Authorize.Net developer test account
with an associated API Login ID and Transaction Key. Test transactions to this
environment are accepted with these credentials only. If you do not have a developer test
account, you can register one at http://developer.authorize.net/testaccount.
You do not need to use Test Mode when testing with a developer test account.
For more information about Test Mode, see the Merchant Integration Guide.
Note
Phase 2: Testing in the live environment

After you successfully test the integration in the developer test environment, you can
insert the merchant’s Authorize.Net Payment Gateway API Login ID and Transaction Key
into the integration for testing against the live environment. Developer test account
credentials are not accepted by the live payment gateway.
In this phase, you can test the integration in one of two ways:
 By including the x_test_request field with a value of TRUE in the transaction request
string sent to https://secure.authorize.net/gateway/transact.dll. See the example
below.

Chapter 5 Test Transactions
Example Submitting the Test Request Field

<INPUT TYPE="HIDDEN" NAME="x_test_request" VALUE="TRUE">
 By placing the merchant’s payment gateway account in Test Mode in the Merchant
Interface. New payment gateway accounts are placed in Test Mode by default. For
more information about Test Mode, see the Merchant Integration Guide. When you
process test transactions in Test Mode, the payment gateway returns a transaction ID
of 0. This means you cannot test follow-on transactions such as credits, voids, etc.,
while in Test Mode. To test follow-on transactions, you can either submit x_test_
request=TRUE as indicated above, or process a test transaction with any valid credit
card number in live mode, as explained below.
Transactions posted against live merchant accounts using either of the

above testing methods are not submitted to financial institutions for
Note authorization and are not stored in the Merchant Interface.
Phase 3
If testing in the live environment is successful, you are ready to submit live transactions
and verify that they are being submitted successfully. Either remove the x_test_request
field from the transaction request string, or set it to FALSE, or if you are using Test Mode,
turn it off in the Merchant Interface. To receive a true response, you must submit a
transaction using a real credit card number. You can use any valid credit card number to
submit a test transaction. You can void successful transactions immediately to prevent live
test transactions from being processed. This can be done quickly on the Unsettled
Transactions page of the Merchant Interface. It is recommended that when testing using a
live credit card, you use a nominal value, such as USD 0.01. Therefore, if you forget to
void the transaction, the impact is minimal. For VISA verification transactions, submit a
USD 0.00 value instead, if the processor accepts it.
Visa verification transactions are being switched from USD 0.01 to USD 0.00
for all processors. For Visa transactions using USD 0.00, the Bill To address
Note (x_address) and zip code (x_zip) fields are required.
Testing to Generate Specific

Transaction Results
When testing transaction results in the developer test environment as well as the
production environment, you can produce a specific response reason code by submitting
a test transaction that uses a test credit card number designed to generate specific
transaction results: this is Visa test credit card number 4222222222222. This card number
is intended for testing and should only be used for that purpose. Submit the test

Chapter 5 Test Transactions
transaction either by placing the account in Test Mode or by submitting x_test_

request=TRUE with a dollar amount equal to the response reason code you would like to
produce.
For example, to test AVS response reason code number 27, submit the test transaction
with the credit card number 4222222222222 and the amount 27.00.
To test the AVS or CCV responses in the live environment, submit live transactions with
the correct street address, ZIP code, and Card Code information to generate successful
responses, and incorrect street address, ZIP code, and Card Code information to
generate other responses. You can void successful transactions immediately to prevent
live test transactions from being processed. You can do it quickly on the Unsettled
Transactions page of the Merchant Interface. It is not possible to test the AVS or CCV
responses in the developer test environment. For more information about AVS, see the
Merchant Integration Guide.
For more information about response reason codes, see Chapter 4, "Transaction
Response," on page 49 of this guide.

APPENDIX
Fields by Transaction Type
A
This appendix provides a complete listing of all API fields that should be submitted for
each transaction type supported for AIM. It is divided into the following sections:
 The minimum fields that are required in order to submit a transaction.
 Additional fields that are required in order to configure advanced features of AIM.
 “Best practice” fields, or fields that the payment gateway recommends should be
submitted per transaction in order to maintain a strong connection to the payment
gateway—for example, to prevent possible conflicts if integration settings in the
Merchant Interface are inadvertently changed.
Minimum Required Fields

The following table provides a quick reference of all API fields that are required.
Table 23 Minimum Required Fields
Authorization Authorization Prior Capture Credit Void

and Capture Authorization Only
and Capture
Merchant x_login x_login x_login x_login x_login x_login
Information
x_tran_key x_tran_key x_tran_key x_tran_key x_tran_key x_tran_
key
Transaction x_type = AUTH_ x_type = x_type = PRIOR_ x_type = x_type = x_type =

Information CAPTURE AUTH_ONLY AUTH_ CREDIT VOID
CAPTURE_
CAPTURE ONLY x_trans_id x_trans_
id or
x_trans_id or x_ x_auth_code
split_tender_id x_split_
tender_
id
Payment x_amount x_amount x_amount x_amount x_amount N/A

Information
x_card_num x_card_num (required only x_card_num x_card_
when less than the num
x_exp_date x_exp_date x_exp_date
original
x_exp_
authorization date*
amount)
* The expiration date is required only for unlinked credits.

Appendix A Fields by Transaction Type
Required Fields for Additional AIM

Features
The following table provides a quick reference of additional fields that are required for
advanced features of AIM and that cannot be configured in the Merchant Interface. For
example, if the merchant wants to submit itemized order information, you must submit
fields in addition to the minimum required fields.
Table 24 Required Fields for Additional AIM Features

and Capture Only Authorization Only
and Capture
Itemized x_line_item x_line_item x_line_item x_line_item x_line_item N/A
Order * *
x_tax* x_tax x_tax x_tax* x_tax*
Information
x_freight* x_freight* x_freight* x_freight* x_freight*
* *
x_duty x_duty x_duty* x_duty* x_duty*
Cardholder x_authentication_ x_authentication_ N/A N/A N/A N/A
Authenticati indicator indicator
on x_cardholder_ x_cardholder_
authentication_ authentication_
value value
Advanced x_customer_ip x_customer_ip N/A N/A N/A N/A
Fraud (required only (required only
Detection when the merchant when the merchant
Suite (AFDS) is using customer- is using customer-
IP based AFDS IP based AFDS
filters) filters)
eCheck.Net x_delim_data = x_delim_data = x_delim_data = x_delim_data x_delim_ x_delim_

TRUE TRUE TRUE = TRUE data = data =
TRUE TRUE
x_relay_ x_relay_ x_relay_ x_relay_
response= response= response= response= x_relay_ x_relay_
FALSE FALSE FALSE FALSE response= response
FALSE =
FALSE
* These fields can support either a straight numeric value, or line item details similar to x_line_item.
For Prior Authorization and Capture transactions, if line item information was
submitted with the original transaction, adjusted information can be submitted if
Note the transaction changed. If no adjusted line item information is submitted, the
information submitted with the original transaction applies.

Appendix A Fields by Transaction Type
Best Practice Fields

The following table provides a quick reference of additional API fields that we recommend
should be submitted per transaction in order to maintain a strong connection.
Table 25 Best Practice Fields

and Capture Only Authorization Only
and Capture
Transaction x_version = 3.1 x_version = 3.1 x_version = 3.1 x_version = x_version x_version =
Information 3.1 = 3.1 3.1
Transaction x_delim_data = x_delim_data = x_delim_data = x_delim_ data x_delim_ x_delim_

Response TRUE TRUE TRUE = TRUE data = data =
x_delim_char x_delim_char x_delim_char x_delim_ char TRUE TRUE
x_delim_ x_delim_
x_encap_char x_encap_char x_encap_char x_encap_
char char char
x_relay_response x_relay_response = x_relay_response =
x_encap_ x_encap_
= FALSE* FALSE* FALSE* x_relay_
response = char char
FALSE* x_relay_ x_relay_
esponse = response =
FALSE* FALSE*
* The x_relay_response field is not technically an AIM feature; however, it is recommended that you submit this field per transaction
with the value of FALSE as a best practice to further define the AIM transaction format.

APPENDIX
API Fields
B
Table 26 Alphabetized List of API Fields

x_address Required only when using a European payment processor. If EVO is your payment
processor and you submit this field, other fields are required. See "Customer Information,"
page 40.
Value: The customer’s billing address.
Notes: Required if the merchant would like to use the Address Verification Service security
feature.
Required for Zero Dollar Authorizations for Visa verification transactions.
x_allow_partial_auth Optional
Value: True, False
Format: True, False, T, F
Notes: Set this value if the merchant would like to override a setting in the Merchant
Interface.
x_amount Required if x_type = AUTH_ CAPTURE, AUTH_ONLY, CAPTURE_ONLY, CREDIT
Value: The amount of the transaction.
Format: 15-digit maximum with a decimal point (no dollar symbol). For example, 8.95.
Notes: The total amount to be charged or credited including tax, shipping, and any other
charges. The amount can either be hard coded or posted to a script.
x_auth_code Required if x_type = CAPTURE_ONLY
Value: The authorization code for an original transaction not authorized on the payment
gateway.
Format: 6 characters.
Notes: Required only for CAPTURE_ONLY transactions. See "Credit Card Transaction
Types," page 25.

Appendix B API Fields
Table 26 Alphabetized List of API Fields (Continued)

x_authentication_ Optional
indicator
Value: The electronic commerce indicator (ECI) value for a Visa transaction; or the
universal cardholder authentication field indicator (UCAF) for a MasterCard transaction
obtained by the merchant after the authentication process.
Format: Special characters included in this value must be URL encoded.
Notes: Required only for AUTH_ONLY and AUTH_CAPTURE transactions processed
through cardholder authentication programs. When submitted with other transaction types,
this value is ignored.
This field is currently supported through Chase Paymentech, FDMS Nashville, Global
Payments, and TSYS.
x_card_code Optional
Value: The customer’s card code.
Format: Must be a valid CVV2, CVC2 or CID value.
Notes: The 3- or 4-digit number on the back of a credit card (on the front for American
Express).
This field is required if the merchant would like to use the Card Code Verification (CCV)
security feature.
x_card_num Required if x_type = AUTH_CAPTURE, AUTH_ONLY, CAPTURE_ONLY, CREDIT
Value: The customer’s credit card number.
When x_type=CREDIT, only the last four digits are required.
Format: 13 to 16 digits without spaces.
Notes: This is sensitive cardholder information and must be stored securely and in
accordance with the Payment Card Industry (PCI) Data Security Standard.
x_cardholder_ Optional
authentication_value Value: The cardholder authentication verification value (CAVV) for a Visa transaction; or
account holder authentication value (AVV)/ universal cardholder authentication field
(UCAF) for a MasterCard transaction obtained by the merchant after the authentication
process.
Format: Special characters included in this value must be URL encoded.
Notes: Required only for AUTH_ONLY and AUTH_CAPTURE transactions processed
through cardholder authentication programs. When submitted with other transaction types,
this value is ignored.
This field is currently supported through Chase Paymentech, FDMS Nashville, Global
Payments, and TSYS.
x_city Required only when using a European payment processor. If EVO is your payment
page 40.
Value: The city of the customer’s billing address.


x_company Optional
Value: The company associated with the customer’s billing address.
x_country Required only when using a European payment processor.
Value: The country of the customer’s billing address.
x_currency_code Optional
Value: USD, CAD, or GBP.
Format: 3-character string.
Notes: The default currency is selected by the merchant’s gateway and/or payment
processor.
x_cust_id Optional
Value: The merchant-assigned customer ID.
Notes: The unique identifier to represent the customer associated with the transaction.
The customer ID must be created dynamically on the merchant server or provided per
transaction. The payment gateway does not perform this function.
x_customer_ip Optional
Value: The customer’s IP address.
Format: 15-character maximum (no letters). For example, 255.255.255.255.
Notes: The IP address of the customer initiating the transaction. If this value is not passed,
it defaults to 255.255.255.255.
This field is required when using customer-IP-based Advanced Fraud Detection Suite
(AFDS) filters.


x_delim_char Optional
Value: The delimiting character; for example:
, (comma)
| (pipe)
“ (double quotes)
‘ (single quote)
: (colon)
; (semicolon)
/ (forward slash)
\ (back slash)
- (hyphen)
* (asterisk)
Notes: The character that is used to separate fields in the transaction response. The
payment gateway uses the character passed in this field or the value stored in the
Merchant Interface if no value is passed.
If this field is passed and the value is null, it overrides the value stored in the Merchant
Interface and the transaction response contains no delimiting character.
It is recommended that you submit this field per transaction to be sure that transaction
responses are returned in the correct format.
x_description Optional
Value: The transaction description.
Notes: The description must be created dynamically on the merchant server or provided
per transaction. The payment gateway does not perform this function.
x_device_type Value: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10
1 = Unknown
2 = Unattended Terminal
3 = Self Service Terminal
4 = Electronic Cash Register
5 = Personal Computer-Based Terminal
6 = AirPay
7 = Wireless POS
8 = Website
9 = Dial Terminal
10 = Virtual Terminal
Notes: The device type that is configured for your account.


x_duplicate_window Optional
Value: The period of time after the submission of a transaction during which a duplicate
transaction cannot be submitted.
Format: Any value between 0 and 28800 (no commas).
Notes: Indicates in seconds the period of time after a transaction is submitted during
which the payment gateway checks for a duplicate transaction. The maximum time
allowed is 8 hours (28800 seconds).
If a value less than 0 is sent, the payment gateway defaults to 0 seconds. If a value greater
than 28800 is sent, the payment gateway defaults to 28800. If no value is sent, the
payment gateway defaults to 2 minutes (120 seconds).
If this field is present in the request with or without a value, an enhanced duplicate
transaction response is sent. See "Response for Duplicate Transactions," page 56, for
more information.
x_duty Optional
Value: The valid duty amount OR delimited duty information.
Format: When you submit delimited duty information, values must be delimited by a
bracketed pipe <|>.
Notes: This field contains the duty amount charged OR when you submit this information
using the transaction request, delimited duty information including the duty name,
description, and amount is also allowed. The total amount of the transaction in x_amount
must include this amount.
Delimited duty information elements include:
 Duty item name<|>
 Duty description<|>
 Duty amount: The dollar sign ($) is not allowed when submitting delimited information.
The total amount of the transaction in x_amount must include this amount.
Example: x_duty=Duty1<|>export<|>15.00&
x_email Required only when using a European payment processor.
Value: The customer’s valid email address.
Notes: The email address to which the customer’s copy of the email receipt is sent when
the Email Receipts option is configured in the Merchant Interface. The email is sent to the
customer only if the email address format is valid.


x_email_customer Optional
Value: The customer email receipt status.
Notes: Indicates whether an email receipt should be sent to the customer.
If set to TRUE, the payment gateway sends an email to the customer after the transaction
is processed using the customer email address submitted with the transaction. If FALSE,
no email is sent to the customer.
If no value is submitted, the payment gateway looks up the configuration in the Merchant
Interface and sends an email only if the merchant has enabled the setting. If this field is not
submitted and the setting is disabled in the Merchant Interface, no email is sent.
x_employee_id Required only if your payment processor is EVO.
Value: Merchant-generated employee identifier. Used for retail transactions.
Format: Numeric, 4 digits.
x_encap_char Optional
Value: The encapsulating character
| (pipe)
“ (double quotes)
‘ (single quote)
: (colon)
; (semicolon)
/ (forward slash)
\ (back slash)
- (hyphen)
* (asterisk)
Notes: The character that is used to encapsulate the fields in the transaction response. It
is necessary only if it is possible that your delimiting character could be included in any
field values.
The payment gateway uses the character passed in this field or the value stored in the
Merchant Interface if no value is passed.
x_exp_date Required
Value: The customer’s credit card expiration date
Format: MMYY, MM/YY, MM-YY, MMYYYY, MM/YYYY, MM-YYYY
Notes: This is sensitive cardholder information and must be stored securely and in
accordance with the Payment Card Industry (PCI) Data Security Standard.
x_fax Optional
Value: The fax number associated with the customer’s billing address.
Format: 25-digit maximum (no letters). For example, (123) 123-1234.


x_first_name Required only when using a European payment processor. If EVO is your payment
page 40.
Value: The first name associated with the customer’s billing address.
x_footer_email_ Optional
receipt
Value: The email receipt footer.
Format: Plain text.
Notes: This text appears as the footer on the email receipt sent to the customer.
x_freight Optional
Value: The valid freight amount OR delimited freight information.
Format: When you submit delimited freight information, values must be delimited by a
bracketed pipe <|>.
Notes: The x_freight value is the freight amount charged OR when you submit this
information using the transaction request string, delimited freight information including the
freight name, description, and amount is also allowed. The total amount of the transaction
in the x_amount element must include this amount.
Delimited freight information elements include:
 Freight item name<|>
 Freight description<|>
 Freight amount: The freight item amount. The dollar sign ($) is not allowed when
submitting delimited information. The total amount of the transaction in the x_amount
element must include this amount.
Example: x_freight=Freight<|>ground overnight<|>12.95&
x_header_email_ Optional
receipt
Value: The email receipt header.
Format: Plain text.
Notes: This text will appear as the header of the email receipt sent to the customer.
x_invoice_num Optional
Value: The merchant assigned invoice number for the transaction.
Notes: The invoice number must be created dynamically on the merchant server or
provided per transaction. The payment gateway does not perform this function.
x_last_name Required only when using a European payment processor. If EVO is your payment
page 40.
Value: The last name associated with the customer’s billing address.


x_line_item Optional
All line item elements are required when this field is submitted. A maximum of 30 may be
submitted.
Value: Any string.
Format: Line item values must be delimited by a bracketed pipe <|> and must be listed in
the order shown below.
Notes: Itemized order information.
Delimited item information elements include:
 Item ID<|>: A maximum of 31 characters
 Item name<|>: A maximum of 31 characters
 Item description<|>: A maximum of 255 characters
 Item quantity<|>: A maximum of 2 decimal places
 Item price (per unit)<|>: A maximum of 2 decimal places. Must be a positive number.
The dollar sign ($) is not allowed when submitting delimited information. Excludes tax,
freight, and duty.
 Item taxable: Values can be TRUE, FALSE, T, F, YES, NO, Y, N, 1, 0
Example: x_line_item=item1<|>golf balls<|><|>2<|>18.95<|>Y
x_login Required
Value: The merchant’s unique API Login ID.
Notes: The merchant API Login ID is provided in the Merchant Interface.
The API Login ID and Transaction Key together provide the merchant authentication
required for access to the payment gateway.
x_market_type Optional
Value: One of the following:
 0 for e-commerce
 1 for moto
 2 for retail
Notes: If your account type is Card Present, the default is 2, and only 2 can be used. If
your account type is blended, the default is 0, but x_market_type can be overridden.


x_merchant_email Optional
Value: Any valid email address.
Only one email address per variable is allowed.
Notes: Email address to which the merchant’s copy of the customer confirmation email
should be sent. If a value is submitted, an email is sent to this address as well as the
address(es) configured in the Merchant Interface.
Warning If it is included, it can subject the merchant to unsolicited email on their
business email address because it announces the location to which the receipt is returned
and hints at the location to which relay response or silent post information may be sent.
x_method Optional
Value: The payment method.
Format: CC or ECHECK
Notes: The method of payment for the transaction, CC (credit card) or ECHECK
(electronic check). If left blank, this value defaults to CC.
x_phone Optional
Value: The phone number associated with the customer’s billing address.
x_po_num Required only if your processor is EVO and you submit Level 2 data.
Value: The merchant-assigned purchase order number.
Notes: The purchase order number must be created dynamically on the merchant server
or provided per transaction. The payment gateway does not perform this function.
x_recurring_billing Optional
Value: The recurring billing status.
Notes: Indicating marker used by merchant account providers to identify transactions that
originate from merchant hosted recurring billing applications. This value is not affiliated
with Automated Recurring Billing.
x_relay_response Optional
Value: The request for a relay response.
Notes: This field, when set to TRUE, instructs the payment gateway to return transaction
results to the merchant by means of an HTML form POST to the merchant’s web server for
a relay response.
Relay response is used for SIM applications. Set it to false if you are using AIM.
x_response_format Value: Set to 2. The 0 and 1 values are now deprecated.
Note: This field overrides the default response format.


x_ship_to_address Optional. If EVO is your payment processor and you submit this field, other fields are
required. See "Shipping Information," page 42.
Value: The customer’s shipping address.
x_ship_to_company Optional.
Value: The company associated with the customer’s shipping address.
x_ship_to_country Optional.
Value: The country of the customer’s shipping address.
x_ship_to_city Optional. If EVO is your payment processor and you submit this field, other fields are
Value: The city of the customer’s shipping address.
x_ship_to_first_name Optional. If EVO is your payment processor and you submit this field, other fields are
Value: The first name associated with the customer’s shipping address.
x_ship_to_last_name Optional. If EVO is your payment processor and you submit this field, other fields are
Value: The last name associated with the customer’s shipping address
x_ship_to_state Optional. If EVO is your payment processor and you submit this field, other fields are
Value: The state of the customer’s shipping address.
Format: 40-character maximum (no symbols) or a valid 2-character state code.
x_ship_to_zip Optional. If EVO is your payment processor and you submit this field, other fields are
Value: The ZIP code of the customer’s shipping address.
x_split_tender_id Optional
Value: The payment gateway-assigned ID that links the current authorization request to
the original authorization request.
Format: Numeric
Notes: This value is returned in the reply message from the original authorization request.
Transmit this value in subsequent transactions that are related to the same order.


x_state Required only when using a European payment processor. If EVO is your payment
page 40.
Value: The state of the customer’s billing address.
Format: 40-character maximum (no symbols) or a valid 2-character state code
x_tax Optional
Value: The valid tax amount OR the delimited tax information.
Format: When you submit delimited tax information, values must be delimited by a
bracketed pipe <|>
Notes: Contains the tax amount charged OR when you submit this information using the
transaction request string, delimited tax information including the sales tax name,
description, and amount is also allowed. The total amount of the transaction in the x_
amount element must include this amount.
Delimited tax information elements include:
 Tax item name<|>
 Tax description<|>
 Tax amount: The dollar sign ($) is not allowed when submitting delimited information.
The total amount of the transaction in the x_amount element must include this amount.
Example: x_tax=Tax1<|>state tax<|>0.09
x_tax_exempt Optional
Value: The tax exempt status
Notes: Indicates whether the transaction is tax exempt.
x_test_request Optional
Value: The request to process test transactions
Notes: Indicates if the transaction should be processed as a test transaction.
See Chapter 5, "Test Transactions," on page 74 of this guide for more information.
x_track1 Value: Valid Track 1 data.
Format: Starting and ending sentinel characters must be discarded before submitting
transations.
Notes: Required only if x_track2, x_card_num, and x_exp_date are absent. It is not
necessary to submit Track 1 and Track 2 data and x_card_num and x_exp_date. If both
tracks are sent by the POS application, the gateway uses the Track 1 information. If
neither Track 1 nor Track 2 data is submitted, but x_card_num and x_exp_date are
submitted, the Card Present transaction rate might be downgraded.
Note The payment processor EVO does not support Track 1 data.


x_track2 Value: Valid Track 2 data.
Format: Starting and ending sentinel characters must be discarded before submitting
transations.
Notes: Required only if x_track1, x_card_num, and x_exp_date are absent. It is not
necessary to submit Track 1 and Track 2 data and x_card_num and x_exp_date. If both
tracks are sent by the POS application, the gateway uses the Track 1 information.
If neither Track 1 nor Track 2 data is submitted, but x_card_num and x_exp_date are
submitted, the Card Present transaction rate might be downgraded.
x_tran_key Required for merchant authentication.
Value: The merchant’s unique Transaction Key.
Format: 16 characters.
Notes: The merchant Transaction Key is provided in the Merchant Interface and must be
stored securely.
The API Login ID and Transaction Key together provide the merchant authentication
required for access to the payment gateway.
x_trans_id Required when x_type = CREDIT, PRIOR_AUTH_CAPTURE, VOID
Value: The transaction ID assigned by the payment gateway of the original transaction.
Format: Numeric
Notes: Required only for CREDIT, PRIOR_AUTH_CAPTURE, and VOID transactions.
For more information about transaction types, see "Credit Card Transaction Types,"
page 25.
Do not include this field if you include the x_split_tender_id field.
x_type Optional
Value: The type of credit card transaction.
Format: AUTH_CAPTURE (default), AUTH_ONLY, CAPTURE_ONLY, CREDIT, PRIOR_
AUTH_CAPTURE, VOID
Notes: If the value submitted does not match a supported value, the transaction is
rejected. If this field is not submitted or the value is blank, the payment gateway processes
the transaction as an AUTH_CAPTURE.
x_version Optional, but highly recommended.
Value: The merchant’s transaction version.
Format: 3.0, 3.1
Notes: Indicates to the system the set of fields that will be included in the response:
3.0 is the default version.
3.1 allows the merchant to use partial authorizations and the Card Code feature and is the
current standard version.
It is highly recommended that you submit this field per transaction to ensure that the
formats of transaction requests and the responses you receive are consistent.


x_zip Required only when using a European payment processor. If EVO is your payment
page 40.
Value: The ZIP code of the customer’s billing address
Notes: Required if the merchant would like to use the Address Verification Service security
feature.
Required for Zero Dollar Authorizations for Visa verification transactions.

AIM Guide

Uploaded by

Document Informationclick to expand document information

Document Informationclick to expand document information

Copyright:

Available Formats

AIM Guide

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

AIM Guide

Uploaded by

Copyright:

Available Formats

Title Page

Advanced Integration Method (AIM)

Authorize.Net Developer Support

Recent Revisions to This Document 6

About This Guide 7

Chapter 2 Submitting Transactions 21

AIM Developer Guide | December 2015 3

Chapter 3 Transaction Data Requirements 33

Chapter 4 Transaction Response 49

AIM Developer Guide | December 2015 4

Chapter 5 Test Transactions 74

Appendix A Fields by Transaction Type 77

Appendix B API Fields 80

AIM Developer Guide | December 2015 5

AIM Developer Guide | December 2015 6

Audience and Purpose

Note, Important, and Warning Statements

A Note contains helpful suggestions or references to material not contained in

An Important statement contains information essential to successfully

AIM Developer Guide | December 2015 7

Text and Command ConventionsDeveloper

To submit suggestions for improving or correcting this guide, send email to

AIM Developer Guide | December 2015 8

AIM Minimum Requirements

AIM Developer Guide | December 2015 9

Payment Card Industry (PCI) Data

Managing Integration Settings

 Included in each transaction request using the application programming interface

AIM Developer Guide | December 2015 10

 Configured in the Merchant Interface and applied to all transactions.

The Authorize.Net Merchant Interface is a secure web site on which merchants

Transaction settings that are submitted in a transaction request override transaction

Table 1 Features of AIM

Features Description Requirements

AIM Developer Guide | December 2015 11

Table 1 Features of AIM (Continued)

Features Description Requirements

AIM Developer Guide | December 2015 12

PayPal Express Checkout

North American Payment Processors

Table 2 North American Payment Processors, Accepted Card Types,

Payment Processor Accepted Card Types Accepted Currencies

AIM Developer Guide | December 2015 13

Table 2 North American Payment Processors, Accepted Card Types,

Payment Processor Accepted Card Types Accepted Currencies

AIM Developer Guide | December 2015 14

European Payment Processors

Table 3 European Payment Processors, Accepted Card Types,

Payment Processor Accepted Card Types Accepted Currencies

Table 4 Asia-Pacific Payment Processor, Accepted Card Types,

Payment Processor Accepted Card Types Accepted Currencies

AIM Developer Guide | December 2015 15

Accepted Authorization/Settlement Currencies

Accepted Billing Currencies

Accepted Card Types

AIM Developer Guide | December 2015 16

EVOSnap Supported Services