AIMDG Authorizenet Aim Nvp Guide

User Manual:

Open the PDF directly: View PDF .
Page Count: 84

Download
Open PDF In Browser	View PDF

Title Page

Advanced Integration Method (AIM)
Developer Guide
Card Not Present Transactions

September 2014

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®

CONTENTS

Contents

Recent Revisions to This Document

About This Guide

Audience and Purpose

Conventions 7
Note, Important, and Warning Statements
Text and Command Conventions 8
Developer Support

Chapter 1

Introduction

AIM Minimum Requirements

Payment Card Industry (PCI) Data Security Standard
Managing Integration Settings
Features of AIM
eCheck.Net

PayPal Express Checkout

Payment Processors 13
North American Payment Processors
Accepted Card Types 13
Accepted Currencies 13
European Payment Processors 14
Asia-Pacific Processors 15
Software Development Kits

Chapter 2

Submitting Transactions

Minimum Field Requirements 17
Market Type Requirements 19
eCommerce 19
MOTO 19
Retail 19
Credit Card Transaction Types

AIM Developer Guide | September 2014

Contents

Authorization and Capture 20
Authorization Only 21
Prior Authorization and Capture 21
Capture Only 22
Credit (Refund) 22
Unlinked Credit 23
Void 23
Visa Verification Transactions 24
Partial Authorization Transactions 24
Using the Merchant Interface

Chapter 3

Transaction Data Requirements
Transaction Post Location

AIM Transaction Submission API 27
Merchant Information 28
Transaction Information 29
Order Information 32
Itemized Order Information 33
Customer Information 34
Shipping Information 36
Additional Shipping Information (Level 2 Data)
x_tax 37
x_freight 37
x_duty 38
x_tax_exempt 38
x_po_num 38
Cardholder Authentication 38
Merchant-Defined Fields 40

Chapter 4

Transaction Response

Fields in the Payment Gateway Response 44
Response for Duplicate Transactions 49
AIM Transaction Response Types 50
Version 3.0 50
Version 3.1 50
Configuring the Transaction Version
Response Code Details
Email Receipt

AIM Developer Guide | September 2014

Contents

Chapter 5

Test Transactions

Testing to Generate Specific Transaction Results

Appendix A Fields by Transaction Type
Minimum Required Fields

Required Fields for Additional AIM Features
Best Practice Fields

Appendix B API Fields

AIM Developer Guide | September 2014

REVISIONS

Recent Revisions to This
Document

Date

Revision

September 2014

Removed the x_delim_data field.
Added the following fields to "API Fields," page 73:


x_track1



x_track2



x_device_type

Added the section "Market Type Requirements," page 19.
August 2014

Added the x_response_format API field. See "Merchant Information,"
page 28.

February 2014

Added the x_market_type API field. See "Transaction Information,"
page 29.
Added a note recommending POST instead of GET. See "Transaction Post
Location," page 27.
Updated the “Developer Support” section. See "Developer Support," page 8.
Added a section on PayPal Express Checkout through AIM. See "PayPal
Express Checkout," page 13.

October 2013

Added AUD and NZD to x_currency_code, page 30.
Updated the tables in the section "Payment Processors," page 13.

May 2013

Added EUR to x_currency_code, page 30.
Updated the tables in the section "Payment Processors," page 13.

AIM Developer Guide | September 2014

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

Warning

A Warning contains information or instructions, which, if not heeded, can result
in a security risk, irreversible loss of data, or significant cost in time or revenue
or both.

AIM Developer Guide | September 2014

About This Guide

Text and Command Conventions
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.

monospace



Placeholder variables for which you supply particular values.



XML elements.



Code examples and samples.



Text that you enter in an API environment; for example:
Set the davService_run field to true.

Developer Support
Resources are available to 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.

AIM Developer Guide | September 2014

CHAPTER

Introduction

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

A 128-bit Secure Sockets Layer (SSL) connection between the merchant’s web server
and the Authorize.Net Payment Gateway ensures the security of AIM transactions.

Note

For merchants who prefer a payment solution that collects, transmits, and
stores cardholder data, Authorize.Net recommends the Server Integration
Method (SIM). For more information, see the Server Integration Method (SIM)
Developer Guide.
SIM does not require merchants to purchase and install an SSL 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 must have a valid Secure Sockets Layer (SSL) certificate, and their
web site must be capable of initiating both client- and server-side SSL connections.



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.

AIM Developer Guide | September 2014

Chapter 1



Introduction

The merchant must be able to securely store payment gateway account data, such as
their API Login ID or Transaction Key.

Payment Card Industry (PCI) Data
Security Standard

Important

Note

Using AIM involves transmitting sensitive cardholder data using the merchant’s
web server. Therefore, if the merchant stores cardholder information, it must be
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
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.

Note

The Authorize.Net Merchant Interface is a secure web site on which merchants
can manage their payment gateway account settings, including their web site
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

AIM Developer Guide | September 2014

Chapter 1

Introduction

Merchant Interface and the settings that can be posted per transaction. See Appendix A,
"Fields by Transaction Type," on page 70 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
(AVS) Filter

Enables merchants to compare the
billing address submitted by the
customer for the transaction with the
address on file at the card issuing
bank. Filter settings in the Merchant
Interface enable the merchant to
reject transactions based on the
AVS response received.

To implement AVS, the merchant must
require the Address and ZIP Code fields
on their custom payment form.

Enables merchants to compare the
card code submitted by the
customer for the transaction with the
card code on file at the card-issuing
bank. Filter settings in the Merchant
Interface enable the merchant to
reject transactions based on the
CCV response received.

To implement CCV, the merchant must
require the card code on their custom
payment form.

Enables merchants to submit details
for items purchased. This
information is included in the
customer’s confirmation email, in
the Transaction Details for the
transaction, and in QuickBooks
download reports in the Merchant
Interface.

To implement Itemized Order
Information, the line item field must be
submitted for each transaction.

Card Code Verification (CCV)
Filter

Itemized Order Information

AIM Developer Guide | September 2014

For more information about AVS, see
the Merchant Integration Guide.

For more information about CCV, see
the Merchant Integration Guide.

See "Itemized Order Information,"
page 33, for details.

Chapter 1

Table 1

Introduction

Features of AIM (Continued)

Features

Description

Requirements

Email Receipt

Enables merchants to have the
payment gateway send an
automatic email receipt to their
customers.

To configure the payment gateway
email receipt, merchants must require
the customer email addresses on their
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 65, 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.

AIM Developer Guide | September 2014

Chapter 1

Introduction

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
Accepted Card Types
All North American payment processors supported by Authorize.Net accept the following
card types:


American Express



Diners Club



Discover



JCB



Mastercard



Visa

Accepted Currencies
Table 2

North American Payment Processors
and Accepted Currencies

Payment Processor

Accepted Currencies

Chase Paymentech Tampa Processing Platform

United States Dollar (USD)
Canadian Dollar (CAD)

Elavon

United States Dollar (USD)
Canadian Dollar (CAD)

First Data Merchant Services (FDMS) Omaha,
Nashville, and EFSNet processing platforms

AIM Developer Guide | September 2014

United States Dollar (USD)

Chapter 1

Table 2

Introduction

North American Payment Processors
and Accepted Currencies (Continued)

Payment Processor

Accepted Currencies

Global Payments

United States Dollar (USD)
Canadian Dollar (CAD)

Heartland Payment Systems

United States Dollar (USD)

TSYS Acquiring Solutions

United States Dollar (USD)

WorldPay Atlanta processing platform

United States Dollar (USD)

European Payment Processors
Authorize.Net supports the following European payment processors.
Table 3

European Payment Processors, Accepted Card Types, and Accepted Currencies

Payment Processor

Accepted Card Types

Accepted Currencies

AIB Merchant Services



Mastercard

British Pounds (GBP)



Visa

Euro (EUR)
United States Dollar (USD)

Barclaycard

First Data Merchant Solutions (MSIP platform)

HSBC Merchant Services

Lloyds Bank Cardnet

Streamline

AIM Developer Guide | September 2014



JCB

British Pounds (GBP)



Mastercard

Euro (EUR)



Visa



Mastercard



Visa



Mastercard

British Pounds (GBP)



Visa

Euro (EUR)



Mastercard

British Pounds (GBP)



Visa



JCB

British Pounds (GBP)



Mastercard

Euro (EUR)



Visa

United States Dollar (USD)

British Pounds (GBP)

Chapter 1

Introduction

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, and Accepted Currencies

Payment Processor

Accepted Card Types

Accepted Currencies

FDI Australia



Mastercard

Australian Dollar (AUD)



Visa

New Zealand Dollar (NZD)
United States Dollar (USD)

Westpac



Mastercard



Visa

Australian Dollar (AUD)

For information on setting the currency using the AIM API, see x_currency_code, page 30.

Software Development Kits
Authorize.Net offers software development kits (SDKs) that present an alternate objectoriented 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/

AIM Developer Guide | September 2014

CHAPTER

Submitting Transactions

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 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.

Important

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
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

AIM Developer Guide | September 2014

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 5

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.
See the Merchant Integration Guide for more information.

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.

AIM Developer Guide | September 2014

Chapter 2

Table 5

Submitting Transactions

Minimum AIM Fields (Continued)

Field Name

Description

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 20.

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 24.

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 20.

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.

AIM Developer Guide | September 2014

Chapter 2

Table 5

Submitting Transactions

Minimum AIM Fields (Continued)

Field Name

Description

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 42 for more about
delimited responses.

European payment processors require additional fields. For more information,
see "Customer Information," page 34.
Note

Market Type Requirements
Certain fields are required depending on the market type set in the x_market_type field.

eCommerce
The following fields are required when the market type is eCommerce:


x_market_type = 0



x_card_num



x_exp_date

MOTO
The following fields are required when the market type is MOTO:


x_market_type = 1



x_card_num



x_exp_date

Retail
The following fields are required when the market type is Retail:


x_market_type = 2



x_device_type

AIM Developer Guide | September 2014

Chapter 2

Submitting Transactions

Plus the following:
x_track1 or x_track2



or


x_card_num and x_exp_date

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.

Note

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
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 70.

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

AIM Developer Guide | September 2014

Chapter 2

Submitting Transactions

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.

Note

An Authorization Only and a Prior Authorization and Capture together are
considered one complete transaction. After the Prior Authorization and Capture
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

AIM Developer Guide | September 2014

Chapter 2

Submitting Transactions

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:


The transaction is submitted with the valid transaction ID (x_trans_id) of an original,
successfully settled transaction.



The amount being requested for refund is less than or equal to the original settled
amount.



The sum 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.

AIM Developer Guide | September 2014

Chapter 2

Submitting Transactions

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.

Important

A transaction ID must not be submitted with an Unlinked Credit. If ECC is
enabled for the merchant’s account, and a transaction ID is submitted with the
Unlinked Credit transaction, 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.

Note

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
likely settled, and you can submit a Credit for the transaction.

The payment gateway accepts Voids if the following conditions are met:


The transaction is submitted with the valid transaction ID (x_trans_id) of an original,
successfully authorized transaction. To void an entire order, submit the split tender ID
(x_split_tender_id).

AIM Developer Guide | September 2014

Chapter 2



Submitting Transactions

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

Note

Typically, Authorization Only or Authorization and Capture are the primary
transaction types submitted by an e-commerce web site or other
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.

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= 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.

AIM Developer Guide | September 2014

Chapter 2

Submitting Transactions

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 6

Unique Field Requirements for Partial Authorization
Transactions

Field

Request or
Response

Description

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.

AIM Developer Guide | September 2014

Chapter 2

Table 6

Submitting Transactions

Unique Field Requirements for Partial Authorization
Transactions (Continued)

Field

Request or
Response

Description

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.

AIM Developer Guide | September 2014

CHAPTER

Transaction Data
Requirements

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://secure.authorize.net/gateway/transact.dll

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/
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.

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

AIM Developer Guide | September 2014

Chapter 3

Transaction Data Requirements

Merchant Information
Table 7

Merchant Information

Field Name

Description

x_login

Required
Value: The merchant’s unique API Login ID.
Format: 20-character maximum.
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.
See the Merchant Integration Guide for more information.

x_tran_key

Required
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.
See the Merchant Integration Guide for more information.

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 24.

x_response_format

Value: Set to 2. The 0 and 1 values are now deprecated.
Note: This field overrides the default response format.

AIM Developer Guide | September 2014

Chapter 3

Transaction Data Requirements

Transaction Information
Table 8

Transaction Information

Field Name

Description

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 70.

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.

AIM Developer Guide | September 2014

Chapter 3

Table 8

Transaction Data Requirements

Transaction Information (Continued)

Field Name

Description

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: If this field is not submitted, the default is the currency
selected by the merchant’s payment processor. Setting this field
to a currency that is not supported by the payment processor
results in an error.

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
Industry (PCI) Data Security Standard.
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, MMYYYY

AIM Developer Guide | September 2014

Chapter 3

Table 8

Transaction Data Requirements

Transaction Information (Continued)

Field Name

Description

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 20.

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 24.

x_auth_code

Conditional
Required only for CAPTURE_ ONLY transactions.
Value: The authorization code of an original transaction not
authorized on the payment gateway
Format: 6 characters
Notes: See "Credit Card Transaction Types," page 20”

AIM Developer Guide | September 2014

Chapter 3

Table 8

Transaction Data Requirements

Transaction Information (Continued)

Field Name

Description

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 67 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 49.

Order Information
Table 9

Order Information

Field Name

Description

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.
Format: 255-character maximum (no symbols).
Notes: The description must be created dynamically on the merchant
server or provided per transaction. The payment gateway does not
perform this function.

AIM Developer Guide | September 2014

Chapter 3

Transaction Data Requirements

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 10

Delimited x_line_item Information

Item Information
Elements

Description

Item ID<|>

Required
Value: The ID assigned to an item.
Format: 31-character maximum

Item Name<|>

Required
Value: The name of an item.
Format: 31-character maximum

Item Description<|>

Optional
Value: A detailed description of an item.
Format: 255-character maximum

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 two 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.
Format: TRUE, FALSE, T, F, YES, NO, Y, N, 1, 0

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.

AIM Developer Guide | September 2014

Chapter 3

Example

Transaction Data Requirements

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

Note

For Prior Authorization and Capture transactions, if line item information was
submitted with the original transaction, adjusted information can be submitted if
the transaction changed. If no adjusted line item information is submitted, the
information submitted with the original transaction applies.

Customer Information
Table 11

Customer Information

Field Name

Description

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
Format: 50-character maximum (no symbols)

x_company

Optional
Value: The company associated with the customer’s billing address
Format: 50-character maximum (no symbols)

x_address

Required only when using a European payment processor.
Value: The customer’s billing address
Format: 60-character maximum (no symbols)
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
Format: 40-character maximum (no symbols)

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

AIM Developer Guide | September 2014

Chapter 3

Table 11

Transaction Data Requirements

Customer Information (Continued)

Field Name

Description

x_zip

Required only when using a European payment processor.
Value: The ZIP code of the customer’s billing address
Format: 20-character maximum (no symbols)
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
Format: 60-character maximum (no symbols)

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
Format: 25-digit maximum (no letters). For example, (123)123-1234

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
Format: 20-character maximum (no symbols)
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.

AIM Developer Guide | September 2014

Chapter 3

Table 11

Transaction Data Requirements

Customer Information (Continued)

Field Name

Description

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.

Shipping Information
Table 12

Shipping Information

Field Name

Description

x_ship_to_first_name

Optional
Value: The first name associated with the customer’s shipping
address
Format: 50-character maximum (no symbols)

x_ship_to_last_name

Optional
Value: The last name associated with the customer’s shipping
address
Format: 50-character maximum (no symbols)

x_ship_to_company

Optional
Value: The company associated with the customer’s shipping
address
Format: 50-character maximum (no symbols)

x_ship_to_address

Optional
Value: The customer’s shipping address
Format: 60-character maximum (no symbols)

x_ship_to_city

Optional
Value: The city of the customer’s shipping address
Format: 40-character maximum (no symbols)

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

AIM Developer Guide | September 2014

Chapter 3

Table 12

Transaction Data Requirements

Shipping Information (Continued)

Field Name

Description

x_ship_to_zip

Optional
Value: The ZIP code of the customer’s shipping address
Format: 20-character maximum (no symbols)

x_ship_to_country

Optional
Value: The country of the customer’s shipping address
Format: 60-character maximum (no symbols)

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:

AIM Developer Guide | September 2014

Chapter 3

Transaction Data Requirements



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.

Cardholder Authentication
The payment gateway supports the transmission of authentication fields for the following
cardholder authentication programs:


Verified by Visa

AIM Developer Guide | September 2014

Chapter 3



Transaction Data Requirements

MasterCard SecureCode

Merchants using a third-party cardholder authentication solution can submit the following
authentication values with Visa and/or MasterCard transactions.

Note

Table 13

The cardholder authentication fields are currently supported only through the
Chase Paymentech, FDMS Nashville, Global Payments, and TSYS
processors for Visa and MasterCard transactions. Cardholder authentication
information submitted for transactions processed through any other processor
is ignored.

Cardholder Authentication Fields

Field Name

Description

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.

AIM Developer Guide | September 2014

Chapter 3

Transaction Data Requirements

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 14

Valid Value Combinations for Verified by Visa Fields

Authentication
Indicator

Cardholder Authentication Value

Not null

Null/Blank

Not null (some international issuers can provide a CAVV value when
ECI is 7)

Null/Blank

Table 15

Valid Value Combinations for MasterCard SecureCode Fields

Authentication
Indicator

Cardholder Authentication Value

Blank/Null

Not 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 must be null. In this scenario,
if a value is submitted for the x_cardholder_authentication_value field, the transaction
fails validation and is rejected.
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

AIM Developer Guide | September 2014

Chapter 3

Transaction Data Requirements

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 merchantdefined fields.
Note

Warning

Merchant-defined data fields are not intended to and must not be used to
capture personally identifying information. Accordingly, the merchant is
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, stateissued 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.

AIM Developer Guide | September 2014

CHAPTER

Transaction Response

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&

AIM Developer Guide | September 2014

Chapter 4

Table 16

Transaction Response

Response Request Fields

Field Name

Description

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.

AIM Developer Guide | September 2014

Chapter 4

Transaction Response

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 17

Payment Gateway Response Fields

Order

Field Name

Description

Response Code

Value: The overall status of the transaction
Format:


1 = Approved



2 = Declined



3 = Error



4 = Held for review

Response
Subcode

Value: A code used by the payment gateway for internal
transaction tracking

Response
Reason Code

Value: A code that represents more details about the result of
the transaction
Format: Numeric
Notes: See "Response Code Details," page 51, for a listing of
response reason codes.

Response
Reason Text

Value: A brief description of the result that corresponds with the
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 51, to identify any specific texts you do not
want to pass to the customer.

Authorization
Code

AIM Developer Guide | September 2014

Value: The authorization or approval code
Format: 6 characters

Chapter 4

Table 17

Transaction Response

Payment Gateway Response Fields (Continued)

Order

Field Name

Description

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.

Invoice Number

Value: The merchant-assigned invoice number for the
transaction
Format: 20-character maximum (no symbols)

Description

Value: The transaction description
Format: 255-character maximum (no symbols)

Amount

Value: The amount of the transaction
Format: 15-digit maximum

Method

Value: The payment method
CC or ECHECK

Transaction Type

Value: The type of credit card transaction
Format: AUTH_CAPTURE, AUTH_ONLY, CAPTURE_ONLY,
CREDIT, PRIOR_AUTH_CAPTUREVOID

AIM Developer Guide | September 2014

Chapter 4

Table 17

Transaction Response

Payment Gateway Response Fields (Continued)

Order

Field Name

Description

Customer ID

Value: The merchant-assigned customer ID
Format: 20-character maximum (no symbols)

First Name

Value: The first name associated with the customer’s billing
address
Format: 50-character maximum (no symbols)

Last Name

Value: The last name associated with the customer’s billing
address
Format: 50-character maximum (no symbols)

Company

Value: The company associated with the customer’s billing
address
Format: 50-character maximum (no symbols)

Address

Value: The customer’s billing address
Format: 60-character maximum (no symbols)

City

Value: The city of the customer’s billing address
Format: 40-character maximum (no symbols)

State

Value: The state of the customer’s billing address
Format: 40-character maximum (no symbols) or a valid
2-character state code

ZIP Code

Value: The ZIP code of the customer’s billing address
Format: 20-character maximum (no symbols)

Country

Value: The country of the customer’s billing address
Format: 60-character maximum (no symbols)

Phone

Value: The phone number associated with the customer’s billing
address
Format: 25-character maximum (no letters). For example,
(123)123-1234

Fax

Value: The fax number associated with the customer’s billing
address
Format: 25-digit maximum (no letters). For example, (123)1231234

Email Address

Value: The customer’s valid email address
Format: 255-character maximum

Ship To First
Name

Value: The first name associated with the customer’s shipping
address
Format: 50-character maximum (no symbols)

Ship To Last
Name

Value: The last name associated with the customer’s shipping
address
Format: 50-character maximum (no symbols)

AIM Developer Guide | September 2014

Chapter 4

Table 17

Transaction Response

Payment Gateway Response Fields (Continued)

Order

Field Name

Description

Ship To
Company

Value: The company associated with the customer’s shipping
address
Format: 50-character maximum (no symbols)

Ship To Address

Value: The customer’s shipping address
Format: 60-character maximum (no symbols)

Ship To City

Value: The city of the customer’s shipping address
Format: 40-character maximum (no symbols)

Ship To State

Value: The state of the customer’s shipping address
Format: 40-character maximum (no symbols) or a valid 2character state code

Ship To ZIP
Code

Value: The ZIP code of the customer’s shipping address

Ship To Country

Value: The country of the customer’s shipping address

Format: 20-character maximum (no symbols)

Format: 60-character maximum (no symbols)
33

Tax

Value: The tax amount charged
Format: Numeric
Notes: Delimited tax information is not included in the
transaction response.

Duty

Value: The duty amount charged
Format: Numeric
Notes: Delimited duty information is not included in the
transaction response.

Freight

Value: The freight amount charged
Format: Numeric
Notes: Delimited freight information is not included in the
transaction response.

Tax Exempt

Value: The tax exempt status
Format: TRUE, FALSE, T, F, YES, NO, Y, N, 1, 0

Purchase Order
Number

Value: The merchant-assigned purchase order number

MD5 Hash

Value: The payment gateway-generated MD5 hash value that
can be used to authenticate the transaction response.

Format: 25-character maximum (no symbols)

Notes: Optional. Transaction responses are returned using SSL/
TLS, so this field is useful mainly as a redundant security check.

AIM Developer Guide | September 2014

Chapter 4

Table 17

Transaction Response

Payment Gateway Response Fields (Continued)

Order

Field Name

Description

Card Code
Response

Value: The card code verification (CCV) response code
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
Authentication
Verification
Response

Account Number

Value: The cardholder authentication verification response code
Format: Blank or not present = CAVV not validated


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

Value: Last 4 digits of the card provided
Format: Alphanumeric (XXXX6835)
Notes: This field is returned with all transactions.

Card Type

Value: Visa, MasterCard, American Express, Discover, Diners
Club, JCB
Format: Text

AIM Developer Guide | September 2014

Chapter 4

Table 17

Transaction Response

Payment Gateway Response Fields (Continued)

Order

Field Name

Description

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.

Requested
Amount

Value: Amount requested in the original authorization
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.

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

AIM Developer Guide | September 2014

Chapter 4

Transaction Response

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-definedfield_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.

AIM Developer Guide | September 2014

Chapter 4

Example 6

Transaction Response

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.

AIM Developer Guide | September 2014

Chapter 4



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 18

Table 19

Transaction Response

Response Codes

Response
Code

Description

This transaction has been approved.

This transaction has been declined.

There has been an error processing this transaction.

This transaction is being held for review.

Response Reason Code Text

Response
Code

Response
Reason
Code

Response Reason Text

This transaction has been approved.

This transaction has been declined.

The code returned from the processor
indicating that the card used needs to
be picked up.

A valid amount is required.

The value submitted in the amount field
did not pass validation for a number.

The credit card number is invalid.

The credit card expiration date is
invalid.

The credit card has expired.

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.

The account number is invalid.

The value submitted in the x_bank_
acct_num field did not pass validation.

AIM Developer Guide | September 2014

Notes

The format of the date submitted was
incorrect.

Chapter 4

Table 19

Transaction Response

Response Reason Code Text (Continued)

Response
Code

Response
Reason
Code

Response Reason Text

Notes

A duplicate transaction has been
submitted.

A transaction with identical amount and
credit card information was submitted
two minutes prior.

An authorization code is required but
not present.

A transaction that required x_auth_
code to be present was submitted
without a value.

The merchant API Login ID is invalid or
the account is inactive.

The Referrer or Relay Response URL
is invalid.

The Relay Response or Referrer URL
does not match the merchant’s
configured value(s) or is absent.
Applicable only to SIM and WebLink
APIs.

The transaction ID is invalid.

The transaction ID value is nonnumeric or was not present for a
transaction that requires it (i.e., VOID,
PRIOR_AUTH_CAPTURE, and
CREDIT).

The transaction was not found.

The transaction ID sent in was properly
formatted but the gateway had no
record of the transaction.

The merchant does not accept this
type of credit card.

The merchant was not configured to
accept the credit card submitted in the
transaction.

ACH transactions are not accepted by
this merchant.

The merchant does not accept
electronic checks.

19 - 23

An error occurred during processing.
Please try again in 5 minutes.

The Nova Bank Number or Terminal ID
is incorrect. Call Merchant Service
Provider.

25 - 26

An error occurred during processing.
Please try again in 5 minutes.

The transaction resulted in an AVS
mismatch. The address provided does
not match billing address of cardholder.

The merchant does not accept this
type of credit card.

The Paymentech identification
numbers are incorrect. Call Merchant
Service Provider.

AIM Developer Guide | September 2014

The Merchant ID at the processor was
not configured to accept this card type.

Chapter 4

Table 19

Transaction Response

Response Reason Code Text (Continued)

Response
Code

Response
Reason
Code

Response Reason Text

The configuration with the processor is
invalid. Call Merchant Service Provider.

The FDC Merchant ID or Terminal ID is
incorrect. Call Merchant Service
Provider.

This reason code is reserved or not
applicable to this API.

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.

The VITAL identification numbers are
incorrect. Call Merchant Service
Provider.

The merchant was incorrectly set up at
the processor.

An error occurred during processing.
Call Merchant Service Provider.

The merchant was incorrectly set up at
the processor.

The authorization was approved, but
settlement failed.

The credit card number is invalid.

The Global Payment System
identification numbers are incorrect.
Call Merchant Service Provider.

This transaction must be encrypted.

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.

The merchant was incorrectly set up at
the processor. Call your Merchant
Service Provider.

The merchant was incorrectly set up at
the processor.

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.

AIM Developer Guide | September 2014

Notes

The merchant was incorrectly set up at
the processor.

Chapter 4

Table 19

Transaction Response

Response Reason Code Text (Continued)

Response
Code

Response
Reason
Code

Response Reason Text

Notes

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.

Your session has expired or does not
exist. You must log in to continue
working.

The amount requested for settlement
may not be greater than the original
amount authorized.

This occurs if the merchant tries to
capture funds greater than the amount
of the original authorization-only
transaction.

This processor does not accept partial
reversals.

The merchant attempted to settle for
less than the originally authorized
amount.

A transaction amount greater than
$[amount] will not be accepted.

The transaction amount submitted was
greater than the maximum amount
allowed.

This transaction is awaiting settlement
and cannot be refunded.

Credits or refunds can only be
performed against settled transactions.
The transaction against which the
credit/refund was submitted has not
been settled, so a credit cannot be
issued.

The sum of all credits against this
transaction is greater than the original
transaction amount.

The transaction was authorized, but
the client could not be notified; the
transaction will not be settled.

The transaction type was invalid for
ACH transactions.

The referenced transaction does not
meet the criteria for issuing a credit.

The sum of credits against the
referenced transaction would exceed
the original debit amount.

The transaction is rejected if the sum of
this credit and prior credits exceeds the
original debit amount

This merchant accepts ACH
transactions only; no credit card
transactions are accepted.

The merchant processes eCheck.Net
transactions only and does not accept
credit cards.

57 - 63

An error occurred in processing.
Please try again in 5 minutes.

AIM Developer Guide | September 2014

If x_method = ECHECK, x_type
cannot be set to CAPTURE_ONLY.

Chapter 4

Table 19

Transaction Response

Response Reason Code Text (Continued)

Response
Code

Response
Reason
Code

Response Reason Text

Notes

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.

This transaction cannot be accepted
for processing.

The transaction did not meet gateway
security guidelines.

The version parameter is invalid.

The value submitted in x_version was
invalid.

The transaction type is invalid.

The value submitted in x_type was
invalid.

The transaction method is invalid.

The value submitted in x_method was
invalid.

The bank account type is invalid.

The value submitted in x_bank_acct_
type was invalid.

The authorization code is invalid.

The value submitted in x_auth_code
was more than six characters in length.

The driver’s license date of birth is
invalid.

The format of the value submitted in x_
drivers_license_dob was invalid.

The duty amount is invalid.

The value submitted in x_duty failed
format validation.

The freight amount is invalid.

The value submitted in x_freight failed
format validation.

The tax amount is invalid.

The value submitted in x_tax failed
format validation.

The SSN or tax ID is invalid.

The value submitted in x_customer_
tax_id failed validation.

The Card Code (CVV2/CVC2/CID) is
invalid.

The value submitted in x_card_code
failed format validation.

The driver’s license number is invalid.

The value submitted in x_drivers_
license_num failed format validation.

The driver’s license state is invalid.

The value submitted in x_drivers_
license_state failed format validation.

The requested form type is invalid.

The merchant requested an integration
method not compatible with the AIM
API.

Scripts are only supported in version
2.5.

The system no longer supports version
2.5; requests cannot be posted to
scripts.

AIM Developer Guide | September 2014

Chapter 4

Table 19

Transaction Response

Response Reason Code Text (Continued)

Response
Code

Response
Reason
Code

Response Reason Text

Notes

The requested script is either invalid or
no longer supported.

The system no longer supports version
2.5; requests cannot be posted to
scripts.

This reason code is reserved or not
applicable to this API.

Version 2.5 is no longer supported.

The gateway no longer supports the
requested method of integration.

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.

This transaction cannot be accepted.

Applicable only to SIM API. The
transaction fingerprint has already
been used.

This transaction cannot be accepted.

Applicable only to SIM API. The servergenerated fingerprint does not match
the merchant-specified fingerprint in
the x_fp_hash field.

100

The eCheck.Net type is invalid.

Applicable only to eCheck.Net. The
value specified in the x_echeck_type
field is invalid.

101

The given name on the account and/or
the account type does not match the
actual account.

Applicable only to eCheck.Net. The
specified name on the account and/or
the account type do not match the
NOC record for this account.

AIM Developer Guide | September 2014

Chapter 4

Table 19

Transaction Response

Response Reason Code Text (Continued)

Response
Code

Response
Reason
Code

Response Reason Text

Notes

102

This request cannot be accepted.

A password or Transaction Key was
submitted with this WebLink request.
This is a high security risk.

103

This transaction cannot be accepted.

A valid fingerprint, Transaction Key, or
password is required for this
transaction.

104

This transaction is currently under
review.

Applicable only to eCheck.Net. The
value submitted for country failed
validation.

105

This transaction is currently under
review.

Applicable only to eCheck.Net. The
values submitted for city and country
failed validation.

106

This transaction is currently under
review.

Applicable only to eCheck.Net. The
value submitted for company failed
validation.

107

This transaction is currently under
review.

Applicable only to eCheck.Net. The
value submitted for bank account
name failed validation.

108

This transaction is currently under
review.

Applicable only to eCheck.Net. The
values submitted for first name and last
name failed validation.

109

This transaction is currently under
review.

Applicable only to eCheck.Net. The
values submitted for first name and last
name failed validation.

110

This transaction is currently under
review.

Applicable only to eCheck.Net. The
value submitted for bank account
name does not contain valid
characters.

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.

117

The cardholder authentication value is
invalid.

This error applies only to Verified by
Visa and MasterCard SecureCode
transactions. The CAVV for a Visa
transaction; or the AVV/UCAF for a
MasterCard transaction is invalid.

AIM Developer Guide | September 2014

Chapter 4

Table 19

Transaction Response

Response Reason Code Text (Continued)

Response
Code

Response
Reason
Code

Response Reason Text

Notes

118

The combination of authentication
indicator and cardholder authentication
value is invalid.

This error applies only to Verified by
Visa and MasterCard SecureCode
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 38.

119

Transactions having cardholder
authentication values cannot be
marked as recurring.

This error applies only to Verified by
Visa and MasterCard SecureCode
transactions. Transactions submitted
with a value in x_authentication_
indicator and x_recurring_
billing=yes will be rejected.

120

An error occurred during processing.
Please try again.

The system-generated void for the
original timed-out transaction failed.
(The original transaction timed out
while waiting for a response from the
authorizer.)

121

An error occurred during processing.
Please try again.

The system-generated void for the
original errored transaction failed. (The
original transaction experienced a
database error.)

122

An error occurred during processing.
Please try again.

The system-generated void for the
original errored transaction failed. (The
original transaction experienced a
processing error.)

123

This account has not been given the
permission(s) required for this request.

The transaction request must include
the API Login ID associated with the
payment gateway account.

127

The transaction resulted in an AVS
mismatch. The address provided does
not match billing address of cardholder.

The system-generated void for the
original AVS-rejected transaction
failed.

128

This transaction cannot be processed.

The customer’s financial institution
does not currently allow transactions
for this account.

130

This payment gateway account has
been closed.

IFT: The payment gateway account
status is Blacklisted.

131

This transaction cannot be accepted at
this time.

IFT: The payment gateway account
status is Suspended-STA.

132

This transaction cannot be accepted at
this time.

IFT: The payment gateway account
status is Suspended-Blacklist.

AIM Developer Guide | September 2014

Chapter 4

Table 19

Transaction Response

Response Reason Code Text (Continued)

Response
Code

Response
Reason
Code

Response Reason Text

Notes

141

This transaction has been declined.

The system-generated void for the
original FraudScreen-rejected
transaction failed.

145

This transaction has been declined.

The system-generated void for the
original card code-rejected and AVSrejected transaction failed.

152

The transaction was authorized, but
the client could not be notified; the
transaction will not be settled.

The system-generated void for the
original transaction failed. The
response for the original transaction
could not be communicated to the
client.

165

This transaction has been declined.

The system-generated void for the
original card code-rejected transaction
failed.

170

An error occurred during processing.
Please contact the merchant.

Concord EFS—Provisioning at the
processor has not been completed.

171

An error occurred during processing.
Please contact the merchant.

Concord EFS—This request is invalid.

172

An error occurred during processing.
Please contact the merchant.

Concord EFS—The store ID is invalid.

173

An error occurred during processing.
Please contact the merchant.

Concord EFS—The store key is
invalid.

174

The transaction type is invalid. Please
contact the merchant.

Concord EFS—This transaction type is
not accepted by the processor.

175

The processor does not allow voiding
of credits.

Concord EFS—This transaction is not
allowed. The Concord EFS processing
platform does not support voiding
credit transactions. Debit the credit
card instead of voiding the credit.

180

An error occurred during processing.
Please try again.

The processor response format is
invalid.

181

An error occurred during processing.
Please try again.

The system-generated void for the
original invalid transaction failed. (The
original transaction included an invalid
processor response format.)

185

This reason code is reserved or not
applicable to this API.

193

The transaction is currently under
review.

AIM Developer Guide | September 2014

The transaction was placed under
review by the risk management
system.

Chapter 4

Table 19

Transaction Response

Response Reason Code Text (Continued)

Response
Code

Response
Reason
Code

Response Reason Text

Notes

200

This transaction has been declined.

This error code applies only to
merchants on FDC Omaha. The credit
card number is invalid.

201

This transaction has been declined.

This error code applies only to
merchants on FDC Omaha. The
expiration date is invalid.

202

This transaction has been declined.

This error code applies only to
merchants on FDC Omaha. The
transaction type is invalid.

203

This transaction has been declined.

This error code applies only to
merchants on FDC Omaha. The value
submitted in the amount field is invalid.

204

This transaction has been declined.

This error code applies only to
merchants on FDC Omaha. The
department code is invalid.

205

This transaction has been declined.

This error code applies only to
merchants on FDC Omaha. The value
submitted in the merchant number field
is invalid.

206

This transaction has been declined.

This error code applies only to
merchants on FDC Omaha. The
merchant is not on file.

207

This transaction has been declined.

This error code applies only to
merchants on FDC Omaha. The
merchant account is closed.

208

This transaction has been declined.

This error code applies only to
merchants on FDC Omaha. The
merchant is not on file.

209

This transaction has been declined.

This error code applies only to
merchants on FDC Omaha.
Communication with the processor
could not be established.

210

This transaction has been declined.

This error code applies only to
merchants on FDC Omaha. The
merchant type is incorrect.

211

This transaction has been declined.

This error code applies only to
merchants on FDC Omaha. The
cardholder is not on file.

212

This transaction has been declined.

This error code applies only to
merchants on FDC Omaha. The bank
configuration is not on file.

AIM Developer Guide | September 2014

Chapter 4

Table 19

Transaction Response

Response Reason Code Text (Continued)

Response
Code

Response
Reason
Code

Response Reason Text

Notes

213

This transaction has been declined.

This error code applies only to
merchants on FDC Omaha. The
merchant assessment code is
incorrect.

214

This transaction has been declined.

This error code applies only to
merchants on FDC Omaha. This
function is currently unavailable.

215

This transaction has been declined.

This error code applies only to
merchants on FDC Omaha. The
encrypted PIN field format is invalid.

216

This transaction has been declined.

This error code applies only to
merchants on FDC Omaha. The ATM
term ID is invalid.

217

This transaction has been declined.

This error code applies only to
merchants on FDC Omaha. This
transaction experienced a general
message format problem.

218

This transaction has been declined.

This error code applies only to
merchants on FDC Omaha. The PIN
block format or PIN availability value is
invalid.

219

This transaction has been declined.

This error code applies only to
merchants on FDC Omaha. The ETC
void is unmatched.

220

This transaction has been declined.

This error code applies only to
merchants on FDC Omaha. The
primary CPU is not available.

221

This transaction has been declined.

This error code applies only to
merchants on FDC Omaha. The SE
number is invalid.

222

This transaction has been declined.

This error code applies only to
merchants on FDC Omaha. Duplicate
auth request (from INAS).

223

This transaction has been declined.

This error code applies only to
merchants on FDC Omaha. This
transaction experienced an unspecified
error.

224

This transaction has been declined.

This error code applies only to
merchants on FDC Omaha. Re-enter
the transaction.

AIM Developer Guide | September 2014

Chapter 4

Table 19

Transaction Response

Response Reason Code Text (Continued)

Response
Code

Response
Reason
Code

Response Reason Text

Notes

243

Recurring billing is not allowed for this
eCheck.Net type.

The combination of values submitted
for x_recurring_billing and x_
echeck_type is not allowed.

244

This eCheck.Net type is not allowed for
this Bank Account Type.

The combination of values submitted
for x_bank_acct_type and x_echeck_
type is not allowed.

245

This eCheck.Net type is not allowed
when using the payment gateway
hosted payment form.

The value submitted for x_echeck_
type is not allowed when using the
payment gateway hosted payment
form.

246

This eCheck.Net type is not allowed.

The merchant’s payment gateway
account is not enabled to submit the
eCheck.Net type.

247

This eCheck.Net type is not allowed.

The combination of values submitted
for x_type and x_echeck_type is not
allowed.

248

The check number is invalid.

Invalid check number. Check number
is limited to15 alphanumeric
characters.

250

This transaction has been declined.

This transaction was submitted from a
blocked IP address.

251

This transaction has been declined.

The transaction was declined as a
result of triggering a Fraud Detection
Suite filter.

252

Your order has been received. Thank
you for your business!

The transaction was accepted, but is
being held for merchant review. The
merchant can customize the customer
response in the Merchant Interface.

253

Your order has been received. Thank
you for your business!

The transaction was accepted and was
authorized, but is being held for
merchant review. The merchant can
customize the customer response in
the Merchant Interface.

254

Your transaction has been declined.

The transaction was declined after
manual review.

261

An error occurred during processing.
Please try again.

The transaction experienced an error
during sensitive data encryption and
was not processed. Try again.

270

The line item [item number] is invalid.

A value submitted in x_line_item for
the item referenced is invalid.

AIM Developer Guide | September 2014

Chapter 4

Table 19

Transaction Response

Response Reason Code Text (Continued)

Response
Code

Response
Reason
Code

Response Reason Text

Notes

271

The number of line items submitted is
not allowed. A maximum of 30 line
items can be submitted.

The number of line items submitted
exceeds the allowed maximum of 30.

288

Merchant is not registered as a
Cardholder Authentication participant.
This transaction cannot be accepted.

The merchant has not indicated
participation in any Cardholder
Authentication Programs in the
Merchant Interface.

289

This processor does not accept zero
dollar authorization for this card type.

Your credit card processing service
does not yet accept zero dollar
authorizations for Visa credit cards.
You can find your credit card processor
listed on your merchant profile.

290

One or more required AVS values for
zero dollar authorization were not
submitted.

When submitting authorization
requests for Visa, you must enter the
address and zip code fields.

295

The amount of this request was only
partially approved on the given prepaid
card. Additional payments are required
to complete the balance of this
transaction.

The merchant must have partial
authorization enabled in the Merchant
Interface in order to receive this error.

296

The specified Split Tender ID is not
valid.

297

A Transaction ID and a Split Tender ID
cannot both be used in a single
transaction request.

300

The device ID is invalid.

The value submitted for x_device_id is
invalid.

301

The device batch ID is invalid.

The value submitted for x_device_
batch_id is invalid.

302

The reversal flag is invalid.

The value submitted for x_reversal is
invalid.

303

The device batch is full. Please close
the batch.

The current device batch must be
closed manually from the POS device.

304

The original transaction is in a closed
batch.

The original transaction has been
settled and cannot be reversed.

305

The merchant is configured for autoclose.

This merchant is configured for autoclose and cannot manually close
batches.

306

The batch is already closed.

307

The reversal was processed
successfully.

AIM Developer Guide | September 2014

Chapter 4

Table 19

Transaction Response

Response Reason Code Text (Continued)

Response
Code

Response
Reason
Code

Response Reason Text

Notes

308

Original transaction for reversal not
found.

The transaction submitted for reversal
was not found.

309

The device has been disabled.

310

This transaction has already been
voided.

311

This transaction has already been
captured

This transaction has already been
captured.

315

The credit card number is invalid.

This is a processor-issued decline.

316

The credit card expiration date is
invalid.

This is a processor-issued decline.

317

The credit card has expired.

This is a processor-issued decline.

318

A duplicate transaction has been
submitted.

This is a processor-issued decline.

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

AIM Developer Guide | September 2014

Chapter 4

Table 20

Transaction Response

Email Receipt Fields

Field Name

Description

x_email

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.

x_email_customer

Value: The customer email receipt status
Format: TRUE, FALSE, T, F, YES, NO, Y, N, 1, 0
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_
receipt

Value: The email receipt header
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
Format: 255-character maximum
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 spam 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.

AIM Developer Guide | September 2014

CHAPTER

Test Transactions

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.

AIM Developer Guide | September 2014

Chapter 5

Example

Test Transactions

Submitting the Test Request Field



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.

Note

Transactions posted against live merchant accounts using either of the
above testing methods are not submitted to financial institutions for
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.

Note

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
(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

AIM Developer Guide | September 2014

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 42 of this guide.

AIM Developer Guide | September 2014

APPENDIX

Fields by Transaction Type

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 for each
transaction type supported for AIM.
Table 21

Minimum Required Fields
Authorization
and Capture

Authorization

Prior
Authorization
and Capture

Capture
Only

Credit

Void

Merchant
Information

x_login

x_tran_key

x_tran_
key

Transaction
Information

x_type = AUTH_
CAPTURE

x_type =
AUTH_ONLY

x_type = PRIOR_
AUTH_

x_type =

x_type =
CREDIT

x_type =
VOID

x_trans_id

x_trans_
id or

CAPTURE

Payment
Information

CAPTURE_
ONLY

x_trans_id or x_
split_tender_id

x_auth_code

x_split_
tender_
id

x_amount

x_card_num

x_card_num
x_exp_date

(required only
when less than the
original
authorization
amount)

x_card_num

x_exp_date

x_card_
num

AIM Developer Guide | September 2014

x_exp_date

N/A

x_exp_
date*

Appendix A

Table 21

Fields by Transaction Type

Minimum Required Fields (Continued)
Authorization
and Capture

Authorization

Prior
Authorization
and Capture

Capture
Only

Credit

Void

* The expiration date is required only for unlinked credits.

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 22

Required Fields for Additional AIM Features

Itemized
Order
Information

Authorization
and Capture

Authorization
Only

Prior
Authorization
and Capture

Capture
Only

Credit

Void

x_line_item

N/A

x_tax*

x_tax

x_freight*

x_duty*

Cardholder
Authenticati
on

x_authentication_
indicator

N/A

x_cardholder_
authentication_
value

Advanced
Fraud
Detection
Suite (AFDS)

x_customer_ip

N/A

(required only
when the merchant
is using customerIP based AFDS
filters)

eCheck.Net

x_delim_data =
TRUE

x_delim_data
= TRUE

x_relay_
response=
FALSE

x_delim_
data =
TRUE

x_relay_
response=
FALSE

x_relay_
response
=
FALSE

x_tax

* These fields can support either a straight numeric value, or line item details similar to x_line_item.

AIM Developer Guide | September 2014

Appendix A

Note

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 23

Best Practice Fields
Authorization
and Capture

Authorization
Only

Prior
Authorization
and Capture

Transaction
Information

x_version = 3.1

Transaction
Response

x_delim_data =
TRUE

Capture
Only

Credit

Void

x_version = 3.1

x_version =
3.1

x_delim_data =
TRUE

x_delim_ data
= TRUE

x_delim_char

x_delim_ char

x_delim_char

x_delim_ char

x_encap_char

x_relay_
response =
FALSE*

x_encap_
char

x_encap_char

x_relay_
response =
FALSE*

x_encap_
char

x_relay_
response =
FALSE*

x_relay_
esponse =
FALSE*

x_relay_
response =
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.

AIM Developer Guide | September 2014

APPENDIX

API Fields

Table 24

Alphabetized List of API Fields

Field Name

Description

x_address

Required only when using a European payment processor.
Value: The customer’s billing address.
Format: 60-character maximum (no symbols) .
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 20.

AIM Developer Guide | September 2014

Appendix B

Table 24

API Fields

Alphabetized List of API Fields (Continued)

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_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.
Value: The city of the customer’s billing address.
Format: 40-character maximum (no symbols).

x_company

Optional
Value: The company associated with the customer’s billing address.
Format: 50-character maximum (no symbols).

AIM Developer Guide | September 2014

Appendix B

Table 24

API Fields

Alphabetized List of API Fields (Continued)

x_country

Required only when using a European payment processor.
Value: The country of the customer’s billing address.
Format: 60-character maximum (no symbols).

x_currency_code

Optional
Value: USD, CAD, or GBP.
Format: 3-character string.
Notes: If this field is not submitted, the default is the currency selected by the merchant’s
payment processor. Setting this field to a currency that is not supported by the payment
processor results in an error.

x_cust_id

Optional
Value: The merchant-assigned customer ID.
Format: 20-character maximum (no symbols).
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.

AIM Developer Guide | September 2014

Appendix B

Table 24

API Fields

Alphabetized List of API Fields (Continued)

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.
Format: 255-character maximum (no symbols).
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.

AIM Developer Guide | September 2014

Appendix B

Table 24

API Fields

Alphabetized List of API Fields (Continued)

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 49, 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 submitting 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.
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.

AIM Developer Guide | September 2014

Appendix B

Table 24

API Fields

Alphabetized List of API Fields (Continued)

x_email_customer

Optional
Value: The customer email receipt status.
Format: TRUE, FALSE, T, F, YES, NO, Y, N, 1, 0
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_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.
Value: The first name associated with the customer’s billing address.
Format: 50-character maximum (no symbols).

x_footer_email_
receipt

Optional
Value: The email receipt footer.
Format: Plain text.
Notes: This text appears as the footer on the email receipt sent to the customer.

AIM Developer Guide | September 2014

Appendix B

Table 24

API Fields

Alphabetized List of API Fields (Continued)

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_
receipt

Optional
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.
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_last_name

Required only when using a European payment processor.
Value: The last name associated with the customer’s billing address.
Format: 50-character maximum (no symbols).

AIM Developer Guide | September 2014

Appendix B

Table 24

API Fields

Alphabetized List of API Fields (Continued)

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.
Format: 20-character maximum.
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.

AIM Developer Guide | September 2014

Appendix B

Table 24

API Fields

Alphabetized List of API Fields (Continued)

x_merchant_email

Optional
Value: Any valid email address.
Format: 255-character maximum.
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.
If included, it can subject the merchant to spam on their business email address because it
announces where the receipt gets returned to and gives a hint where 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.
Format: 25-digit maximum (no letters). For example, (123)123-1234

x_po_num

Optional
Value: The merchant-assigned purchase order number.
Format: 25-character maximum (no symbols).
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.
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_relay_response

Optional
Value: The request for a relay response.
Format: TRUE, FALSE, T, F, YES, NO, Y, N, 1, 0
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.

AIM Developer Guide | September 2014

Appendix B

Table 24

API Fields

Alphabetized List of API Fields (Continued)

x_ship_to_address

Optional
Value: The customer’s shipping address.
Format: 60-character maximum (no symbols).

x_ship_to_company

Optional
Value: The company associated with the customer’s shipping address.
Format: 50-character maximum (no symbols).

x_ship_to_country

Optional
Value: The country of the customer’s shipping address.
Format: 60-character maximum (no symbols).

x_ship_to_city

Optional
Value: The city of the customer’s shipping address.
Format: 40-character maximum (no symbols).

x_ship_to_first_name

Optional
Value: The first name associated with the customer’s shipping address.
Format: 50-character maximum (no symbols).

x_ship_to_last_name

Optional
Value: The last name associated with the customer’s shipping address
Format: 50-character maximum (no symbols)

x_ship_to_state

Optional
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
Value: The ZIP code of the customer’s shipping address.
Format: 20-character maximum (no symbols).

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.
Value: The state of the customer’s billing address.
Format: 40-character maximum (no symbols) or a valid 2-character state code

AIM Developer Guide | September 2014

Appendix B

Table 24

API Fields

Alphabetized List of API Fields (Continued)

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
Format: TRUE, FALSE, T, F, YES, NO, Y, N, 1, 0
Notes: Indicates whether the transaction is tax exempt.

x_test_request

Optional
Value: The request to process test transactions
Format: TRUE, FALSE, T, F, YES, NO, Y, N, 1, 0
Notes: Indicates if the transaction should be processed as a test transaction.
See Chapter 5, "Test Transactions," on page 67 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.

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.

AIM Developer Guide | September 2014

Appendix B

Table 24
x_tran_key

API Fields

Alphabetized List of API Fields (Continued)
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 20.
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.
Value: The ZIP code of the customer’s billing address
Format: 20-character maximum (no symbols)
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 Developer Guide | September 2014

Source Exif Data:

File Type                       : PDF
File Type Extension             : pdf
MIME Type                       : application/pdf
PDF Version                     : 1.6
Linearized                      : Yes
Author                          : scopelan
Create Date                     : 2014:09:26 15:04:50Z
Modify Date                     : 2014:09:26 15:05:30-07:00
Language                        : en
XMP Toolkit                     : Adobe XMP Core 5.2-c001 63.139439, 2010/10/03-12:08:50
Producer                        : Acrobat Distiller 10.0.0 (Windows)
Creator Tool                    : FrameMaker 10.0.2
Metadata Date                   : 2014:09:26 15:05:30-07:00
Format                          : application/pdf
Title                           : AIMDG.book
Creator                         : scopelan
Document ID                     : uuid:d3ece8a7-faa6-46e2-837f-437db0843255
Instance ID                     : uuid:ed6452f3-b86c-41be-8783-b0965fd09207
Page Mode                       : UseOutlines
Page Count                      : 84

EXIF Metadata provided by EXIF.tools

AIMDG Authorizenet Aim Nvp Guide

Navigation menu

Versions of this User Manual:

Views

Navigation