Customer Information Manager (CIM) Soap Guide Authorize.Net CIM

User Manual: Pdf

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

Download
Open PDF In Browser	View PDF

Merchant Web Services API
Customer Information Manager (CIM)
SOAP Guide

Authorize.Net Developer Support
http://developer.authorize.net

Authorize.Net LLC 082007 Ver.1.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 do not 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™
Authorize.Net Where the World Transacts®
Automated Recurring Billing™
eCheck.Net®
FraudScreen.Net®

Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

Table of Contents
Revision History ................................................................................. 5
Section 1 Developer Introduction...................................................... 6
Integration Methods.........................................................................................................6
Standard API .............................................................................................................................. 6
Hosted Option API ..................................................................................................................... 6

Minimum Requirements ..................................................................................................7
Developer Support ..........................................................................................................7
Software Development Kits .............................................................................................8

Section 2 Using the Hosted CIM Option............................................ 9
Designing Your Web Page ........................................................................................................ 9

Implementing a Redirect to Authorize.Net .....................................................................10
Example of a redirect to the hosted page: ........................................................................... 11

Implementing an iframe popup ......................................................................................11
Add payment ........................................................................................................................ 12
Edit payment ........................................................................................................................ 13
Add shipping ........................................................................................................................ 14
Edit shipping ......................................................................................................................... 15
Manage payment and shipping ............................................................................................ 16

Guidelines for Settings Parameters ...............................................................................17

Section 3 Executing an API Call ...................................................... 18
Web Service Locations ..................................................................................................18
CIM Functions ...............................................................................................................18
Field Validation and Test Mode .............................................................................................. 20
Authentication .......................................................................................................................... 20
Input Parameters for CreateCustomerProfile ....................................................................... 21
Input Parameters for CreateCustomerPaymentProfile ........................................................ 27
Input Parameters for CreateCustomerShippingAddress..................................................... 30
Input Parameters for CreateCustomerProfileTransaction ................................................... 31
For Authorization Only transactions ..................................................................................... 32
For Authorization and Capture Transactions ....................................................................... 36
Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

For Capture Only Transactions ............................................................................................ 40
For Prior Authorization and Capture Transactions .............................................................. 45
For Refund Transactions ..................................................................................................... 49
For a Void Transaction ......................................................................................................... 54
Input Parameters for DeleteCustomerProfile ........................................................................ 56
Input Parameters for DeleteCustomerPaymentProfile......................................................... 56
Input Parameters for DeleteCustomerShippingAddress ..................................................... 56
Input Parameters for GetCustomerProfileIds ....................................................................... 57
Input Parameters for GetCustomerProfile ............................................................................ 57
Input Parameters for GetCustomerPaymentProfile ............................................................. 58
Input Parameters for GetCustomerShippingAddress .......................................................... 58
Input Parameters for getHostedProfilePage ......................................................................... 59
Example ............................................................................................................................... 59
Input Parameters for UpdateCustomerProfile ...................................................................... 60
Input Parameters for UpdateCustomerPaymentProfile ....................................................... 61
Input Parameters for UpdateCustomerShippingAddress.................................................... 66
Input Elements for UpdateSplitTenderGroup ....................................................................... 67
Input Parameters for ValidateCustomerPaymentProfile...................................................... 68

Section 4 Responses........................................................................ 70
CIM Responses .............................................................................................................70
Output for CreateCustomerProfileResponse ........................................................................ 71
Output for CreateCustomerPaymentProfileResponse......................................................... 72
Output for CreateCustomerShippingAddressResponse ..................................................... 72
Output for CreateCustomerProfileTransactionResponse ................................................... 73
Output for DeleteCustomerProfileResponse ........................................................................ 73
Output for DeleteCustomerPaymentProfileResponse ......................................................... 74
Output for DeleteCustomerShippingAddressResponse ..................................................... 74
Output for GetCustomerProfileIdsResponse ........................................................................ 74
Output for GetCustomerProfileResponse ............................................................................. 75
Output for GetCustomerPaymentProfileResponse .............................................................. 78
Output for GetCustomerShippingAddressResponse .......................................................... 81
Output for getHostedProfilePage ........................................................................................... 82
Output for UpdateCustomerProfileResponse ....................................................................... 82
Output for UpdateCustomerPaymentProfileResponse........................................................ 83
Output for UpdateCustomerShippingAddressResponse .................................................... 83
Output for UpdateSplitTenderGroup ..................................................................................... 83
Last revised: 5/24/2011
Copyright © 1998 - 2007 Authorize.Net Corp.

Table of Contents

Output for ValidateCustomerPaymentProfileResponse ...................................................... 84

Duplicate Profile Verification..........................................................................................84
Response Codes ...........................................................................................................85

Index ................................................................................................. 87

Last revised: 5/24/2011
Copyright © 1998 - 2007 Authorize.Net Corp.

Revision History
PUBLISH DATE

UPDATES

November 2007

Initial release of the Customer Information Manager (CIM) API

September 2008

Removal of SecureSource requirements

January 2009

Addition of GetCustomerProfileIds and various updates

May 2009

Specify validationMode parameter as required for CreateCustomerProfile and
UpdateCustomerPaymentProfile.
Clarify usage of validationMode parameter for CustomerProfileRequest and
CreateCustomerProfile calls when no payment profile information is included.

June 2009

Corrected formatting notes for some numeric fields
Added note about optional fields and .NET programming

September 2009

Update validationMode field to document changes for authorizations for Visa
transactions

April 2010

Update to table of error codes
Added explanatory guidelines for createCustomerProfileTransaction for Refund
transactions.

June 2010

Changes required for Partial Authorization processing

July 2010

Correct function name (UpdateSplitTenderGroup) and add output

May 2011

Add hosted option
Clarification of validationMode

Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

Section 1
Developer Introduction
This guide describes the Web development required to create and manage customer profile
information for the purpose of submitting transactions to the Authorize.Net Payment Gateway
directly from a Web site or other application using Simple Object Access Protocol (SOAP).
SOAP provides a standards-based mechanism to access Web services from a wide range of
platforms. Typically, clients access the Web services using a SOAP client on their respective
programming environment. The SOAP client typically generates the native objects and interfaces
based on a Web Services description Language (WSDL) that is published by Authorize.Net. The
client application initializes the local object and invokes the method as if it is calling a local
procedure. The SOAP client handles the generation and parsing of the underlying extensible
markup language (XML) documents that form the basis of the SOAP protocol.
Specifically, the Authorize.Net Customer Information Manager (CIM) Application Programming
Interface (API) provides a mechanism for developers and value added resellers (VARs) to create,
delete, get, and update customer profile information, including payment and address information,
by means of direct integration between client software or applications and the Authorize.Net
Payment Gateway.
Please refer to specific SOAP client documentation for details on how to consume SOAP-based
Web services.

Integration Methods
Various options exist for integrating payments, designed to accommodate a range of business needs
and coding abilities.

Standard API
You can use the API to submit transaction information to Authorize.Net when your customers enter
data on your website. In this case, the customer enters data on your website, your website calls the
API using either XML or SOAP:
•

XML: The Authorize.Net Application Programming Interface (API) offers an XML-only
option, which allows you to invoke methods using XML for the exchange of information.
• SOAP: The Authorize.Net API offers an alternate communication method, SOAP, to
exchange information.
The choice of XML or SOAP depends on the programming language you use. For PHP and Ruby,
XML is recommended. For C# and other .NET languages, SOAP is recommended. With Java,

either option will work.
For information regarding requirements for using the API, see “Minimum Requirements” below.

Hosted Option API
For more secure exchange of information, the API allows you to establish a hosted connection,
where any exchange of information occurs on the Authorize.Net secure servers. If the merchant
Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

Merchant Web Services API

needs to transmit sensitive cardholder information (for example, if a customer needs to change
credit card information or add a new payment method), the hosted CIM option can be used. Using
the hosted CIM option, credit card data never needs to flow through the merchant’s website. You
can use the hosted option either as an XML or a SOAP implementation.
You must still use the standard API (either SOAP or XML) for some operations, such as creating a
ransaction. The hosted page only provides functionality for creating, updating, and deleting
payment profiles and shipping addresses.
For more information, please refer to Section 2, “Using the Hosted CIM Option,” on page 9.

Minimum Requirements
Before you begin this integration for an Authorize.Net Payment Gateway account, please check
with the merchant to make sure that the following minimum requirements have already been met.
•
•
•
•
•
•

The merchant must have a U.S. based merchant bank account that allows Internet
transactions.
The merchant must have an active Authorize.Net Card Not Present Payment Gateway
account.
The merchant must be signed up for the CIM service.
The merchant must store account authentication data securely (for example, API login ID,
transaction key).
The merchant’s website must use https.
The merchant’s website must support secure user registration for returning users.

Note: Merchants should avoid storing any type of sensitive cardholder information. However, in
the event that a merchant or third party must store sensitive customer business or payment
information, compliance with industry standard storage requirements is required. Please see
the Developer Security Best Practices White Paper at
http://www.authorize.net/files/developerbestpractices.pdf for guidelines.

Developer Support
There are several resources available to help you successfully integrate a merchant Web site or
other application to the Authorize.Net Payment Gateway.
•

The Developer Center at http://developer.authorize.net provides test accounts, sample code,
FAQs, and troubleshooting tools.
• If you can’t find what you need in the Developer Center, our Integration Team is available
to answer your questions by e-mail at integration@authorize.net.
• Be sure to read our Developer Security Best Practices White Paper at
http://www.authorize.net/files/developerbestpractices.pdf for information on how to
maximize the security and reliability of your merchant integration solutions.
If you have any suggestions about how we can improve or correct this guide, please e-mail
documentation@authorize.net.

Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

Section 2 Executing an API Call

Software Development Kits
Authorize.Net offers Software Development Kits (SDKs) that present an alternate object-oriented
model, in several popular languages. The SDK performs the core payment activities (such as error
handling and parsing, network communication, and data encoding) behind the scenes.
The SDK provides utility methods to help developers build payment flows for each of the
integration methods. You can download the SDKs at http://developer.authorize.net/downloads/.

Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

Section 2
Using the Hosted CIM Option
Authorize.Net offers merchants the option of connecting their customers directly to the
Authorize.Net website if they need to transmit sensitive data such as changes in payment profiles.
The purpose of the hosted CIM API is to collect data, not to process payments. Processing
payments is done using the standard CIM API where payment data is represented by a profile ID.
The steps in a typical hosted CIM process are:
•

A customer registers an account with a merchant website

•

The merchant calls Authorize.Net API method CreateCustomerProfile to create an
empty profile
− Input: customer’s email address and/or other identifier that the merchant uses to
identify this customer
−

Output: customer profile ID

•

The customer logs on to the merchant website

•

The merchant calls Authorize.Net API method GetHostedProfilePage to get a token
− Inputs: customer profile ID and a list of settings that control how the customer
interacts with the Authorize.Net page. See Guidelines for Settings Parameters for a
description of the settings.
−

•
•

•
•
•

The merchant displays a button on their website
The customer clicks the button and is directed either to the Authorize.Net page, or the
Authorize.Net page is opened within the merchant’s website as a lightbox popup with an
iframe.
The customer makes changes to their credit card information, eCheck.Net information, or
shipping information
The customer returns to the merchant website by clicking a button or closing the popup
The merchant calls Authorize.Net API method GetCustomerProfile to see what changes
were made by the customer
− Input: customer profile ID
−

•

Output: token (expires in 15 minutes)

Output: list of payment profiles with sensitive fields masked, list of shipping addresses

The merchant can call Authorize.Net API method CreateProfileTransaction at any
time to charge the credit card (or eCheck.Net)

Designing Your Web Page
There are three ways to integrate:

Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

Section 2 Executing an API Call

•

•
•

The customer is directed to Authorize.Net to manage payments and shipping all on one
page. For a sample, see “Example of a redirect to the hosted page:” on page Error!
Bookmark not defined..
Open a lightbox popup with an iframe within your page to manage payments and shipping
all within one popup
Open a lightbox popup with an iframe within your page for adding or editing individual
payment profiles and shipping addresses. Sample screens begin on page 13.

Implementing a Redirect to Authorize.Net
To implement hosted CIM access by means of a redirect to Authorize.Net, you need to include the
following.
Once you receive the token returned by the getHostedProfilePage function call, put a hidden form
somewhere on your page (the value for the token will be the value returned by the function call).
If you are using the test environment, replace secure.authorize.net/profile/manage with
test.authorize.net/profile/manage.

Example: opening a new page for the Authorize.Net host

Add a button on your page that redirects the customer to Authorize.Net’s secure site. You can
customize the text to say anything you want:

In this example, the button with the text “Manage my payment and shipping information” directs
the user to the Authorize.Net Customer Information Manager Hosted page, where they can:
• Create a new payment profile
• Update or delete current credit card or bank information
• Enter a new shipping address
• Update or delete current shipping address
When the customer has finished, a link on the bottom of the page returns them to the merchant’s
website.
The following image shows what the customers see when they are connected to the Authorize.Net
hosted page.

Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

Merchant Web Services API

Example of a redirect to the hosted page:

Implementing an iframe popup
To open the Authorize.Net hosted page in a popup inside your web page, do the following:
•

place an tag on your page. Add other elements around it, such as a <div> tag and
some images, to give it borders and shading. Make it appear in the middle of your page,
covering anything else that might be on the page.
• Put a hidden <form> on your page with a hidden field inside it that includes the token from
the call to the GetHostedProfilePage API method. The <form> tag should have a target
attribute pointing to the id or name of the <iframe>. The Authorize.Net hosted page
provides a way to dynamically change the size of your popup so that there are no scroll bars.
For the full documentation of this integration method, download the sample application at
http://developer.authorize.net/downloads/samplecode/, listed under the Customer Information
Manager (CIM) heading. You can find two zip files, containing all the necessary html code as well
Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

Section 2 Executing an API Call

as instructions, to implement iframe popups for managing payment and shipping information on the
same page, or separately.

To implement…

Select

iframe popup for managing payment and
shipping information on the same page

hostedProfileManage.zip

iframe popup for managing only payment
information

hostedProfilePaymentsShipping.zip

iframe popup for managing shipping information

hostedProfilePaymentsShipping.zip

You can design your popup so that it manages either the payment and shipping information on the
same page, or you can add buttons that manage payment and shipping information separately.
The following images show some sample popups, with their associated buttons.
Add payment

Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

Merchant Web Services API

<button onclick="AuthorizeNetPopup.openAddPaymentPopup()">Add a New
Payment Method</button>

Edit payment

Add a button with the PaymentProfileId for each payment profile
<button
onclick="AuthorizeNetPopup.openEditPaymentPopup('123456')">Edit
Payment Method</button>

Note: Replace ‘123456’ with the payment profile ID.

Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

Section 2 Executing an API Call

Add shipping

<button onclick="AuthorizeNetPopup.openAddShippingPopup()">Add a
New Shipping Address</button>

Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

Merchant Web Services API

Edit shipping

Add a button with the ShippingAddressId for each shipping address
<button
onclick="AuthorizeNetPopup.openEditShippingPopup(‘123456’)">Edit
Shipping Address</button>

Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

Section 2 Executing an API Call

Manage payment and shipping

<button onclick="AuthorizeNetPopup.openManagePopup()">Manage my
payment and shipping information</button>

Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

Merchant Web Services API

Guidelines for Settings Parameters
To integrate to the hosted page as a redirect, pass hostedProfileReturnUrl and
hostedProfileReturnUrlText. Do not pass hostedProfileIFrameCommunicatorUrl.
The parameter hostedProfilePageBorderVisible=true is optional. Do not pass
hostedProfilePageBorderVisible=false.
To integrate to the hosted page as a popup, do not pass hostedProfileReturnUrl or
hostedProfileReturnUrlText. Pass hostedProfilePageBorderVisible=false and pass
hostedProfileIFrameCommunicatorUrl.
The following table shows possible settings:
Parameter

Description

hostedProfileReturnUrl

Enter the URL to return to after the hosted session
ends. Do not pass this setting for iframes or popups.
The return URL is validated to verify that it begins
with http:// or https://.

hostedProfileReturnUrlText

Enter the text to display on the button that returns the
customer to your website. The value can be any text
up to 200 characters. If you do not pass this
parameter, the default button text is Continue. Do not
pass this setting for iframes or popups.

hostedProfilePageBorderVisible

Enter true or false. Must be false for iframes or
popups, and must be true for redirects.

hostedProfileHeadingBgColor

Enter a hex color string such as #e0e0e0. It changes
the background color of the section headers from
gray to a custom color.

hostedProfileIFrameCommunicatorUrl

Enter the url to a page that can communicate with the
merchant’s main page using javascript. This enables
you to dynamically change the size of the popup so
there are no scroll bars. This is required only for
iframe or lightbox applications

Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

Section 2 Executing an API Call

Section 3
Executing an API Call
The following sections describe the minimum requirements for executing an API call for managing
customer profiles using SOAP.
There are two options for developing the request script:
•
•

You can develop a custom script yourself using the API fields information provided in this
document, OR
You can use Authorize.Net sample code in C# and Java available for free from our
Developer Center at http://developer.authorize.net/samplecode.

Note: If you choose to use Authorize.Net sample code, please be aware that in order to achieve a
successful implementation it must be modified with developer test account or the
merchant’s specific payment gateway account information.

Web Service Locations
ITEM

LOCATION

Web Service URL in Production

https://api.authorize.net/soap/v1/Service.asmx

Web Service URL in Developer Test

https://apitest.authorize.net/soap/v1/Service.asmx

WSDL

https://api.authorize.net/soap/v1/Service.asmx?WSDL

Note: The Developer Test URL requires the use of a developer test payment gateway account. You
can request a test account from our Developer Center at
http://developer.authorize.net/testaccount. Developer test accounts cannot be used to test
against the Production URL.

CIM Functions
The CIM API includes the following functions:
•
•
•

CreateCustomerProfile – Create a new customer profile along with any customer payment
profiles and customer shipping addresses for the customer profile.
CreateCustomerPaymentProfile – Create a new customer payment profile for an existing
customer profile.
CreateCustomerShippingAddress – Create a new customer shipping address for an
existing customer profile.

Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

Merchant Web Services API

•

CreateCustomerProfileTransaction – Create a new payment transaction from an existing
customer profile
• DeleteCustomerProfile – Delete an existing customer profile along with all associated
customer payment profiles and customer shipping addresses.
• DeleteCustomerPaymentProfile – Delete a customer payment profile from an existing
customer profile.
• DeleteCustomerShippingAddress – Delete a customer shipping address from an existing
customer profile.
• GetCustomerProfileIds – Retrieve all customer profile IDs you have previously created.
• GetCustomerProfile – Retrieve an existing customer profile along with all the associated
customer payment profiles and customer shipping addresses.
• GetCustomerPaymentProfile – Retrieve a customer payment profile for an existing
customer profile.
• GetCustomerShippingAddress – Retrieve a customer shipping address for an existing
customer profile.
• GetHostedProfilePage—sends a request for access to the hosted CIM page. The response
includes a token that allows the customer to update their information directly on the
Authorize.Net website.
• UpdateCustomerProfile – Update an existing customer profile.
• UpdateCustomerPaymentProfile – Update a customer payment profile for an existing
customer profile.
• UpdateCustomerShippingAddress – Update a shipping address for an existing customer
profile.
• UpdateSplitTenderGroup – Update the status of a split tender group (a group of
transactions, each of which pays for part of one order).
• ValidateCustomerPaymentProfile – Verify an existing customer payment profile by
generating a test transaction.
The following sections provide information about the input parameters required for executing the
functions listed above. Indentations in the Parameter column indicate grouping hierarchy. All
parameters are case sensitive and must be submitted in the order listed here. Parameters are
required unless otherwise indicated. Optional parameters should not be submitted unless
they contain valid values.
Note: Parameters required for individual API calls are in addition to the authentication parameters
required for all API calls.
Note for .NET programmers: When a parameter is optional, and if you use serialization,
then the .NET language you are using automatically creates Boolean properties that
indicate whether or not non-nullable parameters are specified. For example, if there is a
parameter named validationMode that is an Enumeration type, a parameter called
validationModeSpecified is automatically created. By default, these properties are set to
“false.” If a request passes a value for an optional parameter, be sure to set these properties
to “true” so that the value is not ignored.

Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

Section 2 Executing an API Call

Field Validation and Test Mode
The validationMode parameter allows you to generate a test transaction at the time you create or
update a customer profile. The functions createCustomerProfile, createCustomerPaymentProfile,
updateCustomerPaymentProfile and validateCustomerPaymentProfile all include a validationMode
parameter, which can have one of the following values:
•

testMode—performs field validation only. During field validation, all fields are checked.
However, fields with unrestricted field definitions (such as telephone number) do not
generate errors.
If you select testMode, a $1.00 test transaction is submitted to verify that the credit card
number is in a valid format using the Luhn MOD 10 algorithm. This test transaction does
not appear on the customer's credit card statement, but it will generate a transaction receipt
e-mail to the merchant.

•

liveMode—generates a

transaction to the processor in the amount of $0.01 or $0.00. If
successful, the transaction is immediately voided. Visa authorization transactions are being
switched from $0.01 to $0.00 for all processors. All other credit card types use $0.01. We
recommend you consult your Merchant Account Provider before switching to Zero Dollar
Authorizations for Visa, because you may be subject to fees.
For Visa transactions using $0.00, the billTo address and billTo zip fields are required.

• none—When this value is submitted, no additional validation is performed.
• (blank)—this is the same as using the value none.
When you call createCustomerProfile, then you must use a value of none (or leave the value blank)
if the request does not include any payment profile information.
When you call validateCustomerPaymentProfile, then you must use either testMode or liveMode.
If a validation transaction is unsuccessful, the profile is not created and the merchant will receive an
error.

Authentication
All Web services calls must be authenticated to ensure they originate from authorized sources. This
implementation of the merchant Web services API supports authentication using the API Login ID
and Transaction Key.
PARAMETER

VALUE

TYPE/FORMAT

NOTES

merchantAuthentication

Contains merchant unique
information for purposes
of authentication

MerchantAuthentication
Type

name

The valid API Login ID for
the developer test or
merchant account

Submit the API
Login ID used to
submit transactions

transactionKey

The valid Transaction Key
for the developer test or
merchant account

Submit the
Transaction Key
obtained from the
Merchant Interface

Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

Merchant Web Services API

Example of Authentication with the Login ID and Transaction Key
The authentication information with the merchant’s Login ID and Transaction Key is sent in SOAP
body, as shown below:
<soap:Body>
<FunctionName xmlns="https://api.authorize.net/soap/v1/">
<merchantAuthentication>
<name>API Login ID here</name>
<transactionKey>Transaction Key here</transactionKey>
</merchantAuthentication>
Additional required parameters here
</FunctionName>
</soap:Body>

Note: The sample code included in this document uses dummy field values. When using or
testing sample code, be sure to enter valid field values. Additional sample code is available
for download from the Authorize.Net Developer Center at
http://developer.authorize.net/samplecode.

Input Parameters for CreateCustomerProfile
This function is used to create a new customer profile along with any customer payment profiles
and customer shipping addresses for the customer profile.
The following table lists the input parameters for executing an API call to the
CreateCustomerProfile function.

FIELD

VALUE

TYPE/FORMAT

NOTES

profile

Contains
information for
the customer
profile

CustomerProfileType

At least one of the
following fields must be
submitted under
profile:
merchantCustomerId,
description or email.

Merchant
assigned ID for
the customer

Up to 20 characters

Required only if no
values for both
description and email
are submitted.

merchantCustomerId

Conditional
description

Description of
Up to 255 characters
the customer or
customer profile
Conditional

Email address
associated with
the customer

Up to 255 characters

Required only if no
values for both
merchantCustomerId
and email are
submitted.
Required only if no
values for both
description and

Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

Section 2 Executing an API Call

FIELD

VALUE

TYPE/FORMAT

profile

merchantCustomerId
are submitted.

Conditional
paymentProfiles

customerType

NOTES

Contains
CustomerPaymentProfile Multiple instances of
payment
Type
this parameter and its
profiles for the
children can be
customer profile
submitted to create
multiple payment
Optional
profiles for the
customer profile.
Optional

CustomerTypeEnum
individual
business

billTo
firstName

CustomerAddressType
The customer’s
first name

Up to 50 characters (no
symbols)

Optional
lastName

The customer’s
last name

Up to 50 characters (no
symbols)

Optional
company

The name of
the company
associated with
the customer, if
applicable

Up to 50 characters (no
symbols)

Optional
address

The customer’s
address

Up to 60 characters (no
symbols)

Optional
city

The city of the
customer’s
address

Up to 40 characters (no
symbols)

Optional
state

The state of the
customer’s
address

Up to 40 characters (no
symbols)

Optional
zip

The ZIP code of Up to 20 characters (no
the customer’s symbols)
address

Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

Merchant Web Services API

FIELD

VALUE

TYPE/FORMAT

NOTES

Optional
country

The country of
the customer’s
address

Up to 60 characters (no
symbols)

Optional
phoneNumber

The phone
number
associated with
the customer
profile

Up to 25 digits (no
letters)
Ex. (123)123-1234

Optional
faxNumber

The fax number Up to 25 digits (no
associated with letters)
the customer
Ex. (123)123-1234
profile
Optional

payment

Contains
payment profile
information for
the customer
profile

PaymentSimpleType

Can contain
CreditCardSimpleType
or BankAccountType.

creditCard

Contains credit
card payment
information for
the payment
profile

CreditCardSimpleType

This parameter and its
children are only
required when the
payment profile is
credit card.

cardNumber

The customer’s
credit card
number

13 to 16 digits

expirationDate

The expiration
date for the
customer’s
credit card

YYYY-MM

For .Net users, the
class
System.Runtime.Remo
ting.Metadata.W3cXsd
2001.SoapYearMonth
can be used to
manage gYearMonth
types.

The three- or
four-digit
number on the
back of a credit
card (on the
front for
American
Express)

Numeric

This field is required if
the merchant would
like to use the Card
Code Verification
(CCV) security feature.
For more information,
please see the
Merchant Integration
Guide at
http://www.authorize.

cardCode

Optional
Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

Section 2 Executing an API Call

FIELD

VALUE

TYPE/FORMAT

NOTES
net/support/merchant
/http://www.authoriz

e.net/support/mercha
nt/.
cardCode is only used
for validation and will
not be stored in the
customer profile. It
should only be used
when submitting
validationMode with a
value of testMode or
liveMode.
bankAccount

Contains bank
account
payment
information for
the payment
profile

BankAccountType

The type of
bank account
for the payment
profile

BankAccountTypeEnum

Optional

businessChecking

routingNumber

The routing
number of the
customer’s
bank

9 digits

accountNumber

The customer’s
bank account
number

5 to 17 digits

nameOnAccount

The customer’s
full name as
listed on the
bank account

Up to 22 characters

echeckType

The type of
EcheckTypeEnum
electronic check
CCD
transaction
PPD
Optional

accountType

This parameter and its
children are only
required when the
payment profile is bank
account.

checking
savings

Currently, the CIM API
does not support ARC
or BOC transaction
types.

TEL
WEB
bankName

The name of
Up to 50 characters
the bank
associated with
the bank
account number

Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

Merchant Web Services API

FIELD

VALUE

TYPE/FORMAT

NOTES

Optional
shipToList

firstName

Contains
shipping
address
information for
the customer
profile

CustomerAddressType

The customer’s
first name

Up to 50 characters (no
symbols)

Optional
lastName

The customer’s
last name

Up to 50 characters (no
symbols)

Optional
company

The name of
the company
associated with
the customer, if
applicable

Up to 50 characters (no
symbols)

Optional
address

The customer’s
shipping
address

Up to 60 characters (no
symbols)

Optional
city

The city of the
customer’s
shipping
address

Up to 40 characters (no
symbols)

Optional
state

The state of the
customer’s
shipping
address

Up to 40 characters (no
symbols)

Optional
zip

The ZIP code of Up to 20 characters (no
the customer’s symbols)
shipping
address
Optional

country

The country of
the customer’s
shipping
address

Up to 60 characters (no
symbols)

Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

Section 2 Executing an API Call

FIELD

VALUE

TYPE/FORMAT

NOTES

Optional
phoneNumber

The phone
number
associated with
the customer
profile

Up to 25 digits (no
letters)
Ex. (123)123-1234

Optional
faxNumber

The fax number Up to 25 digits (no
associated with letters)
the customer
Ex. (123)123-1234
profile
Optional

validationMode

Indicates the
processing
mode for the
request

none
testMode
liveMode

For more information
on use and restrictions
of validationMode, see
“Field Validation and
Test Mode.”

For information about output for this function, see the section of this document titled “Output
Parameters for CreateCustomerProfileResponse.”
Example CreateCustomerProfile
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<CreateCustomerProfile
xmlns="https://api.authorize.net/soap/v1/">
<merchantAuthentication>
<name>API Login ID here</name>
<transactionKey>Transaction Key
here</transactionKey>
</merchantAuthentication>
<profile>
<merchantCustomerId>Merchant Customer ID
here</merchantCustomerId>
<description>Profile description here</description>
<email>customer profile email address here</email>
<paymentProfiles>
<CustomerPaymentProfileType>
<customerType>individual</customerType>
<payment>
<creditCard>
<cardNumber>Credit card number here</cardNumber>
<expirationDate>Credit card expiration date
Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

Merchant Web Services API

here</expirationDate>
</creditCard>
</payment>
</CustomerPaymentProfileType>
</paymentProfiles>
</profile>
<validationMode>liveMode</validationMode>
</CreateCustomerProfile>
</soap:Body>
</soap:Envelope>

Input Parameters for CreateCustomerPaymentProfile
This function is used to create a new customer payment profile for an existing customer profile.
The following table lists the input parameters for executing an API call to the
CreateCustomerPaymentProfile function.

FIELD

VALUE

TYPE/FORMAT

customerProfileId

Payment gateway
assigned ID
associated with the
customer profile

Numeric

paymentProfile

Contains payment
information for the
customer profile

CustomerPaymentProfile
Type

Optional

CustomerTypeEnum

customerType

NOTES

individual
business
billTo
firstName

CustomerAddressType
The customer’s first
name

Up to 50 characters (no
symbols)

Optional
lastName

The customer’s last
name

Up to 50 characters (no
symbols)

Optional
company

The name of the
Up to 50 characters (no
company associated symbols)
with the customer, if

Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

Section 2 Executing an API Call

FIELD

VALUE

TYPE/FORMAT

NOTES

applicable
Optional
address

The customer’s
address

Up to 60 characters (no
symbols)

Optional
city

The city of the
customer’s address

Up to 40 characters (no
symbols)

Optional
state

The state of the
customer’s address

Up to 40 characters (no
symbols)

Optional
zip

The ZIP code of the
customer’s address

Up to 20 characters (no
symbols)

Optional
country

The country of the
customer’s address

Up to 60 characters (no
symbols)

Optional
phoneNumber

The phone number
associated with the
customer’s address

Up to 25 digits (no
letters)
Ex. (123)123-1234

Optional
faxNumber

The fax number
associated with the
customer’s address

Up to 25 digits (no
letters)
Ex. (123)123-1234

Optional
payment

Contains payment
information for the
customer profile

PaymentSimpleType

creditCard

Contains credit card CreditCardSimpleType
payment information
for the customer
profile

cardNumber

The customer’s
credit card number

13 to 16 digits

expirationDate

The expiration date
for the customer’s
credit card

YYYY-MM

Can contain
CreditCardSimpleType
or BankAccountType.
This parameter and its
children are only
required when the
payment profile is credit
card.

For .Net users, the class
System.Runtime.Remoti
ng.Metadata.W3cXsd20
01.SoapYearMonth can
be used to manage

Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

Merchant Web Services API

FIELD

VALUE

TYPE/FORMAT

NOTES
gYearMonth types.

cardCode

The three- or fourNumeric
digit number on the
back of a credit card
(on the front for
American Express)
Optional

This field is required if
the merchant would like
to use the Card Code
Verification (CCV)
security feature. For
more information,
please see the
Merchant Integration
Guide at
http://www.authorize.n
et/support/merchant/ht

tp://www.authorize.n
et/support/Merchant/d
efault.htm.
cardCode is only used
for validation and will
not be stored in the
customer profile. It
should only be used
when submitting
validationMode with a
value of testMode or
liveMode.
bankAccount

Contains bank
account payment
information for the
customer profile

BankAccountType

accountType

The type of bank
account for the
payment profile

BankAccountTypeEnum

Optional

savings

This parameter and its
children are only
required when the
payment profile is bank
account.

checking

businessChecking
routingNumber

The routing number
of the customer’s
bank

9 digits

accountNumber

The customer’s
bank account
number

5 to 17 digits

nameOnAccount

The customer’s full
name as listed on
the bank account

Up to 22 characters

echeckType

The type of
electronic check
transaction

EcheckTypeEnum
CCD
PPD

Currently, the CIM API
does not support ARC
or BOC transaction
types.

Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

Section 2 Executing an API Call

FIELD

VALUE

TYPE/FORMAT

Optional

TEL

NOTES

WEB
bankName

The name of the
bank associated
with the bank
account number

Up to 50 characters

Optional
validationMode

Indicates the
ValidationModeEnum
processing mode for
none
the request
testMode
liveMode

For more information on
use and restrictions of
validationMode, see
“Field Validation and
Test Mode.”

For information about output parameters for this function, see the section of this document titled
“Output Parameters for CreateCustomerPaymentProfileResponse.”

Input Parameters for CreateCustomerShippingAddress
This function is used to create a new customer shipping address for an existing customer profile.
The following table lists the input parameters for executing an API call to the
CreateCustomerShippingAddress function.

FIELD

VALUE

TYPE/FORMAT

customerProfileId

Payment gateway
assigned ID associated
with the customer profile

Numeric

address

Contains shipping
address information for
the customer profile

CustomerAddressType

The customer’s first name

Up to 50 characters (no
symbols)

firstName

Optional
lastName

The customer’s last name
Optional

company

NOTES

Up to 50 characters (no
symbols)

The name of the company Up to 50 characters (no
associated with the
symbols)
customer, if applicable
Optional

Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

Merchant Web Services API

FIELD
address

VALUE

TYPE/FORMAT

The customer’s shipping
address

Up to 60 characters (no
symbols)

NOTES

Optional
city

The city of the customer’s
shipping address

Up to 40 characters (no
symbols)

Optional
state

The state of the
customer’s shipping
address

Up to 40 characters (no
symbols)

Optional
zip

The ZIP code of the
customer’s shipping
address

Up to 20 characters (no
symbols)

Optional
country

The country of the
customer’s shipping
address

Up to 60 characters (no
symbols)

Optional
phoneNumber

The phone number
associated with the
customer’s shipping
address

Up to 25 digits (no letters)
Ex. (123)123-1234

Optional
faxNumber

The fax number
associated with the
customer’s shipping
address

Up to 25 digits (no letters)
Ex. (123)123-1234

Optional

For information about output parameters for this function, see the section of this document titled
“Output Parameters for CreateCustomerShippingAddressResponse.”

Input Parameters for CreateCustomerProfileTransaction
This function is used to create a payment transaction from an existing customer profile. You can
submit one of six transaction types: Authorization Only, Authorization and Capture, Capture Only,
Prior Authorization and Capture, Refund and Void. For more information on these transaction
types, please see the Merchant Integration Guide at
http://www.authorize.net/support/merchant/http://www.authorize.net/support/Merchant/default.
htm.
Note: The only transaction types that generate a customer receipt email are Authorization Only,
Authorization and Capture, and Refund.
Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

Section 2 Executing an API Call

For Authorization Only transactions
The following table lists the input parameters for executing an API call to the
CreateCustomerProfileTransaction function for an Authorization Only transaction.

FIELD

VALUE

TYPE/FORMAT

transaction

Contains
transaction
information

ProfileTransactionType

profileTransAuthOnly

amount

The transaction ProfileTransAuthOnlyType
type that is
being requested

Only one
transaction type
is allowed per
request.

The total
amount of the
transaction

This amount
should include
all other
amounts such
as tax amount,
shipping
amount, etc.

Up to 4 digits after the
decimal point (no dollar
symbol)
Ex. 12.99 or 12.9999

tax

NOTES

Contains tax
information for
the transaction

ExtendedAmountType

Optional
amount

name

The tax amount
for the
transaction

Up to 4 digits after the
decimal point (no dollar
symbol)

Optional

Ex. 12.99 or 12.9999

The name of
the tax for the
transaction

Up to 31 characters

This amount
must be
included in the
total amount for
the transaction.

Optional
description

The tax
description for
the transaction

Up to 255 characters

Optional
shipping

Contains
shipping
information for
the transaction

ExtendedAmountType

Optional

Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

Merchant Web Services API

FIELD
amount

name

VALUE

TYPE/FORMAT

NOTES

The shipping
amount for the
transaction

Up to 4 digits after the
decimal point (no dollar
symbol)

Optional

Ex. 12.99 or 12.9999

This amount
must be
included in the
total amount for
the transaction.

The name of
the shipping for
the transaction

Up to 31 characters

Optional
description

The shipping
description for
the transaction

Up to 255 characters

Optional
duty

Contains duty
information for
the transaction

ExtendedAmountType

Optional
amount

name

The duty
amount for the
transaction

Up to 4 digits after the
decimal point (no dollar
symbol)

Optional

Ex. 12.99 or 12.9999

The name of
the duty for the
transaction

Up to 31 characters

This amount
must be
included in the
total amount for
the transaction.

Optional
description

The duty
description for
the transaction

Up to 255 characters

Optional
lineItems

Contains line
item details
about the order

LineItemType

Optional

itemId

The ID
assigned to the
item

Up to 30 distinct
instances of this
parameter and
its children can
be included per
transaction to
describe items
included in the
order.

Up to 31 characters

Optional

Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

Section 2 Executing an API Call

FIELD
name

VALUE

TYPE/FORMAT

A short
description of
an item

Up to 31 characters

NOTES

Optional
description

A detailed
description of
an item

Up to 255 characters

Optional
quantity

The quantity of
an item

Up to 4 digits (up to two
decimal places)

Optional
unitPrice

Cost of an item Up to 4 digits with a decimal
per unit
point (no dollar symbol)
excluding tax,
freight, and duty Ex. 4.95
Optional

taxable

Indicates
whether the
item is subject
to tax

TRUE
FALSE

Optional
customerProfileId

Payment
gateway
assigned ID
associated with
the customer
profile

Numeric

customerPaymentProfileId

Payment
gateway
assigned ID
associated with
the customer
payment profile

Numeric

customerShippingAddressId

Payment
gateway
assigned ID
associated with
the customer
shipping
address

Numeric

Optional

If
customerShippi
ngAddressId is
not passed,
shipping
information will
not be included
with the
transaction.

Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

Merchant Web Services API

FIELD
order

VALUE

TYPE/FORMAT

Contains
information
about the order

OrderExType

NOTES

Optional
invoiceNumber

The merchant
assigned
invoice number
for the
transaction

Up to 20 characters (no
symbols)

Optional
description

The transaction
description

Up to 255 characters (no
symbols)

Optional
purchaseOrderNumber

The merchant
assigned
purchase order
number

Up to 25 characters (no
symbols)

Optional
taxExempt

The tax exempt
status

TRUE
FALSE

Optional
recurringBilling

The recurring
billing status

TRUE
FALSE

Optional
cardCode

The customer’s
card code (the
three- or fourdigit number on
the back or
front of a credit
card)

3 to 4 digits

Required only
when the
merchant would
like to use the
Card Code
Verification
(CCV) filter
Conditional

This field is
required if the
merchant would
like to use the
CCV security
feature. For
more
information,
please see the
Merchant
Integration
Guide at
http://www.aut
horize.net/supp
ort/merchant/ht

tp://www.auth
orize.net/supp
ort/Merchant/d
efault.htm.

Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

Section 2 Executing an API Call

FIELD
splitTenderId

extraOptions

VALUE

TYPE/FORMAT

NOTES

Conditional

Up to 6 digits

This field is
required for
second and
subsequent
transactions
related to a
partial
authorizaqtion
transaction.

Information in
String
name/value pair
format that
does not exist
within CIM,
such as
customer IP
address, etc.
Optional

For a complete
list of the
transaction
variable names
available,
please review
the AIM
Implementation
Guide located at
http://www.aut
horize.net/supp
ort/AIM_guide.
pdf.

For information about output parameters for this function, see the section of this document titled
“Output Parameters for CreateCustomerProfileTransactionResponse.”
For Authorization and Capture Transactions
The following table lists the input parameters for executing an API call to the
CreateCustomerProfileTransaction function for an Authorization and Capture transaction.

FIELD

VALUE

TYPE/FORMAT

transaction

Contains
transaction
information

ProfileTransactionType

profileTransAuthCapture

amount

The transaction ProfileTransAuthCaptureTyp
type that is
e
being requested

Only one
transaction type
is allowed per
request.

The total
amount of the
transaction

This amount
should include
all other
amounts such
as tax amount,
shipping
amount, etc.

Up to 4 digits after the
decimal point (no dollar
symbol)
Ex. 12.99 or 12.9999

tax

NOTES

Contains tax
information for

ExtendedAmountType

Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

Merchant Web Services API

FIELD

VALUE

TYPE/FORMAT

NOTES

The tax amount
for the
transaction

Up to 4 digits after the
decimal point (no dollar
symbol)

Optional

Ex. 12.99 or 12.9999

This amount
must be
included in the
total amount for
the transaction.

The name of
the tax for the
transaction

Up to 31 characters

the transaction
Optional
amount

name

Optional
description

The tax
description for
the transaction

Up to 255 characters

Optional
shipping

Contains
shipping
information for
the transaction

ExtendedAmountType

Optional
amount

name

The shipping
amount for the
transaction

Up to 4 digits after the
decimal point (no dollar
symbol)

Optional

Ex. 12.99 or 12.9999

The name of
the shipping for
the transaction

Up to 31 characters

This amount
must be
included in the
total amount for
the transaction.

Optional
description

The shipping
description for
the transaction

Up to 255 characters

Optional
duty

Contains duty
information for
the transaction

ExtendedAmountType

Optional
amount

The duty
amount for the
transaction

Up to 4 digits after the
decimal point (no dollar
symbol)

Optional

Ex. 12.99 or 12.9999

This amount
must be
included in the
total amount for
the transaction.

Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

Section 2 Executing an API Call

FIELD
name

VALUE

TYPE/FORMAT

The name of
the duty for the
transaction

Up to 31 characters

NOTES

Optional
description

The duty
description for
the transaction

Up to 255 characters

Optional
lineItems

Contains line
item details
about the order

LineItemType

Optional

itemId

The ID
assigned to the
item

Up to 30 distinct
instances of this
parameter and
its children can
be included per
transaction to
describe items
included in the
order.

Up to 31 characters

Optional
name

A short
description of
an item

Up to 31 characters

Optional
description

A detailed
description of
an item

Up to 255 characters

Optional
quantity

The quantity of
an item

Up to 4 digits (up to two
decimal places)

Optional
unitPrice

Cost of an item Up to 4 digits with a decimal
per unit
point (no dollar symbol)
excluding tax,
freight, and duty Ex. 4.95
Optional

taxable

Indicates
whether the
item is subject
to tax

TRUE
FALSE

Optional

Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

Merchant Web Services API

FIELD

VALUE

TYPE/FORMAT

customerProfileId

Payment
gateway
assigned ID
associated with
the customer
profile

Numeric

customerPaymentProfileId

Payment
gateway
assigned ID
associated with
the customer
payment profile

Numeric

customerShippingAddressId

Payment
gateway
assigned ID
associated with
the customer
shipping
address

Numeric

Optional
order

Contains
information
about the order

NOTES

If
customerShippi
ngAddressId is
not passed,
shipping
information will
not be included
with the
transaction.

OrderExType

Optional
invoiceNumber

The merchant
assigned
invoice number
for the
transaction

Up to 20 characters (no
symbols)

Optional
description

The transaction
description

Up to 255 characters (no
symbols)

Optional
purchaseOrderNumber

The merchant
assigned
purchase order
number

Up to 25 characters (no
symbols)

Optional
taxExempt

The tax exempt
status

TRUE
FALSE

Optional
recurringBilling

The recurring
billing status

TRUE
FALSE

Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

Section 2 Executing an API Call

FIELD

VALUE

TYPE/FORMAT

NOTES

3 to 4 digits

This field is
required if the
merchant would
like to use the
CCV security
feature. For
more
information,
please see the
Merchant
Integration
Guide at
http://www.aut
horize.net/supp
ort/merchant/ht

Optional
cardCode

The customer’s
card code (the
three- or fourdigit number on
the back or
front of a credit
card)
Required only
when the
merchant would
like to use the
Card Code
Verification
(CCV) filter
Conditional

splitTenderId

extraOptions

Conditional

tp://www.auth
orize.net/supp
ort/Merchant/d
efault.htm.
Up to 6 digits

Information in
String
name/value pair
format that
does not exist
within CIM,
such as
customer IP
address, etc.
Optional

This field is
required for
second and
subsequent
transactions
related to a
partial
authorization
transaction.
For a complete
list of the
transaction
variable names
available,
please review
the AIM
Implementation
Guide located at
http://www.aut
horize.net/supp
ort/AIM_guide.
pdf.

For information about output parameters for this function, see the section of this document titled
“Output Parameters for CreateCustomerProfileTransactionResponse.”
For Capture Only Transactions
The following table lists the input parameters for executing an API call to the
CreateCustomerProfileTransaction function for a Capture Only transaction.
Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

Merchant Web Services API

FIELD

VALUE

transaction

Contains transaction ProfileTransactionType
information

profileTransCaptureOnly

amount

TYPE/FORMAT

The transaction type ProfileTransCaptureOnlyType
that is being
requested

Only one
transaction
type is
allowed per
request.

The total amount of
the transaction

This amount
should include
all other
amounts such
as tax
amount,
shipping
amount, etc.

Up to 4 digits after the decimal
point (no dollar symbol)
Ex. 12.99 or 12.9999

tax

NOTES

Contains tax
information for the
transaction

ExtendedAmountType

Optional
amount

name

The tax amount for
the transaction

Up to 4 digits after the decimal
point (no dollar symbol)

Optional

Ex. 12.99 or 12.9999

The name of the tax
for the transaction

Up to 31 characters

This amount
must be
included in
the total
amount for
the
transaction.

Optional
description

The tax description
for the transaction

Up to 255 characters

Optional
shipping

Contains shipping
information for the
transaction

ExtendedAmountType

Optional
amount

The shipping
amount for the
transaction

Up to 4 digits after the decimal
point (no dollar symbol)
Ex. 12.99 or 12.9999

Optional

This amount
must be
included in
the total
amount for
the
transaction.

Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

Section 2 Executing an API Call

FIELD
name

VALUE

TYPE/FORMAT

The name of the
shipping for the
transaction

Up to 31 characters

NOTES

Optional
description

The shipping
description for the
transaction

Up to 255 characters

Optional
duty

Contains duty
information for the
transaction

ExtendedAmountType

Optional
amount

name

The duty amount for
the transaction

Up to 4 digits after the decimal
point (no dollar symbol)

Optional

Ex. 12.99 or 12.9999

The name of the
duty for the
transaction

Up to 31 characters

This amount
must be
included in
the total
amount for
the
transaction.

Optional
description

The duty description
for the transaction

Up to 255 characters

Optional
lineItems

Contains line item
details about the
order

LineItemType

Optional

itemId

The ID assigned to
the item

Up to 30
distinct
instances of
this parameter
and its
children can
be included
per
transaction to
describe
items included
in the order.

Up to 31 characters

Optional
name

A short description
of an item

Up to 31 characters

Optional
Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

Merchant Web Services API

FIELD
description

VALUE

TYPE/FORMAT

A detailed
description of an
item

Up to 255 characters

NOTES

Optional
quantity

The quantity of an
item

Up to 4 digits (up to two
decimal places)

Optional
unitPrice

Cost of an item per
unit excluding tax,
freight, and duty

Up to 4 digits with a decimal
point (no dollar symbol)
Ex. 4.95

Optional
taxable

Indicates whether
TRUE
the item is subject to
FALSE
tax
Optional

customerProfileId

Payment gateway
assigned ID
associated with the
customer profile

Numeric

customerPaymentProfileId Payment gateway
assigned ID
associated with the
customer payment
profile

Numeric

Payment gateway
assigned ID
associated with the
customer shipping
address

Numeric

customerShippingAddressId

Optional

order

If
customerShip
pingAddressId
is not passed,
shipping
information
will not be
included with
the
transaction.

Contains information OrderExType
about the order
Optional

invoiceNumber

The merchant
assigned invoice
number for the
transaction

Up to 20 characters (no
symbols)

Optional
description

The transaction

Up to 255 characters (no

Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

Section 2 Executing an API Call

FIELD

VALUE

TYPE/FORMAT

description

symbols)

NOTES

Optional

purchaseOrderNumber

The merchant
assigned purchase
order number

Up to 25 characters (no
symbols)

Optional
taxExempt

The tax exempt
status

TRUE
FALSE

Optional
recurringBilling

The recurring billing
status

TRUE
FALSE

Optional
cardCode

The customer’s card 3 to 4 digits
code (the three- or
four-digit number on
the back or front of a
credit card)
Required only when
the merchant would
like to use the Card
Code Verification
(CCV) filter
Conditional

This field is
required if the
merchant
would like to
use the CCV
security
feature. For
more
information,
please see
the Merchant
Integration
Guide at
http://www.a
uthorize.net/
support/merc
hant/http://w

ww.authoriz
e.net/support
/Merchant/d
efault.htm.
approvalCode

The authorization
code of an original
transaction required
for a Capture Only

6 characters

Conditional

This field is
only required
for the
Capture Only
transaction
type.

Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

Merchant Web Services API

FIELD
splitTenderId

extraOptions

VALUE

TYPE/FORMAT

NOTES

Conditional

Up to 6 digits

This field is
required for
second and
subsequent
transactions
related to a
partial
authorizaqtion
transaction.

Information in
String
name/value pair
format that does not
exist within CIM,
such as customer IP
address, etc.
Optional

For a
complete list
of the
transaction
variable
names
available,
please review
the AIM
Implementatio
n Guide
located at
http://www.a
uthorize.net/
support/AIM_
guide.pdf.

For information about output parameters for this function, see the section of this document titled
“Output Parameters for CreateCustomerProfileTransactionResponse.”
For Prior Authorization and Capture Transactions
The following table lists the input parameters for executing an API call to the
CreateCustomerProfileTransaction function for a Prior Authorization and Capture transaction.

FIELD

VALUE

TYPE/FORMAT

transaction

Contains
transaction
information

ProfileTransactionType

profileTransPriorAuthCapture

amount

NOTES

The transaction ProfileTransPriorAuthCapture Only one
type that is
Type
transaction type
being requested
is allowed per
request.
The total
amount of the
transaction

Up to 4 digits after the
decimal point (no dollar
symbol)
Ex. 12.99 or 12.9999

This amount
should include
all other
amounts such
as tax amount,
shipping

Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

Section 2 Executing an API Call

FIELD

VALUE

TYPE/FORMAT

NOTES
amount, etc.

tax

Contains tax
information for
the transaction

ExtendedAmountType

Tax information
from the original
authorization
transaction will
be used if this
field is not
submitted.

The tax amount
for the
transaction

Up to 4 digits after the
decimal point (no dollar
symbol)

Optional

Ex. 12.99 or 12.9999

This amount
must be
included in the
total amount for
the transaction.

The name of
the tax for the
transaction

Up to 31 characters

Optional

amount

name

Optional
description

The tax
description for
the transaction

Up to 255 characters

Optional
shipping

Contains
shipping
information for
the transaction

ExtendedAmountType

Shipping
information from
the original
authorization
transaction will
be used if this
field is not
submitted.

The shipping
amount for the
transaction

Up to 4 digits after the
decimal point (no dollar
symbol)

Optional

Ex. 12.99 or 12.9999

This amount
must be
included in the
total amount for
the transaction.

The name of
the shipping for
the transaction

Up to 31 characters

Optional

amount

name

Optional
description

The shipping
description for
the transaction

Up to 255 characters

Optional
duty

Contains duty
information for

ExtendedAmountType

Duty information
from the original
authorization

Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

Merchant Web Services API

FIELD

VALUE

TYPE/FORMAT

the transaction

transaction will
be used if this
field is not
submitted.

Optional

amount

name

NOTES

The duty
amount for the
transaction

Up to 4 digits after the
decimal point (no dollar
symbol)

Optional

Ex. 12.99 or 12.9999

The name of
the duty for the
transaction

Up to 31 characters

This amount
must be
included in the
total amount for
the transaction.

Optional
description

The duty
description for
the transaction

Up to 255 characters

Optional
lineItems

Contains line
item details
about the order

LineItemType

Optional

Line item
information from
the original
authorization
transaction will
be used if this
field is not
submitted.
Up to 30 distinct
instances of this
parameter and
its children can
be included per
transaction to
describe items
included in the
order.

itemId

The ID
assigned to the
item

Up to 31 characters

Optional
name

A short
description of
an item

Up to 31 characters

Optional
description

A detailed
description of
an item

Up to 255 characters

Optional
Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

Section 2 Executing an API Call

FIELD
quantity

VALUE

TYPE/FORMAT

The quantity of
an item

Up to 4 digits (up to two
decimal places)

NOTES

Optional
unitPrice

Cost of an item Up to 4 digits with a decimal
point (no dollar symbol)
per unit
excluding tax,
freight, and duty Ex. 4.95
Optional

taxable

Indicates
whether the
item is subject
to tax

TRUE
FALSE

Optional
customerProfileId

Payment
gateway
assigned ID
associated with
the customer
profile

Numeric

If a value is
submitted for
this field, it must
be the same ID
used for the
original
authorization
transaction.

customerPaymentProfileId

Payment
gateway
assigned ID
associated with
the customer
payment profile

Numeric

If a value is
submitted for
this field, it must
be the same ID
used for the
original
authorization
transaction.

customerShippingAddressId

Payment
gateway
assigned ID
associated with
the customer
shipping
address

Numeric

If a value is
submitted for
this field, it must
be the same ID
used for the
original
authorization
transaction.

Optional
transId

extraOptions

The payment
gatewayassigned
transaction ID
of the original
transaction

Numeric

Information in
String
name/value pair
format that
does not exist

For a complete
list of the
transaction
variable names

Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

Merchant Web Services API

FIELD

VALUE

TYPE/FORMAT

within CIM,
such as
customer IP
address, etc.

NOTES
available,
please review
the AIM
Implementation
Guide located at
http://www.aut
horize.net/supp
ort/AIM_guide.
pdf.

Optional

For information about output parameters for this function, see the section of this document titled
“Output Parameters for CreateCustomerProfileTransactionResponse.”
For Refund Transactions
• If you are submitting a refund against a previous CIM transaction, the following guidelines
apply: include customerProfileId, customerPaymentProfileId, and transId.
• customerShippingAddressId is optional.
• creditCardNumberMasked, bankRoutingNumberMasked, and bankAccountNumberMasked
do not need to be included, but will be validated if they are included.
If you are submitting a refund against a previous transaction that is not a CIM transaction, the
following guidelines apply:
•

you must include transId, creditCardNumberMasked (or bankRoutingNumberMasked and
bankAccountNumberMasked).
• do not include customerProfileId, customerPaymentProfileId, and
customerShippingAddressId.
You can also issue an unlinked refund against a previous CIM transaction. In this case, the
following rules apply:
•

you must be enrolled in Expanded Credit Capabilities (ECC). For more information about
ECC, see http://www.authorize.net/files/ecc.pdf.

•

you must include customerProfileId and customerPaymentProfileId.

•

customerShippingAddressId is optional.

•

you should not include transId, creditCardNumberMasked,
bankRoutingNumberMasked, and bankAccountNumberMasked.

The following table lists the input parameters for executing an API call to the
CreateCustomerProfileTransaction function for a Refund transaction.

FIELD

VALUE

TYPE/FORMAT

transaction

Contains
transaction
information

ProfileTransactionType

NOTES

Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

Section 2 Executing an API Call

FIELD

VALUE

profileTransRefund

amount

TYPE/FORMAT

The transaction ProfileTransRefundType
type that is
being requested

Only one
transaction type
is allowed per
request.

The total
amount to be
refunded

This amount
should include
all other
amounts such
as tax amount,
shipping
amount, etc.

Up to 4 digits after the
decimal point (no dollar
symbol)
Ex. 12.99 or 12.9999

tax

NOTES

Contains tax
information for
the refund

ExtendedAmountType

Optional
amount

The tax amount
to be refunded
Optional

Up to 4 digits after the
decimal point (no dollar
symbol)
Ex. 12.99 or 12.9999

name

The name of
the tax for the
transaction

This amount
must be
included in the
total amount for
the transaction.

Up to 31 characters

Optional
description

The tax
description for
the transaction

Up to 255 characters

Optional
shipping

Contains
shipping
information for
the refund

ExtendedAmountType

Optional
amount

name

The shipping
amount to be
refunded

Up to 4 digits after the
decimal point (no dollar
symbol)

Optional

Ex. 12.99 or 12.9999

The name of
the shipping for
the transaction

Up to 31 characters

This amount
must be
included in the
total amount for
the transaction.

Optional
description

The shipping
description for

Up to 255 characters

Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

Merchant Web Services API

FIELD

VALUE

TYPE/FORMAT

NOTES

the transaction
Optional
duty

Contains duty
information for
the refund

ExtendedAmountType

Optional
amount

name

The duty
amount to be
refunded

Up to 4 digits after the
decimal point (no dollar
symbol)

Optional

Ex. 12.99 or 12.9999

The name of
the duty for the
transaction

Up to 31 characters

This amount
must be
included in the
total amount for
the transaction.

Optional
description

The duty
description for
the transaction

Up to 255 characters

Optional
lineItems

Contains line
item details
about the
refund

LineItemType

Optional

itemId

The ID
assigned to the
item

Up to 30 distinct
instances of this
parameter and
its children can
be included per
transaction to
describe items
included in the
order.

Up to 31 characters

Optional
name

A short
description of
an item

Up to 31 characters

Optional
description

A detailed
description of
an item

Up to 255 characters

Optional
quantity

The quantity of
an item

Up to 4 digits (up to two
decimal places)

Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

Section 2 Executing an API Call

FIELD

VALUE

TYPE/FORMAT

NOTES

Optional
unitPrice

Cost of an item Up to 4 digits with a decimal
per unit
point (no dollar symbol)
excluding tax,
freight, and duty Ex. 4.95
Optional

taxable

Indicates
whether the
item is subject
to tax

TRUE
FALSE

Optional
customerProfileId

Payment
gateway
assigned ID
associated with
the customer
profile

Numeric

Conditional

If a value is
submitted for
this field, it must
be the same ID
used for the
original
transaction.
For more
complete
information, see
For Refund
Transactions on
page 49

customerPaymentProfileId

Payment
gateway
assigned ID
associated with
the customer
payment profile

Numeric

Conditional

If a value is
submitted for
this field, it must
be the same ID
used for the
original
transaction.
For more
complete
information, see
For Refund
Transactions on
page 49

customerShippingAddressId

Payment
gateway
assigned ID
associated with
the customer
shipping
address

Numeric

Optional

If a value is
submitted for
this field, it must
be the same ID
used for the
original
authorization
transaction.
For more
complete
information, see
For Refund

Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

Merchant Web Services API

FIELD

VALUE

TYPE/FORMAT

NOTES
Transactions on
page 49

creditCardNumberMasked

The last four
digits of the
credit card
number to be
refunded

Four Xs followed by the last
four digits of the credit card
number to be refunded.
Ex. XXXX1234

Conditional

If a value is
submitted, the
last four digits
must be the
same ones used
for the original
transaction.

For more
complete
information, see
For Refund
Transactions on
page 49
bankRoutingNumberMasked

The last four
digits of the
routing number
to be refunded

Four Xs followed by the last
four digits of the routing
number to be refunded.
Ex. XXXX1234

Conditional

If a value is
submitted, the
last four digits
must be the
same ones used
for the original
transaction.
For more
complete
information, see
For Refund
Transactions on
page 49

bankAccountNumberMasked

The last four
digits of the
bank account
number to be
refunded

Four Xs followed by the last
four digits of the bank
account to be refunded.
Ex. XXXX1234

Conditional

If a value is
submitted, the
last four digits
must be the
same ones used
for the original
transaction.

For more
complete
information, see
For Refund
Transactions on
page 49
order

Contains
information
about the order
Optional

invoiceNumber

The merchant
assigned

Up to 20 characters (no

Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

Section 2 Executing an API Call

FIELD

VALUE

TYPE/FORMAT

invoice number
for the
transaction

symbols)

NOTES

Optional
description

The transaction
description

Up to 255 characters (no
symbols)

Optional
purchaseOrderNumber

The merchant
assigned
purchase order
number

Up to 25 characters (no
symbols)

Optional
transId

The payment
gateway
assigned
transaction ID
of the original
transaction.

Numeric

For more
complete
information, see
For Refund
Transactions on
page 49

Conditional
extraOptions

Information in
String
name/value pair
format that
does not exist
within CIM,
such as
customer IP
address, etc.
Optional

For a complete
list of the
transaction
variable names
available,
please review
the AIM
Implementation
Guide located at
http://www.aut
horize.net/supp
ort/AIM_guide.
pdf.

For information about output parameters for this function, see the section of this document titled
“Output Parameters for CreateCustomerProfileTransactionResponse.”
For a Void Transaction
The following table lists the input parameters for executing an API call to the
CreateCustomerProfileTransaction function for a Void transaction.

FIELD

VALUE

TYPE/FORMAT

transaction

Contains
transaction

ProfileTransactionType

NOTES

Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

Merchant Web Services API

FIELD

VALUE

TYPE/FORMAT

NOTES

information
profileTransVoid

customerProfileId

The transaction ProfileTransVoidType
type that is
being requested

Only one
transaction type
is allowed per
request.

Payment
gateway
assigned ID
associated with
the customer
profile

Numeric

If a value is
submitted for
this field, it must
be the same ID
used for the
original
transaction.

Numeric

If a value is
submitted for
this field, it must
be the same ID
used for the
original
transaction.

Numeric

If a value is
submitted for
this field, it must
be the same ID
used for the
original
transaction.

Conditional

customerPaymentProfileId

Payment
gateway
assigned ID
associated with
the customer
payment profile
Optional

customerShippingAddressId

Payment
gateway
assigned ID
associated with
the customer
shipping
address
Optional

transId

extraOptions

The payment
gateway
assigned
transaction ID
of the original
transaction

Numeric

Information in
String
name/value pair
format that
does not exist
within CIM,
such as
customer IP
address, etc.
Optional

For a complete
list of the
transaction
variable names
available,
please review
the AIM
Implementation
Guide located at
http://www.aut
horize.net/supp
ort/AIM_guide.
pdf.

Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

Section 2 Executing an API Call

Input Parameters for DeleteCustomerProfile
This function is used to delete an existing customer profile along with all associated customer
payment profiles and customer shipping addresses.
The following table lists the input parameters for executing an API call to the
DeleteCustomerProfile function.

FIELD

VALUE

TYPE/FORMAT

customerProfileId

Payment gateway assigned ID
associated with the customer profile

Numeric

NOTES

For information about output parameters for this function, see the section of this document titled
“Output Parameters for DeleteCustomerProfileResponse.”

Input Parameters for DeleteCustomerPaymentProfile
This function is used to delete a customer payment profile from an existing customer profile.
The following table lists the input parameters for executing an API call to the
DeleteCustomerPaymentProfile function.

FIELD

VALUE

TYPE/FORMAT

customerProfileId

Payment gatewayassigned ID associated
with the customer
profile

Numeric

customerPaymentProfileId

Payment gateway
assigned ID associated
with the customer
payment profile

Numeric

NOTES

For information about output parameters for this function, see the section of this document titled
“Output Parameters for DeleteCustomerPaymentProfileResponse.”

Input Parameters for DeleteCustomerShippingAddress
This function is used to delete a customer shipping address from an existing customer profile.
The following table lists the input parameters for executing an API call to the
DeleteCustomerShippingAddress function.

FIELD

VALUE

TYPE/FORMAT

NOTES

Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

Merchant Web Services API

customerProfileId

Payment gateway
assigned ID associated
with the customer profile

Numeric

customerShippingAddressId

Payment gateway
assigned ID associated
with the customer
shipping address

Numeric

For information about output parameters for this function, see the section of this document titled
“Output Parameters for DeleteCustomerShippingAddressResponse.”

Input Parameters for GetCustomerProfileIds
This function is used to retrieve all existing customer profile Ids.
The following table lists the input parameters for executing an API call to the
GetCustomerProfileIds function.

FIELD

VALUE

merchantAuthentication

Contains merchant unique
information for purposes of
authentication

TYPE/FORMAT

NOTES

Up to 25
characters

Submit the API Login ID
used to submit
transactions

name

The valid API Login ID for the
developer test or merchant
account

transactionKey

The valid Transaction Key for 16 characters
the developer test or merchant
account

Submit the Transaction
Key obtained from the
Merchant Interface

For information about output parameters for this function, see the section of this document titled
“Output Parameters for GetCustomerProfileIdsResponse.”

Input Parameters for GetCustomerProfile
This function is used to retrieve an existing customer profile along with all the associated customer
payment profiles and customer shipping addresses.
The following table lists the input parameters for executing an API call to the GetCustomerProfile
function.

FIELD

VALUE

TYPE/FORMAT NOTES

customerProfileId

Payment gateway
assigned ID associated

Numeric

Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

Section 2 Executing an API Call

with the customer profile

For information about output parameters for this function, see the section of this document titled
“Output Parameters for GetCustomerProfileResponse.”

Input Parameters for GetCustomerPaymentProfile
This function is used to retrieve a customer payment profile for an existing customer profile.
The following table lists the input parameters for executing an API call to the
GetCustomerPaymentProfile function.

FIELD

VALUE

TYPE/FORMAT

customerProfileId

Payment gateway
assigned ID associated
with the customer
profile

Numeric

customerPaymentProfileId

Payment gateway
assigned ID associated
with the customer
payment profile

Numeric

NOTES

For information about output parameters for this function, see the section of this document titled
“Output Parameters for GetCustomerPaymentProfileResponse.”

Input Parameters for GetCustomerShippingAddress
This function is used to retrieve a customer shipping address for an existing customer profile.
The following table lists the input parameters for executing an API call to the
GetCustomerShippingAddress function.

FIELD

VALUE

TYPE/FORMAT

customerProfileId

Payment gateway
assigned ID associated
with the customer profile

Numeric

customerShippingAddressId

Payment gateway
assigned ID associated
with the customer
shipping address

Numeric

NOTES

Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

Merchant Web Services API

For information about output parameters for this function, see the section of this document titled
“Output Parameters for GetCustomerShippingAddressResponse.”

Input Parameters for getHostedProfilePage
Use this function to initiate a request for direct access to the Authorize.Net website.
The following table lists the input parameters for executing an API call to the getHostedProfilePage
function.

FIELD

VALUE

TYPE/FORMAT NOTES

customerProfileId

Merchant-assigned ID for the customer

Up to 20
characters

hostedProfileSettings

Optional. This is an array of settings for the session.

settingName

Optional. One of:
hostedProfileReturnUrl,
hostedProfileReturnUrlText,
hostedProfileHeadingBgColor,
hostedProfilePageBorderVisible,
hostedProfileIFrameCommunicatorUrl

settingValue

See “Guidelines for Settings Parameters” on
page 16 for a detailed description of these
parameters.

Example
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetHostedProfilePage xmlns="https://api.authorize.net/soap/v1/">
<merchantAuthentication>
<name>string</name>
<transactionKey>string</transactionKey>
</merchantAuthentication>
<customerProfileId>111111</customerProfileId>
<hostedProfileSettings>
<setting>
<settingName>string</settingName>
<settingValue>string</settingValue>
Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

Section 2 Executing an API Call

</setting>
<setting>
<settingName>string</settingName>
<settingValue>string</settingValue>
</setting>
</hostedProfileSettings>
</GetHostedProfilePage>
</soap:Body>
</soap:Envelope>

Input Parameters for UpdateCustomerProfile
This function is used to update an existing customer profile.
The following table lists the input parameters for executing an API call to the
UpdateCustomerProfile function.

FIELD

VALUE

TYPE/FORMAT

profile

Contains payment
information for the
customer profile

CustomerProfileExType

Merchant assigned ID
for the customer

Up to 20 characters

merchantCustomerId

NOTES

Optional
description

Description of the
customer or customer
profile

Up to 255 characters

Optional
email

Email address
associated with the
customer profile

Up to 255 characters

Optional
customerProfileId

Payment gateway
Numeric
assigned ID associated
with the customer profile

For information about output parameters for this function, see the section of this document titled
“Output Parameters for UpdateCustomerProfileResponse.”

Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

Merchant Web Services API

Input Parameters for UpdateCustomerPaymentProfile
This function is used to update a customer payment profile for an existing customer profile.
The following table lists the input parameters for executing an API call to the
UpdateCustomerPaymentProfile function.
Note: If some fields in this request are not submitted or are submitted with a blank value, the
values in the original profile will be removed. As a best practice to prevent this from
happening, call GetCustomerPaymentProfile before calling
UpdateCustomerPaymentProfile. That will return all current information including masked
payment information. Then, simply change the field that needs updating and use that to call
UpdateCustomerPaymentProfile.

FIELD

VALUE

TYPE/FORMAT

customerProfileId

Payment gateway
assigned ID associated
with the customer
profile

Numeric

paymentProfile

Contains payment
information for the
customer profile

CustomerPaymentProfile Sensitive
ExType
information that is
not being updated
can be masked.

Optional

CustomerTypeEnum

customerType

individual
business

billTo

CustomerAddressType

NOTES

If this field is not
submitted in the
request, or
submitted with a
blank value, the
original value will be
removed from the
profile.
If this entire section
is not submitted, the
original billing
information for the
profile will stay the
same.
If updating only one
or more elements
under billTo, all
elements must be
submitted with their
valid values to
prevent the original
values from being
removed.

Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

Section 2 Executing an API Call

FIELD

VALUE

TYPE/FORMAT

NOTES

The customer’s first
name

Up to 50 characters (no
symbols)

If this field is not
submitted in the
request, or
submitted with a
blank value, the
original value will be
removed from the
profile.

Up to 50 characters (no
symbols)

If this field is not
submitted in the
request, or
submitted with a
blank value, the
original value will be
removed from the
profile.

Up to 50 characters (no
symbols)

If this field is not
submitted in the
request, or
submitted with a
blank value, the
original value will be
removed from the
profile.

address

The customer’s address Up to 60 characters (no
symbols)
Optional

If this field is not
submitted in the
request, or
submitted with a
blank value, the
original value will be
removed from the
profile.

city

The city of the
customer’s shipping
address

Up to 40 characters (no
symbols)

If this field is not
submitted in the
request, or
submitted with a
blank value, the
original value will be
removed from the
profile.

Up to 40 characters (no
symbols)

If this field is not
submitted in the
request, or
submitted with a
blank value, the
original value will be
removed from the
profile.

Up to 20 characters (no
symbols)

If this field is not
submitted in the
request, or

firstName

Optional

lastName

The customer’s last
name
Optional

company

The name of the
company associated
with the customer, if
applicable
Optional

Optional

state

The state of the
customer’s address
Optional

zip

The ZIP code of the
customer’s address

Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

Merchant Web Services API

FIELD

VALUE

TYPE/FORMAT

Optional

country

The country of the
customer’s address

submitted with a
blank value, the
original value will be
removed from the
profile.
Up to 60 characters (no
symbols)

If this field is not
submitted in the
request, or
submitted with a
blank value, the
original value will be
removed from the
profile.

Up to 25 digits (no
letters)

If this field is not
submitted in the
request, or
submitted with a
blank value, the
original value will be
removed from the
profile.

Optional

phoneNumber

The phone number
associated with the
customer’s address

Ex. (123)123-1234

Optional

faxNumber

The fax number
associated with the
customer’s address

Up to 25 digits (no
letters)
Ex. (123)123-1234

Optional

payment

creditCard

Contains payment
information for the
customer profile

PaymentSimpleType

Contains credit card
CreditCardSimpleType
payment information for
the customer profile
Conditional

cardNumber

The customer’s credit
card number

NOTES

13 to 16 digits
Number can also be
masked, ex. XXXX1111

If this field is not
submitted in the
request, or
submitted with a
blank value, the
original value will be
removed from the
profile.
Can contain
CreditCardSimpleTy
pe or
BankAccountType.
This parameter and
its children are only
required when the
payment profile is
credit card.
If value is masked,
the last four digits
must match the
original value in the
profile.
If a masked value is
submitted, the
original value will
not be updated.

expirationDate

The expiration date for
the customer’s credit

YYYY-MM

If a masked value is
submitted, the

Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

Section 2 Executing an API Call

FIELD

VALUE

TYPE/FORMAT

NOTES

card

Number can also be
masked, ex. XXXX

original value will
not be updated.
For .Net users, the
class
System.Runtime.Re
moting.Metadata.W
3cXsd2001.SoapYe
arMonth can be
used to manage
gYearMonth types.

cardCode

The three- or four-digit
number on the back of
a credit card (on the
front for American
Express)

Numeric

Optional

This field is required
if the merchant
would like to use the
Card Code
Verification (CCV)
security feature. For
more information,
please see the
Merchant Integration
Guide at
http://www.authori
ze.net/support/mer
chant/http://www.

authorize.net/supp
ort/Merchant/defa
ult.htm.
cardCode is only
used for validation
and will not be
stored in the
customer profile. It
should only be used
when submitting
validationMode
with a value of
testMode or
liveMode.
bankAccount

Contains bank account BankAccountType
payment information for
the customer profile
Conditional

accountType

The type of bank
account for the
payment profile

BankAccountTypeEnum

Optional

savings

checking

businessChecking

routingNumber

The routing number of

9 digits

This parameter and
its children are only
required when the
payment profile is
bank account.
If this field is not
submitted in the
request, or
submitted with a
blank value, the
original value will be
removed from the
profile.
If value is masked,
the last four digits

Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

Merchant Web Services API

FIELD

VALUE

TYPE/FORMAT

NOTES

the customer’s bank

Number can also be
masked, ex. XXXX1111

must match the
original value in the
profile.
If a masked value is
submitted, the
original value will
not be updated.

accountNumber

The customer’s bank
account number

5 to 17 digits
Number can also be
masked, ex. XXXX1111

If value is masked,
the last four digits
must match the
original value in the
profile.
If a masked value is
submitted, the
original value will
not be updated.

nameOnAccount

The customer’s full
name as listed on the
bank account

Up to 22 characters

If this field is not
submitted in the
request, or
submitted with a
blank value, the
original value will be
removed from the
profile.

echeckType

The type of electronic
check transaction

EcheckTypeEnum

Currently, the CIM
API does not
support ARC or
BOC transaction
types.

Optional

CCD
PPD
TEL
WEB

bankName

The name of the bank
associated with the
bank account number

Up to 50 characters

Optional

customerPaymentProfileId

Payment gateway
assigned ID associated
with the customer
payment profile

If this field is not
submitted in the
request, or
submitted with a
blank value, the
original value will be
removed from the
profile.
If this field is not
submitted in the
request, or
submitted with a
blank value, the
original value will be
removed from the
profile.

Numeric

Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

Section 2 Executing an API Call

FIELD

VALUE

TYPE/FORMAT

NOTES

validationMode

Indicates the
processing mode for
the request

none

For more
information on use
and restrictions of
validationMode, see
“Field Validation and
Test Mode”

testMode
liveMode

To test to see if the new payment information is valid, you can call ValidateCustomerPaymentProfile
after successfully updating the payment profile. See the section of this document titled “Input
Parameters for ValidateCustomerPaymentProfile” for more information.
For information about output parameters for this function, see the section of this document titled
“Output Parameters for UpdateCustomerPaymentProfileResponse.”

Input Parameters for UpdateCustomerShippingAddress
This function is used to update a shipping address for an existing customer profile.
The following table lists the input parameters for executing an API call to the
UpdateCustomerShippingAddress function.

FIELD

VALUE

TYPE/FORMAT

customerProfileId

Payment gateway
assigned ID associated
with the customer
profile

Numeric

address

Contains shipping
address information for
the customer profile

CustomerAddress
ExType

The customer’s first
name

Up to 50
characters (no
symbols)

firstName

Optional
lastName

The customer’s last
name
Optional

company

The name of the
company associated
with the customer, if
applicable

NOTES

Up to 50
characters (no
symbols)
Up to 50
characters (no
symbols)

Optional
address

The customer’s
shipping address

Up to 60
characters (no

Merchant Web Services API

FIELD

city

VALUE

TYPE/FORMAT

Optional

symbols)

The city of the
customer’s shipping
address

Up to 40
characters (no
symbols)

NOTES

Optional
state

The state of the
customer’s shipping
address

Up to 40
characters (no
symbols)

Optional
zip

The ZIP code of the
customer’s shipping
address

Up to 20
characters (no
symbols)

Optional
country

The country of the
customer’s shipping
address

Up to 60
characters (no
symbols)

Optional
phoneNumber

The phone number
associated with the
customer’s shipping
address

Up to 25 digits (no
letters)
Ex. (123)1231234

Optional
faxNumber

The fax number
associated with the
customer’s shipping
address

Up to 25 digits (no
letters)
Ex. (123)1231234

Optional
customerShippingAddressId

Payment gateway
assigned ID associated
with the customer
shipping address

Numeric

For information about output parameters for this function, see the section of this document titled
“Output Parameters for UpdateCustomerShippingAddressResponse.”

Input Elements for UpdateSplitTenderGroup
This function is used to update the status of an existing order than contains multiple transactions
with the same splitTenderId.
The following table lists the input elements for executing an API call to the
UpdateSplitTenderGroup function.

Section 2 Executing an API Call

ELEMENT

VALUE

FORMAT

splitTenderId

Payment gatewayassigned number
associated with the
order.

Numeric

NOTES

Required
splitTenderStatus

Indicates the status of all
transactions associated
with the order.

voided or completed.

Use voided to void the
entire order; use
completed to indicate
there are no further
transactions in this order.

Input Parameters for ValidateCustomerPaymentProfile
This function is used to verify an existing customer payment profile by generating a test
transaction. No customer receipt emails are sent when calling ValidateCustomerPaymentProfile.
The following table lists the input parameters for executing an API call to the
ValidateCustomerPaymentProfile function.

FIELD

VALUE

TYPE/FORMAT

customerProfileId

Payment gateway
assigned ID associated
with the customer profile

Numeric

customerPaymentProfileId

Payment gateway
Numeric
assigned ID associated
with the customer payment
profile

customerShippingAddressId

Payment gateway
Numeric
assigned ID associated
with the customer shipping
address
Optional

cardCode

The three- or four-digit
number on the back of a
credit card (on the front for
American Express)

Numeric

Optional

NOTES

If
customerShippingAddressI
d is not passed, shipping
information will not be
included with the
transaction.
This field is required if the
merchant would like to use
the Card Code Verification
(CCV) security feature. For
more information, please
see the Merchant
Integration Guide at
http://www.authorize.net/s
upport/merchant/http://w

ww.authorize.net/support
/Merchant/default.htm.
cardCode is only used for
validation and will not be
stored in the customer
profile. It should only be
Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

Merchant Web Services API

FIELD

VALUE

TYPE/FORMAT

NOTES
used when submitting
validationMode with a
value of testMode or
liveMode.

validationMode

Indicates the processing
mode for the request

testMode
liveMode

For more information on
use and restrictions of
validationMode, see “Field
Validation and Test Mode.”

For information about output parameters for this function, see the section of this document titled
“Output Parameters for ValidateCustomerPaymentProfileResponse.”

Section 4
Responses
The response from the payment gateway to the API call is a set of fields that provides information
about the status of the request.
The following table lists output for API calls.

FIELD
resultCode

VALUE

TYPE/FORMAT

Contains additional
information about the
results of the request

MessageTypeEnum

NOTES

Ok
Error

messages

Contains the result code
and text

MessagesTypeMessage

Messages provide more
details about the error(s).

code

A code that represents the
reason for the error

String

See the “Response
Codes” section of this
document for possible
values.

text

A text description of the
error

String

See the “Response
Codes” section of this
document for possible
values.

CIM Responses
The sample below illustrates the structure of a typical response from the payment gateway for any
of the CIM API calls.
Sample Response
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<CreateCustomerProfileResponse
xmlns="https://api.authorize.net/soap/v1/">
<CreateCustomerProfileResult>
<resultCode>Ok</resultCode>
<messages>
<code>I00001</code>
<text>Successful</text>
Last revised: 5/24/2011
Copyright © 1998 - 2009 Authorize.Net, a CyberSource solution

Merchant Web Services API

</messages>
<customerProfileId>1259</customerProfileId>
</CreateCustomerProfileResult>
</CreateCustomerProfileResponse>
</soap:Body>
</soap:Envelope>

Output for CreateCustomerProfileResponse
The following table lists the output returned from the payment gateway for an API call to the
CreateCustomerProfile function.
Note: The createCustomerProfileResponse only returns the assigned customerProfileId for the
created profile. To retrieve the customerPaymentProfileId and the customerShippingId that
may also be created when using the createCustomerProfile function, you must submit the
getCustomerProfile function, using the assigned customerProfileId for that customer
profile.

FIELD

VALUE

TYPE/FORMAT

NOTES

CreateCustomerProfileResult

Contains the result
of the API request
to create a
customer profile

CreateCustomerProfil See the “Response
Codes” section of
eResponseType
this document for
possible values.

customerProfileId

Payment gateway
Numeric
assigned ID
associated with the
customer profile

This output is only
present for
successful requests.

customerPaymentProfileIdList

A list of all payment Numeric
profile IDs created
with the request

This output is only
present for requests
that contain one or
more payment
profiles.

Optional

The payment profile
IDs will be returned
in the same order as
they were in the
request.
customerShippingAddressIdList

A list of all shipping Numeric
profile IDs created
with the request
Optional

This output is only
present for requests
that contain multiple
shipping profiles.
The shipping profile
IDs will be returned
in the same order as
they were in the
request.

validationDirectResponseList

A list of the direct
response results
for the validation

String
See the Advanced

This output is only
present if the
ValidationMode input

Section 3 Responses

FIELD

VALUE

TYPE/FORMAT

NOTES

transaction for
each payment
profile.

Integration Guide at
http://www.authoriz
e.net/support/AIM_g
uide.pdf for details
about information
included in the
payment gateway
transaction response.

element is passed
with a value of
testMode or
liveMode.

Optional

The list will be
returned in the same
order as the
payment profiles
were submitted in
the request.

Output for CreateCustomerPaymentProfileResponse
The following table lists the output returned from the payment gateway for an API call to the
CreateCustomerPaymentProfile function.

FIELD

VALUE

TYPE/FORMAT

CreateCustomerPaymentProfileResult

Contains the
CreateCustomerPayme
result of the API ntProfileResponseType
request to create
a customer
payment profile

See the “Response
Codes” section of
this document for
possible values.

customerPaymentProfileId

Payment
gateway
assigned ID
associated with
the customer
payment profile

Numeric

This output is only
present for
successful
requests.

validationDirectResponse

Contains
detailed
information
about the result
of the
transaction.

String

This output is only
present if the
ValidationMode
input parameter is
passed with a value
of testMode or
liveMode.

See the Advanced
Integration Guide at
http://www.authorize.
net/support/AIM_guid
e.pdf for details about
information included in
the payment gateway
transaction response.

NOTES

Output for CreateCustomerShippingAddressResponse
The following table represents the output returned from the payment gateway for an API call to the
CreateCustomerShippingAddress function.

Merchant Web Services API

FIELD

VALUE

CreateCustomerShippingAddressResult

Contains the
CreateCustomer
result of the API ShippingAddress
request to create ResponseType
a customer
shipping address

See the “Response
Codes” section of this
document for possible
values.

Payment
Numeric
gateway
assigned ID
associated with
the customer
shipping address

This output is only
present for successful
requests.

customerShippingAddressId

TYPE/FORMAT

NOTES

Output for CreateCustomerProfileTransactionResponse
The following table represents the output returned from the payment gateway for an API call to the
CreateCustomerProfileTransaction function.

FIELD

VALUE

CreateCustomerProfileTransactionResult

Contains the
CreateCustomerProfile See the
result of the API TransactionResponse “Response
Codes” section of
request to
Type
this document for
create a
possible values.
customer profile
transaction

directResponse

Contains
detailed
information
about the result
of the
transaction.

TYPE/FORMAT

NOTES

String

Transactions
created from a
See the Advanced
customer profile
Integration Guide at
will behave the
http://www.authorize.
same as regular
net/support/AIM_gui
transactions - you
de.pdf for details
and your customer
about information
will receive all
included in the
associated email
payment gateway
notifications.
transaction response. Additionally, all
fraud settings,
including FDS
filters and AVS
and CCV settings,
will be enforced.

Output for DeleteCustomerProfileResponse
The following table lists the output returned from the payment gateway for an API call to the
DeleteCustomerProfile function.

Section 3 Responses

FIELD

VALUE

TYPE/FORMAT

NOTES

DeleteCustomerProfileResult

Contains the result of the
API request to delete a
customer profile

DeleteCustomerPr See the “Response
ofileResponseType Codes” section of this
document for possible
values.

Output for DeleteCustomerPaymentProfileResponse
The following table lists the output returned from the payment gateway for an API call to the
DeleteCustomerPaymentProfile function.

FIELD

VALUE

TYPE/FORMAT

NOTES

DeleteCustomerPaymentProfileResult

Contains the
result of the API
request to delete
a customer
payment profile

DeleteCustomer See the “Response
PaymentProfileR Codes” section of this
document for possible
esponseType
values.

Output for DeleteCustomerShippingAddressResponse
The following table lists the output returned from the payment gateway for an API call to the
DeleteCustomerShippingAddress function.

FIELD

VALUE

TYPE/FORMAT

NOTES

DeleteCustomerShippingAddressResult

Contains the
result of the API
request to delete
a customer
shipping address

DeleteCustomer See the “Response
ShippingAddress Codes” section of this
document for possible
ResponseType
values.

Output for GetCustomerProfileIdsResponse
The following table lists the output returned from the payment gateway for an API call to the
GetCustomerProfileIds function.

FIELD

VALUE

TYPE/FORMAT

NOTES

GetCustomerProfileIdsResult

Contains the
result of the
API request to
get all
customer

GetCustomerProfileIdsRe
sponseType

See the
“Response
Codes” section
of this document
for possible

Merchant Web Services API

FIELD

VALUE

TYPE/FORMAT

profile IDs
ids

Payment
gateway
assigned IDs
associated
with the
customer
profiles

NOTES
values.

Numeric

This output is
only present for
successful
requests.

Output for GetCustomerProfileResponse
The following table lists the output returned from the payment gateway for an API call to the
GetCustomerProfile function.

FIELD

VALUE

GetCustomerProfileResult

Contains the
GetCustomerProfileRespo See the
“Response
result of the
nseType
Codes” section
API request to
of this document
get a customer
for possible
profile
values.

profile

TYPE/FORMAT

Contains
information for
the customer
profile

CustomerProfileMasked
Type

Contains
payment
profiles for the
customer
profile

CustomerPaymentProfile
MaskedType

customerPaymentProfileId

Payment
gateway
assigned ID
associated
with the
customer
payment
profile

Numeric

payment

Contains
payment
profile
information for
the customer
profile

PaymentMaskedType

paymentProfiles

NOTES

Section 3 Responses

FIELD

VALUE
creditCard

TYPE/FORMAT

NOTES

Contains credit CreditCardMaskedType
card payment
information for
the customer
profile

cardNumber

The
customer’s
credit card
number

13 to 16 digits

All sensitive
payment
information in
the output is
masked.

expirationDate

The expiration
date for the
customer’s
credit card

YYYY-MM

All sensitive
payment
information in
the output is
masked.

Contains bank
account
payment
information for
the customer
profile

BankAccountMaskedType

routingNumber

The routing
number of the
customer’s
bank

9 digits

All sensitive
payment
information in
the output is
masked.

accountNumber

The
customer’s
bank account
number

5 to 17 digits

All sensitive
payment
information in
the output is
masked.

bankAccount

driversLicense

state

Contains the
DriversLicenseMasked
customer’s
Type
driver’s license
information

This field is no
longer
supported in
CIM requests
and is only
returned for
profiles that
were created
under the
SecureSource
product.

The state of
A valid two-character
the customer’s state code
driver’s license

This field is no
longer
supported in
CIM requests
and is only
returned for
profiles that
were created

Merchant Web Services API

FIELD

VALUE

TYPE/FORMAT

NOTES
under the
SecureSource
product.

number

The
5 to 20 characters
customer’s
driver’s license
number

This field is no
longer
supported in
CIM requests
and is only
returned for
profiles that
were created
under the
SecureSource
product.
All sensitive
payment
information in
the output is
masked.

dateOfBirth

The date of
YYYY-MM-DD
birth listed on
the customer’s
driver’s license

This field is no
longer
supported in
CIM requests
and is only
returned for
profiles that
were created
under the
SecureSource
product.
All sensitive
payment
information in
the output is
masked.

taxId

The
9 digits
customer’s
Social Security
Number or tax
ID

This field is no
longer
supported in
CIM requests
and is only
returned for
profiles that
were created
under the
SecureSource
product.
All sensitive
payment
information in
the output is
masked.

Section 3 Responses

FIELD

VALUE
shipToList

TYPE/FORMAT

NOTES

Contains
CustomerAddressExType
shipping
address profile
information for
the customer
profile

customerShippingAddressId

Payment
gatewayassigned ID
associated
with the
customer
shipping
address

Numeric

Output for GetCustomerPaymentProfileResponse
The following table lists the output returned from the payment gateway for an API call to the
GetCustomerPaymentProfile function.

FIELD

VALUE

TYPE/FORMAT

NOTES

GetCustomerPaymentProfileResult

Contains the
result of the API
request to get a
customer
payment profile

GetCustomerPaymentPro
fileResponseType

See the
“Response
Codes” section of
this document for
possible values.

paymentProfile

customerPaymentProfileId

Contains payment CustomerPaymentProfile
information for the MaskedType
customer profile
Payment gateway
assigned ID
associated with
the customer
payment profile

customerType

Numeric

CustomerTypeEnum
individual
business

billTo

CustomerAddressType

firstName

The customer’s
first name

Up to 50 characters (no
symbols)

lastName

The customer’s
last name

Up to 50 characters (no
symbols)

Merchant Web Services API

FIELD

VALUE

TYPE/FORMAT

company

The name of the
company
associated with
the customer, if
applicable

Up to 50 characters (no
symbols)

address

The customer’s
address

Up to 60 characters (no
symbols)

city

The city of the
customer’s
address

Up to 40 characters (no
symbols)

state

The state of the
customer’s
address

Up to 40 characters (no
symbols)

zip

The ZIP code of
the customer’s
address

Up to 20 characters (no
symbols)

country

The country of the Up to 60 characters (no
customer’s
symbols)
address

phoneNumber

The phone
number
associated with
the customer’s
address

Up to 25 digits (no letters)

The fax number
associated with
the customer’s
address

Up to 25 digits (no letters)

faxNumber

NOTES

Ex. (123)123-1234

payment

Contains payment PaymentMaskedType
profile information
for the customer
profile

creditCard

Contains credit
CreditCardMaskedType
card payment
information for the
payment profile

cardNumber

The customer’s
credit card
number

13 to 16 digits

All sensitive
payment
information in the
output is masked.

expirationDate

The expiration
date for the
customer’s credit
card

YYYY-MM

All sensitive
payment
information in the
output is masked.

Section 3 Responses

FIELD

VALUE

TYPE/FORMAT

bankAccount

Contains bank
BankAccountMaskedType
account payment
information for the
payment profile

accountType

The type of bank
account for the
payment profile

NOTES

checking
savings
businessChecking

routingNumber

The routing
number of the
customer’s bank

9 digits

All sensitive
payment
information in the
output is masked.

accountNumber

The customer’s
bank account
number

5 to 17 digits

All sensitive
payment
information in the
output is masked.

nameOnAccount

The customer’s
Up to 22 characters
full name as listed
on the bank
account

echeckType

The type of
electronic check
transaction

CCD
PPD
TEL
WEB

bankName

Currently, the CIM
API does not
support ARC or
BOC transaction
types.

The name of the
bank associated
with the bank
account number

Up to 50 characters

driversLicense

Contains the
customer’s
driver’s license
information

DriversLicenseMasked
Type

This field is no
longer supported
in CIM requests
and is only
returned for
profiles that were
created under the
SecureSource
product.

state

The state of the
customer’s
driver’s license

A valid two-character
state code

This field is no
longer supported
in CIM requests
and is only
returned for
profiles that were
created under the
SecureSource
product.

Merchant Web Services API

FIELD
number

VALUE

TYPE/FORMAT

NOTES

The customer’s
driver’s license
number

Between 5 and 20
characters

This field is no
longer supported
in CIM requests
and is only
returned for
profiles that were
created under the
SecureSource
product.
All sensitive
payment
information in the
output is masked.

dateOfBirth

The date of birth
listed on the
customer’s
driver’s license

YYYY-MM-DD

This field is no
longer supported
in CIM requests
and is only
returned for
profiles that were
created under the
SecureSource
product.
All sensitive
payment
information in the
output is masked.

taxId

The customer’s
Social Security
Number or tax ID

9 digits

This field is no
longer supported
in CIM requests
and is only
returned for
profiles that were
created under the
SecureSource
product.
All sensitive
payment
information in the
output is masked.

Output for GetCustomerShippingAddressResponse
The following table lists the output returned from the payment gateway for an API call to the
GetCustomerShippingAddress function.

FIELD

VALUE

TYPE/FORMAT

NOTES

GetCustomerShippingAddressResult

Contains the result
of the API request

GetCustomerShippi
ngAddressRespons

See the “Response
Codes” section of

Section 3 Responses

FIELD

address

customerShippingAddressId

VALUE

TYPE/FORMAT

NOTES

to get a customer
shipping address

eType

this document for
possible values.

Contains shipping
address information
for the customer
profile

CustomerAddress
ExType

Payment gateway
assigned ID
associated with the
customer shipping
address

Numeric

Output for getHostedProfilePage
The following table lists the output returned from the payment gateway for an API call to the
getHostedProfilePage function.
FIELD

VALUE

TYPE/FORMAT

NOTES

Token

string

An encrypted string that the
merchant must include when
posting to the Authorize.Net web
page.

If not used within 15 minutes of
the original API call, this token
expires.

The customer’s browser posts the token, Authorize.Net validates it, and makes sure the timestamp
is less than 15 minutes old.
For more complete information on how to use hosted CIM access, see “Section 2
Using the Hosted CIM Option” on page 9.

Output for UpdateCustomerProfileResponse
The following table lists the output returned from the payment gateway for an API call to the
UpdateCustomerProfile function.

FIELD

VALUE

TYPE/FORMAT

NOTES

UpdateCustomerProfileResult

Contains the result of
the API request to
update a customer
profile

UpdateCustomerProfile See the “Response
Codes” section of this
ResponseType
document for possible
values.

Merchant Web Services API

Output for UpdateCustomerPaymentProfileResponse
The following table lists the output returned from the payment gateway for an API call to the
UpdateCustomerPaymentProfile function.

FIELD

VALUE

TYPE/FORMAT

UpdateCustomerPaymentProfileResult

Contains the result
of the API request
to update a
customer payment
profile

UpdateCustomer See the “Response
PaymentProfileRe Codes” section of
this document for
sponseType
possible values.

validationDirectResponse

Contains detailed
information about
the result of the
transaction.

String

Optional

NOTES

This output is only
present if the
See the
ValidationMode input
Advanced
element is passed
Integration Guide with a value of
at
testMode or
http://www.autho
liveMode.
rize.net/support/
AIM_guide.pdf
for details about
information
included in the
payment gateway
transaction
response.

Output for UpdateCustomerShippingAddressResponse
The following table lists the output returned from the payment gateway for an API call to the
UpdateCustomerShippingAddress function.

FIELD

VALUE

TYPE/FORMAT

UpdateCustomerShippingAddressResult

Contains the result UpdateCustomer
of the API request ShippingAddress
to update a
ResponseType
customer shipping
address

NOTES
See the “Response
Codes” section of
this document for
possible values.

Output for UpdateSplitTenderGroup
The following table lists the output returned from the payment gateway for an API call to the
UpdateSplitTenderGroup function.

Section 3 Responses

FIELD

VALUE

TYPE/FORMAT

NOTES

UpdateSplitTenderGroupResult

Contains the result UpdateSplitTend
of the API request erGroupRespons
to update a split
eType
tender group

See the “Response
Codes” section of
this document for
possible values.

Output for ValidateCustomerPaymentProfileResponse
The following table represents the output returned from the payment gateway for an API call to the
ValidateCustomerPaymentProfile function.

FIELD

VALUE

ValidateCustomerPaymentProfileResult

Contains the
ValidateCustomer
result of the API PaymentProfileRe
request to
sonseType
validate a
customer
payment profile

directResponse

Contains
detailed
information
about the result
of the
transaction.

TYPE/FORMAT

NOTES
See the “Response
Codes” section of this
document for possible
values.

String
See the Advanced
Integration Guide
at
http://www.autho
rize.net/support/
AIM_guide.pdf
for details about
information
included in the
payment gateway
transaction
response.

Duplicate Profile Verification
When submitting calls to the CreateCustomerProfile, CreateCustomerPaymentProfile, and
CreateCustomerShippingAddress functions, the payment gateway checks certain fields in each
request to determine that a profile with that same information does not already exist. If a profile
already exists that contains the values being submitted in the new request, then the payment
gateway returns an error message. If the duplicate profile is a customer profile, the error message
contains the ID of the already-created profile. The duplicate profile verification serves as a
safeguard against accidental duplicate submissions.
The following table lists the fields for each function that cannot match any other profile already
created. An error will only occur if ALL the values for each field being submitted match ALL the
values for each field in the already existing profile.

Merchant Web Services API

FUNCTION

FIELDS USED FOR DUPLICATE PROFILE VERIFICATION

CreateCustomerProfile

merchantCustomerId, description, email

CreateCustomerPaymentProfile

customerProfileId, cardNumber, accountNumber,
routingNumber, billToFirstName, billToLastName,
billToAddress, and billToZip

CreateCustomerShippingAddress

customerProfileId, firstName, lastName, address, zip and
phoneNumber

Response Codes
The following table lists the common response codes and texts for requests to the Customer
Information Manager API.

CODE

TEXT

DESCRIPTION

I00001

Successful

The request was processed successfully.

I00003

The record has already been deleted.

E00001

An error occurred during processing. Please try An unexpected system error occurred while
again.
processing this request.

E00002

The content-type specified is not supported.

The only supported content-types are text/xml
and application/xml.

E00003

An error occurred while parsing the XML
request.

This is the result of an XML parser error.

E00004

The name of the requested API method is
invalid.

The name of the root node of the XML request
is the API method being called. It is not valid.

E00005

The merchantAuthentication.transactionKey is
invalid or not present.

Merchant authentication requires a valid value
for transaction key.

E00006

The merchantAuthentication.name is invalid or
not present.

Merchant authentication requires a valid value
for name.

E00007

User authentication failed due to invalid
authentication values.

The name/and or transaction key is invalid.

E00008

User authentication failed. The payment
gateway account or user is inactive.

The payment gateway or user account is not
currently active.

E00009

The payment gateway account is in Test Mode. The requested API method cannot be executed
The request cannot be processed.
while the payment gateway account is in Test
Mode.

E00010

User authentication failed. You do not have the

The user does not have permission to call the

Section 3 Responses

CODE

TEXT

DESCRIPTION

appropriate permissions.

API.

E00011

Access denied. You do not have the
appropriate permissions.

The user does not have permission to call the
API method.

E00013

The field is invalid.

One of the field values is not valid.

E00014

A required field is not present.

One of the required fields was not present.

E00015

The field length is invalid.

One of the fields has an invalid length.

E00016

The field type is invalid.

The field type is not valid.

E00019

The customer taxId or driversLicense
information is required.

The customer tax ID or driver’s license
information (driver’s license number, driver’s
license state, driver’s license DOB) is required
for the subscription.

E00027

The transaction was unsuccessful.

An approval was not returned for the
transaction.

E00029

Payment information is required.

Payment information is required when creating
a subscription or payment profile.

E00039

A duplicate record already exists.

A duplicate of the customer profile, customer
payment profile, or customer address was
already submitted.

E00040

The record cannot be found.

The profileID, paymentProfileId, or
shippingAddressId for this request is not valid
for this merchant.

E00041

One or more fields must contain a value.

All of the fields were empty or missing.

E00042

The maximum number of payment profiles
allowed for the customer profile is {0}.

The maximum number of payment profiles for
the customer profile has been reached.

E00043

The maximum number of shipping addresses
allowed for the customer profile is {0}.

The maximum number of shipping addresses
for the customer profile has been reached.

E00044

Customer Information Manager is not enabled.

The payment gateway account is not enabled
for Customer Information Manager (CIM).

E00051

The original transaction was not issued for this
payment profile.

If the customer profile ID, payment profile ID,
and shipping address ID are included, they
must match the original transaction.

Merchant Web Services API

Index
API calls

Developer Support ........................................ 7

executing ................................................. 18

Duplicate Profile Verification .................... 84

responses ................................................. 70

GetCustomerPaymentProfile ...................... 58

Authentication............................................. 20

GetCustomerPaymentProfileResponse ....... 78

cardholder information

GetCustomerProfile .................................... 57

security ...................................................... 7
CIM Functions

GetCustomerProfileIds ............................... 57
GetCustomerProfileIdsResponse ................ 74

summary.................................................. 18

GetCustomerProfileResponse ..................... 75

CIM Responses ........................................... 70

GetCustomerShippingAddress ................... 58

CIM, hosted .................................................. 9

GetCustomerShippingAddressResponse .... 81

CreateCustomerPaymentProfile .................. 27

getHostedProfilePage ................................. 59

CreateCustomerPaymentProfileResponse .. 72

response .................................................. 82

CreateCustomerProfile................................ 21

hosted CIM ................................................... 9

CreateCustomerProfileResponse ................ 71

hostedProfilePage

CreateCustomerProfileTransaction ............. 31

input ........................................................ 59

Authorization and Capture ...................... 36

output ...................................................... 82

Authorization Only ................................. 32

live mode .................................................... 20

Capture Only ........................................... 40

Minimum Requirements ............................... 7

Prior Authorization and Capture ............. 45

Profiles

Refund..................................................... 49

duplicate ................................................. 84

Void transaction ...................................... 54

refund transactions...................................... 49

CreateCustomerProfileTransactionResponse
................................................................ 73
CreateCustomerShippingAddress ............... 30
CreateCustomerShippingAddressResponse 72
DeleteCustomerPaymentProfile .................. 56
DeleteCustomerPaymentProfileResponse .. 74
DeleteCustomerProfile................................ 56
DeleteCustomerProfileResponse ................ 73
DeleteCustomerShippingAddress ............... 56
DeleteCustomerShippingAddressResponse 74

refunds
unlinked .................................................. 49
Response Codes .......................................... 85
sample code ................................................ 18
security
best practices ............................................ 7
SOAP
about ......................................................... 6
test mode ..................................................... 20
transactions

Section 3 Responses

refund ...................................................... 49
unlinked credit ............................................ 49
UpdateCustomerPaymentProfile................. 61
UpdateCustomerPaymentProfileResponse . 83
UpdateCustomerProfile............................... 60
UpdateCustomerProfileResponse ............... 82
UpdateCustomerShippingAddress .............. 66

UpdateCustomerShippingAddressResponse
................................................................ 83
ValidateCustomerPaymentProfile .............. 68
ValidateCustomerPaymentProfileResponse84
validationMode
using ....................................................... 20
Web Service Locations ............................... 18

</pre><hr>Source Exif Data: <br /><pre>File Type : PDF
File Type Extension : pdf
MIME Type : application/pdf
PDF Version : 1.5
Linearized : No
Author : alegsdin
Company : Authorize.Net, a Service of Lightbridge
Create Date : 2011:05:24 16:32:17-07:00
Modify Date : 2011:05:24 16:34:50-07:00
Source Modified : D:20110524233137
Tagged PDF : Yes
XMP Toolkit : Adobe XMP Core 4.2.1-c041 52.342996, 2008/05/07-20:48:00
Metadata Date : 2011:05:24 16:34:50-07:00
Creator Tool : Acrobat PDFMaker 9.0 for Word
Document ID : uuid:a7bfee8f-4663-45a2-bac9-dc92d2ad23d2
Instance ID : uuid:dc00e363-80ee-4594-bdd6-00fe45ededd3
Subject : 15
Format : application/pdf
Title : Customer Information Manager (CIM) Soap guide
Creator : alegsdin
Producer : Adobe PDF Library 9.0
Page Layout : OneColumn
Page Mode : UseOutlines
Page Count : 89
</pre>
<small>EXIF Metadata provided by <a href="https://exif.tools/">EXIF.tools</a></small>

<div id="ezoic-pub-ad-placeholder-110">
<script async src="//pagead2.googlesyndication.com/pagead/js/adsbygoogle.js"></script>

<ins class="adsbygoogle"
style="display:block"
data-ad-client="ca-pub-0545639743190253"
data-ad-slot="6172135303"
data-ad-format="link"></ins>
<script>
(adsbygoogle = window.adsbygoogle || []).push({});
</script>
</div>
</div>
<div id="catlinks" class="catlinks catlinks-allhidden" data-mw="interface"></div> <div class="visualClear"></div>
</div>
</div>
<div id="mw-navigation">
<h2>Navigation menu</h2>

<form action="https://usermanual.wiki/search.php" id="searchform">
<div id="simpleSearch">
<input type="search" name="search" placeholder="Search UserManual.wiki" title="Search UserManual.wiki [ctrl-option-f]" accesskey="f" id="searchInput" tabindex="1" autocomplete="off"><input type="hidden" value="Special:Search" name="title"><input type="submit" name="go" value="Go" title="Find a User Manual" id="searchButton" class="searchButton"> </div>
</form>
</div>-->
<ul>
<li id="pt-mycontris"><a href="https://usermanual.wiki/upload" title="Upload User Manual" accesskey="y">Upload a User Manual</a></li>
</ul>
</div>
<div id="left-navigation">
<div id="p-namespaces" role="navigation" class="vectorTabs" aria-labelledby="p-namespaces-label">
<h3 id="p-namespaces-label">Versions of this User Manual:</h3>
<ul>
<li id="ca-nstab-main"><span><a href="https://usermanual.wiki/Pdf/AuthorizeNetCIMSOAPguide.704475575" title="User Manual Wiki" accesskey="c">Wiki Guide</a></span></li> <li id="ca-nstab-main"><span><a href="https://usermanual.wiki/Pdf/AuthorizeNetCIMSOAPguide.704475575/html" title="HTML" accesskey="c">HTML</a></span></li> <li id="ca-nstab-main" class="selected" ><span><a href="https://usermanual.wiki/Pdf/AuthorizeNetCIMSOAPguide.704475575/help" title="Discussion / FAQ / Help" accesskey="c">Download & Help</a></span></li>
</ul>
</div>
</div>
<div id="right-navigation">
<div id="p-views" role="navigation" class="vectorTabs" aria-labelledby="p-views-label">
<h3 id="p-views-label">Views</h3>
<ul>

<li id="ca-view"><span><a href="#">User Manual</a></span></li>

<li class="selected" id="ca-edit"><span><a href="https://usermanual.wiki/Pdf/AuthorizeNetCIMSOAPguide.704475575/help" title="Ask a question" accesskey="e">Discussion / Help</a></span></li>

</ul>
</div>
</div>
</div>
<div id="mw-panel">
<div id="p-logo" role="banner"><a class="mw-wiki-logo" href="https://usermanual.wiki/Main_Page" title="Visit the main page"></a></div>
<div class="portal" role="navigation" id="p-navigation" aria-labelledby="p-navigation-label">
<h3 id="p-navigation-label">Navigation</h3>

</div>
<div class="portal" role="navigation" id="p-tb" aria-labelledby="p-tb-label">

</div>
</div>
</div>
<div id="footer" role="contentinfo">
<ul id="footer-info">
<li id="footer-info-lastmod">© 2025 UserManual.wiki</li>
</ul>
<ul id="footer-places">
<li id="footer-places-privacy"><a href="https://usermanual.wiki/ContactUs" title="UserManual.wiki:Contact Us">Contact Us</a></li>
<li id="footer-places-about"><a href="https://usermanual.wiki/DMCA" title="UserManual.wiki:DMCA">DMCA</a></li>
</ul>
<ul id="footer-icons" class="noprint">
<li id="footer-poweredbyico">

</li>
</ul>

</div>

</div></body></html>
<script src="/cdn-cgi/scripts/7d0fa10a/cloudflare-static/rocket-loader.min.js" data-cf-settings="b4b0658b434e63cc7e70c9fa-|49" defer></script>