API Reference

Authentication

All calls to the Authorize.Net API require merchant authentication. Sign up for a sandbox account to get started quickly.

merchantAuthentication

Element Description Format
name Required.
The merchant’s valid API login ID.
Submit the API login ID used to submit transactions.
Up to 25 characters.
transactionKey Required.
The merchant’s valid transaction key.
Submit the transaction key obtained by the merchant from the Merchant Interface.
16 characters.
Request:

Live API Console requests are not supported in IE9 or below.

Enter your sandbox credentials below and all the sample requests will be run against this account. You can sign up for an account really quickly here.

Response:
Loading...

Request Method: POST

Sandbox URL: https://apitest.authorize.net/xml/v1/request.api

Production URL: https://api.authorize.net/xml/v1/request.api

XSD URL: https://api.authorize.net/xml/v1/schema/AnetApiSchema.xsd


XML Content-Type: text/xml

JSON Content-Type: application/json

Payment Transactions

The createTransactionRequest function enables you to submit a wide variety of transaction requests, depending on how you structure it. For example, differences in the transactionType field or the payment field can create different types of transactions.

For more information about the different types of transactions, see the Payment Transactions Feature Details page.

Charge a Credit Card

Use this method to authorize and capture a credit card payment.

createTransactionRequest

Element Description Format
merchantAuthentication Required.
Contains merchant authentication information.
name Required.
Merchant’s unique API Login ID.
The merchant API Login ID is provided in the Merchant Interface and must be stored securely.

The API Login ID and Transaction Key together provide the merchant authentication required for access to the payment gateway.
20-character maximum.
transactionKey Required.
Merchant’s unique Transaction Key.
The merchant Transaction Key is provided in the Merchant Interface and must be stored securely.

The API Login ID and Transaction Key together provide the merchant authentication required for access to the payment gateway.
16-character maximum.
refId Merchant-assigned reference ID for the request.
If included in the request, this value is included in the response. This feature might be especially useful for multi-threaded applications.
Up to 20 characters.
transactionRequest Required.
This element is a container for transaction specific information.
transactionType Type of credit card transaction.
If the value submitted does not match a supported value, the transaction is rejected.
authCaptureTransaction
amount Required.
Amount of the transaction.
This is the total amount and must include tax, shipping, and any other charges.
15-digits maximum with a decimal point (no currency sign or symbol). For example, 8.95
payment This section includes payment information.
trackData Conditional.
Applies to Card Present transactions only.

Contains track data read from the customer's card.
Track data contains the full card number and expiration date by default. If you use the trackData element, do not send the creditCard element. Sending both elements may result in Response Reason Code 153.
track1 Conditional.
Applies to Card Present transactions only.


Track data includes the full card number and expiration date by default. If you use the track1 element, do not send the creditCard element. Sending both elements may result in Response Reason Code 153.
Valid Track 1 data.

Note: Starting and ending sentinel characters must be discarded before submitting transactions.
track2 Conditional.
Applies to Card Present transactions only.


Track data includes the full card number and expiration date by default. If you use the track2 element, do not send the creditCard element. Sending both elements may result in Response Reason Code 153.
Valid Track 2 data.

Note: Starting and ending sentinel characters must be discarded before submitting transactions.
creditCard The following elements belong to the creditCard element; include them only for credit card transactions.
cardNumber Required.
The customer’s credit card number.
Optional for Card Present.
Between 13 and 16 digits without spaces.
expirationDate Required.
The customer’s credit card expiration date.
Optional for Card Present.
YYYY-MM
cardCode The customer’s card code.
The three- or four-digit number on the back of a credit card (on the front for American Express).

This field is required if the merchant would like to use the Card Code Verification (CCV) security feature.

Cardholder information must be stored securely and in accordance with the Payment Card Industry (PCI) Data Security Standard.

For more information about PCI, please refer to the Standards, Compliance and Security developer training video at http://developer.authorize.net/training.
Numeric
profile The following field enables you to create a customer profile from transaction data.
createProfile true, false
If set to true, a customer profile will be generated from the customer and payment data.
solution Contains information about the software that generated the transaction.
id The solution ID is generated by Authorize.Net and provided to the solution provider.
Alphanumeric. Up to 50 characters.
terminalNumber The merchant's in-store terminal number. Can identify the cashiers or kiosks used.
Do not use your processor's terminal ID for this field.
Alphanumeric.
order Contains information about the order.
invoiceNumber Merchant-defined invoice number associated with the order.
description Description of the item purchased.
lineItems Contains one or more lineItem elements (the maximum is 30 line items.
lineItem Describes one line item of the order.
itemId Item identification.
Up to 31 characters.
name Name of the item.
Up to 31 characters
description Description of the item.
Up to 255 characters.
quantity Quantity purchased.
Up to two decimal places. Must be a positive number
unitPrice Price of one item.
Price of an item per unit, excluding tax, freight, and duty.
tax Contains information about any taxes applied.
amount Amount of tax.
Total amount of the transaction must include this amount.
Format can include up to two decimal points. For example, 1.27.
name Name of tax.
description Description of tax.
duty Contains information about any duty applied.
amount Amount of duty.
name Name of duty.
description Description of duty.
shipping Items in this section describe shipping charges applied.
amount Amount of shipping charges.
name Name of shipping charges.
description Description of shipping charges.
taxExempt Indicates whether or not order is exempt from tax.
true, false
poNumber The merchant-assigned purchase order number.
Purchase order number must be created dynamically on the merchant's server or provided on a per-transaction basis. The payment gateway does not perform this function.
Up to 25 characters (no symbols).
customer The following fields contain customer information.
type Type of customer.
individual, business
id Merchant assigned customer ID.
Unique identifier to represent the customer associated with the transaction.

Customer ID must be created dynamically on the merchant's server or provided for each transaction. The payment gateway does not perform this function.
Up to 20 characters (no symbols).
email The customer’s valid email address.
Required only when using a European Payment Processor. Processing Platform.

Email address to which the customer’s copy of the email receipt is sent when Email Receipts is configured in the Merchant Interface. The email is sent to the customer only if the email address format is valid.
Up to 255 characters.

For example, janedoe@customer.com
billTo This section contains billing address information.
If EVO is your payment processor and you submit any of the following billTo fields, you must submit all of them.

firstName
lastName
address
city
state
zip
firstName First name associated with customer’s billing address.
Required only when using a European Payment Processor.
Up to 50 characters (no symbols).
lastName Last name associated with customer’s billing address.
Required only when using a European Payment Processor.
Up to 50 characters (no symbols).
company Company associated with customer’s billing address.
Up to 50 characters (no symbols).
address Customer’s billing address.
Required if merchant would like to use the Address Verification Service security feature.

Required when using GPN Canada or Worldpay Streamline Processing Platform.
Up to 60 characters (no symbols).
city City of customer’s billing address.
Required only when using a European Payment Processor.
Up to 40 characters (no symbols).
state State of customer’s billing address.
Required only when using a European Payment Processor.
Up to 40 characters (no symbols) or a valid two-character state code.
zip ZIP code of customer’s billing address.
Required if merchant would like to use the Address Verification Service security feature.

Required when using GPN Canada or Worldpay Streamline Processing Platform.
Up to 20 characters (no symbols).
country Country of customer’s billing address.
Required only when using a European Payment Processor.
Up to 60 characters (no symbols).
phoneNumber Phone number associated with customer’s billing address.
Up to 25 digits (no letters).

For example,
(123)123-1234
faxNumber Fax number associated with customer’s billing address.
Up to 25 digits (no letters).

For example,
(123)123-1234
shipTo This section contains shipping information.
If EVO is your payment processor and you submit any of the following shipTo fields, you must submit all of them.

firstName
lastName
address
city
state
zip
firstName First name associated with customer’s shipping address.
Up to 50 characters (no symbols).
lastName Last name associated with customer’s shipping address.
Up to 50 characters (no symbols).
company Company associated with customer’s shipping address.
Up to 50 characters (no symbols).
address Customer’s shipping address.
Up to 60 characters (no symbols).
city City of customer’s shipping address.
Up to 40 characters (no symbols).
state State of customer’s shipping address.
Up to 40 characters (no symbols) or a valid two-character state code.
zip ZIP code of customer’s shipping address.
Up to 20 characters (no symbols).
country Country of customer’s shipping address.
Up to 60 characters (no symbols).
customerIP IP address of customer initiating the transaction. If this value is not passed, it will default to 255.255.255.255.
Required only when the merchant is using customer IP based AFDS filters.
Up to 15 characters (no letters).

For example, 255.255.255.255
cardholderAuthentication Merchants using a third party cardholder authentication solution can submit the following authentication values with Visa and/or MasterCard transactions.

Note: invalid combinations of the following two fields will generate an error.
authenticationIndicator The electronic commerce indicator (ECI) value for a Visa transaction; or the universal cardholder authentication field indicator (UCAF) for a MasterCard transaction obtained by the merchant after the authentication process.
Required only for transactions processed through 3D Secure cardholder authentication programs, such as Verified by Visa or SecureCode. When submitted with other transaction types, this value is ignored.

This field is currently supported through Chase Paymentech, FDMS Nashville, Global Payments and TSYS.
Special characters included in this value must be URL encoded.
cardholderAuthenticationValue The cardholder authentication verification value (CAVV) for a Visa transaction; or accountholder authentication value (AVV)/ universal cardholder authentication field (UCAF) for a MasterCard transaction obtained by the merchant after the authentication process.
Required only for authorization only and authorization and capture transactions that are processed through 3D Secure cardholder authentication programs, such as Verified by Visa or SecureCode. When submitted with other transaction types, this value is ignored.

This field is currently supported through Chase Paymentech, FDMS Nashville, Global Payments and TSYS.
Special characters included in this value must be URL encoded.
retail The retail element contains two elements: marketType and deviceType. If you submit the retail element, the marketType and DeviceType elements are required.
marketType 0 for ecommerce
1 for moto
2 for retail
This element is required if you submit the retail element.
Default value is 2.
deviceType 1, 2, 3, 4, 5, 7, 8, 9, 10
1 = Unknown
2 = Unattended Terminal
3 = Self Service Terminal
4 = Electronic Cash Register
5 = Personal Computer- Based Terminal
7 = Wireless POS
8 = Website
9 = Dial Terminal
10 = Virtual Terminal
This element is required if you submit the retail element.
employeeId Merchant-assigned employee ID.
The employeeId field is required for the EVO processor, and is supported on the TSYS processor. If a value is not passed with the field, Authorize.Net sends a default value of 0000 to the processor.
Numeric, 4 digits.
transactionSettings This section contains one or more setting elements.
setting Contains settingName and settingValue
settingName Name of a specific setting to be modified for this transaction.
Setting recurringBilling to true does not create a recurring transaction. This data is simply passed to the payment processor. To create a recurring transaction, see the Recurring Billing documentation.
One of the following:

allowPartialAuth
duplicateWindow
emailCustomer
recurringBilling
settingValue Indicate whether the specified setting is enabled or disabled.
Boolean (true, false, 1, or 0)
userFields Any value supplied by the merchant. This data is NOT stored with the transaction, and is only available in the transaction response.
name Name of the user-defined field.
User reference field provided by the system for the merchant’s use. The value of this field will return to the merchant in the response exactly as it was submitted.
value Value of the user-defined field.
User reference field provided by the system for the merchant’s use. The value of this field will return to the merchant in the response exactly as it was submitted.
surcharge Used to record payment card surcharges that are passed along to customers. Contains an amount and a description child element.
Currently supported for TSYS merchants.

For details on surcharge rules, please see Visa's merchant regulations and fees.
amount Amount of the surcharge.
Currently supported for TSYS merchants.

For details on surcharge rules, please see Visa's merchant regulations and fees.
15-digits maximum with a decimal point (no currency sign or symbol). For example, 8.95
description Describes the reason or details for the surcharge.
Currently supported for TSYS merchants.

For details on surcharge rules, please see Visa's merchant regulations and fees.
merchantDescriptor Provides the option to submit a soft descriptor that will appear on the cardholder's statement with the charge.
Currently supported for TSYS merchants.
25 characters, alphanumeric

createTransactionResponse

Element Description Format
refId Merchant-assigned reference ID for the request.
If included in the request, this value is included in the response. This feature might be especially useful for multi-threaded applications.
Up to 20 characters.
messages This section contains information about the results of the request.
resultCode Ok or Error.
Contains additional information about the status of the request.
message Contains specific message information.
code Code number for message.
I00001
E000001
text Text for the error message.
sessionToken Returned for mobile device transactions, instead of a transactionKey.
transactionResponse
responseCode Overall status of the transaction.
1 = Approved
2 = Declined
3 = Error
4 = Held for Review
authCode Authorization or approval code.
6 characters.
avsResultCode Address Verification Service (AVS) response code.
Indicates the result of the AVS filter.
A = Address (Street) matches, ZIP does not.
B = Address information not provided for AVS check.
E = AVS error.
G = Non-U.S. Card Issuing Bank.
N = No Match on Address (Street) or ZIP.
P = AVS not applicable for this transaction.
R = Retry — System unavailable or timed out.
S = Service not supported by issuer.
U = Address information is unavailable.
W = Nine digit ZIP matches, Address (Street) does not.
X = Address (Street) and nine digit ZIP match.
Y = Address (Street) and five digit ZIP match.
Z = Five digit ZIP matches, Address (Street) does not.
cvvResultCode Card code verification (CCV) response code.
Indicates result of the CCV filter.
M = Match.
N = No Match.
P = Not Processed.
S = Should have been present.
U = Issuer unable to process request.
cavvResultCode Cardholder authentication verification response code.
Blank or not present = CAVV not validated.
0 = CAVV not validated because erroneous data was submitted.
1 = CAVV failed validation.
2 = CAVV passed validation.
3 = CAVV validation could not be performed; issuer attempt incomplete.
4 = CAVV validation could not be performed; issuer system error.
5 = Reserved for future use.
6 = Reserved for future use.
7 = CAVV attempt — failed validation — issuer available (U.S.-issued card/non-U.S acquirer).
8 = CAVV attempt — passed validation — issuer available (U.S.-issued card/non-U.S. acquirer).
9 = CAVV attempt — failed validation — issuer unavailable (U.S.-issued card/non-U.S. acquirer).
A = CAVV attempt — passed validation — issuer unavailable (U.S.-issued card/non-U.S. acquirer).
B = CAVV passed validation, information only, no liability shift.
transId The payment gateway assigned identification number for transaction.
The transId value must be used for any follow-on transactions such as a credit, prior authorization and capture, or void.
refTransId The transaction ID of a related, previously settled transaction.
transHash Payment gateway-generated MD5 hash value that can be used to authenticate the transaction response.
Because transaction responses are returned using an SSL connection, this feature is not necessary for AIM.
Alphanumeric.
accountNumber The last four digits of either the card number or bank account number used for the transaction in the format XXXX1234.
accountType Either the credit card type or in the case of eCheck, the value is eCheck.
messages This element contains one or more elements.
message These messages contain detailed information about the status of a particular transaction.
code Response code that represents the status.
description Text description of the status.
errors This element contains one or more elements.
error This element contains detailed information about any errors returned.
errorCode Error code returned.
errorText Text description of error.
splitTenderPayments If the transaction was a partial authorization transaction, then the split tender payment detail information is listed in this section.
splitTenderPayment Contains information about one split tender transaction.
transId The payment gateway assigned identification number for the transaction.
responseCode The overall status of the transaction
1 = Approved
2 = Declined
3 = Error
4 = Held for Review
responseToCustomer
authCode The authorization or approval code.
6 characters.
accountNumber Last 4 digits of the card provided.
This field is returned with all transactions.
Alphanumeric (XXXX6835)
accountType Visa, MasterCard, American Express, Discover, Diners Club, or JCB.
Text.
requestedAmount Amount requested in original authorization.
Present if the current transaction is for a prepaid card or if the splitTenderId field was sent in.
Numeric.
approvedAmount Amount approved.
Present if the current transaction is for a prepaid card or if the splitTenderId field was sent in.
balanceOnCard Balance on the debit card or prepaid card.
Can be a positive or negative number. Has a value only if the current transaction is for a prepaid card.
Numeric.
userFields This element contains user fields, if any are defined.
Name Name of user-defined field.
These values are only echoed back in the response, and are also added to the merchant receipts. No other action is taken with user-defined fields.
value Value of user-defined field.
These values are only echoed back in the response, and are also added to the merchant receipts. No other action is taken with user-defined fields.
profileResponse Contains result of attempt to create a CIM profile.
messages Contains one or more message elements.
resultCode ok or error
message Contains detailed information about the status of a particular transaction.
code Response Code that represents status.
text Text description of status
customerProfileId Payment gateway assigned ID associated with the customer profile.
Numeric
customerPaymentProfileIdList Contains the Customer Payment Profile ID element
numericString Payment gateway assigned ID associated with the customer payment profile.
This is only included if the original transaction included a billing address.
Numeric
customerShippingProfileIdList Contains the Customer Shipping Profile ID element.
numericString Payment gateway assigned ID associated with the customer shipping profile.
This is only included if the original transaction included a shipping address.
Numeric
Request:

Live API Console requests are not supported in IE9 or below.

Enter your sandbox credentials below and all the sample requests will be run against this account. You can sign up for an account really quickly here.

Ok, you're in a real hurry right now, we understand, click here to use default sandbox credentials.

Response:
Loading...
View :

URL :

URL :

URL :

URL :

URL :

URL :

Authorize a Credit Card

Use this method to authorize a credit card payment. To actually charge the funds you will need to follow up with a capture transaction.

createTransactionRequest

Element Description Format
merchantAuthentication Required.
Contains merchant authentication information.
name Required.
Merchant’s unique API Login ID.
The merchant API Login ID is provided in the Merchant Interface and must be stored securely.

The API Login ID and Transaction Key together provide the merchant authentication required for access to the payment gateway.
20-character maximum.
transactionKey Required.
Merchant’s unique Transaction Key.
The merchant Transaction Key is provided in the Merchant Interface and must be stored securely.

The API Login ID and Transaction Key together provide the merchant authentication required for access to the payment gateway.
16-character maximum.
refId Merchant-assigned reference ID for the request.
If included in the request, this value is included in the response. This feature might be especially useful for multi-threaded applications.
Up to 20 characters.
transactionRequest Required.
This element is a container for transaction specific information.
transactionType Type of credit card transaction.
If the value submitted does not match a supported value, the transaction is rejected.
authOnlyTransaction
amount Required.
Amount of the transaction.
This is the total amount and must include tax, shipping, and any other charges.
15-digits maximum with a decimal point (no currency sign or symbol). For example, 8.95
payment This section includes payment information.
trackData Conditional.
Applies to Card Present transactions only.

Contains track data read from the customer's card.
Track data contains the full card number and expiration date by default. If you use the trackData element, do not send the creditCard element. Sending both elements may result in Response Reason Code 153.
track1 Conditional.
Applies to Card Present transactions only.


Track data includes the full card number and expiration date by default. If you use the track1 element, do not send the creditCard element. Sending both elements may result in Response Reason Code 153.
Valid Track 1 data.

Note: Starting and ending sentinel characters must be discarded before submitting transactions.
track2 Conditional.
Applies to Card Present transactions only.


Track data includes the full card number and expiration date by default. If you use the track2 element, do not send the creditCard element. Sending both elements may result in Response Reason Code 153.
Valid Track 2 data.

Note: Starting and ending sentinel characters must be discarded before submitting transactions.
creditCard The following elements belong to the creditCard element; include them only for credit card transactions.
cardNumber Required.
The customer’s credit card number.
Optional for Card Present.
Between 13 and 16 digits without spaces.
expirationDate Required.
The customer’s credit card expiration date.
Optional for Card Present.
YYYY-MM
cardCode The customer’s card code.
The three- or four-digit number on the back of a credit card (on the front for American Express).

This field is required if the merchant would like to use the Card Code Verification (CCV) security feature.

Cardholder information must be stored securely and in accordance with the Payment Card Industry (PCI) Data Security Standard.

For more information about PCI, please refer to the Standards, Compliance and Security developer training video at http://developer.authorize.net/training.
Numeric
profile The following field enables you to create a customer profile from the data sent to make the transaction.
createProfile true, false
If set to true, a CIM profile will be generated from the customer and payment data.
solution Contains information about the software that generated the transaction.
id The solution ID is generated by Authorize.Net and provided to the solution provider.
Alphanumeric. Up to 50 characters.
terminalNumber The merchant's in-store terminal number. Can identify the cashiers or kiosks used.
Do not use your processor's terminal ID for this field.
Alphanumeric.
order Contains information about the order.
invoiceNumber Merchant-defined invoice number associated with the order.
description Description of the item purchased
lineItems Contains one or more lineItem elements (the maximum is 30 line items.
lineItem Describes one line item of the order.
itemId Item identification.
Up to 31 characters.
name Name of the item.
Up to 31 characters
description Description of the item.
Up to 255 characters.
quantity Quantity purchased.
Up to two decimal places. Must be a positive number
unitPrice Price of one item.
Price of an item per unit, excluding tax, freight, and duty.
tax Contains information about any taxes applied.
amount Amount of tax.
Total amount of the transaction must include this amount.
Format can include up to two decimal points. For example, 1.27.
name Name of tax.
description Description of tax.
duty Contains information about any duty applied.
amount Amount of duty.
name Name of duty.
description Description of duty.
shipping Items in this section describe shipping charges applied.
amount Amount of shipping charges.
name Name of shipping charges.
description Description of shipping charges.
taxExempt Indicates whether or not order is exempt from tax.
true, false
poNumber The merchant-assigned purchase order number.
Purchase order number must be created dynamically on the merchant's server or provided on a per-transaction basis. The payment gateway does not perform this function.
Up to 25 characters (no symbols).
customer The following fields contain customer information.
type
individual, business
id Merchant assigned customer ID.
Unique identifier to represent the customer associated with the transaction.

Customer ID must be created dynamically on the merchant's server or provided for each transaction. The payment gateway does not perform this function.
Up to 20 characters (no symbols).
email The customer’s valid email address.
Required only when using a European Payment Processor. Processing Platform.

Email address to which the customer’s copy of the email receipt is sent when Email Receipts is configured in the Merchant Interface. The email is sent to the customer only if the email address format is valid.
Up to 255 characters.

For example, janedoe@customer.com
billTo This section contains billing address information.
The billTo field is required only when the amount of the transaction is zero and the transaction type is authOnlyTransaction.

If EVO is your payment processor and you submit any of the following billTo fields, you must submit all of them.

firstName
lastName
address
city
state
zip
firstName First name associated with customer’s billing address.
Required only when using a European Payment Processor.
Up to 50 characters (no symbols).
lastName Last name associated with customer’s billing address.
Required only when using a European Payment Processor.
Up to 50 characters (no symbols).
company Company associated with customer’s billing address.
Up to 50 characters (no symbols).
address Customer’s billing address.
Required if merchant would like to use the Address Verification Service security feature.

Required when using GPN Canada or Worldpay Streamline Processing Platform.
Up to 60 characters (no symbols).
city City of customer’s billing address.
Required only when using a European Payment Processor.
Up to 40 characters (no symbols).
state State of customer’s billing address.
Required only when using a European Payment Processor.
Up to 40 characters (no symbols) or a valid two-character state code.
zip ZIP code of customer’s billing address.
Required if merchant would like to use the Address Verification Service security feature.

Required when using GPN Canada or Worldpay Streamline Processing Platform.
Up to 20 characters (no symbols).
country Country of customer’s billing address.
Required only when using a European Payment Processor.
Up to 60 characters (no symbols).
phoneNumber Phone number associated with customer’s billing address.
Up to 25 digits (no letters).

For example,
(123)123-1234
faxNumber Fax number associated with customer’s billing address.
Up to 25 digits (no letters).

For example,
(123)123-1234
shipTo This section contains shipping information.
If EVO is your payment processor and you submit any of the following shipTo fields, you must submit all of them.

firstName
lastName
address
city
state
zip
firstName First name associated with customer’s shipping address.
Up to 50 characters (no symbols).
lastName Last name associated with customer’s shipping address.
Up to 50 characters (no symbols).
company Company associated with customer’s shipping address.
Up to 50 characters (no symbols).
address Customer’s shipping address.
Up to 60 characters (no symbols).
city City of customer’s shipping address.
Up to 40 characters (no symbols).
state State of customer’s shipping address.
Up to 40 characters (no symbols) or a valid two-character state code.
zip ZIP code of customer’s shipping address.
Up to 20 characters (no symbols).
country Country of customer’s shipping address.
Up to 60 characters (no symbols).
customerIP IP address of customer initiating the transaction. If this value is not passed, it will default to 255.255.255.255.
Required only when the merchant is using customer IP based AFDS filters.
Up to 15 characters (no letters).

For example, 255.255.255.255
cardholderAuthentication Merchants using a third party cardholder authentication solution can submit the following authentication values with Visa and/or MasterCard transactions.

Note: invalid combinations of the following two fields will generate an error.
authenticationIndicator The electronic commerce indicator (ECI) value for a Visa transaction; or the universal cardholder authentication field indicator (UCAF) for a MasterCard transaction obtained by the merchant after the authentication process.
Required only for transactions processed through 3D Secure cardholder authentication programs, such as Verified by Visa or SecureCode. When submitted with other transaction types, this value is ignored.

This field is currently supported through Chase Paymentech, FDMS Nashville, Global Payments and TSYS.
Special characters included in this value must be URL encoded.
cardholderAuthenticationValue The cardholder authentication verification value (CAVV) for a Visa transaction; or accountholder authentication value (AVV)/ universal cardholder authentication field (UCAF) for a MasterCard transaction obtained by the merchant after the authentication process.
Required only for authorization-only and authorization-and-capture transactions that are processed through 3D Secure cardholder authentication programs, such as Verified by Visa or SecureCode.”. When submitted with other transaction types, this value is ignored.

This field is currently supported through Chase Paymentech, FDMS Nashville, Global Payments and TSYS.
Special characters included in this value must be URL encoded.
retail The retail element contains two elements: marketType and deviceType.
marketType 0 for ecommerce
1 for moto
2 for retail
Default value is 2.
deviceType 1, 2, 3, 4, 5, 7, 8, 9, 10
1 = Unknown
2 = Unattended Terminal
3 = Self Service Terminal
4 = Electronic Cash Register
5 = Personal Computer- Based Terminal
7 = Wireless POS
8 = Website
9 = Dial Terminal
10 = Virtual Terminal
employeeId Merchant-assigned employee ID.
The employeeId field is required for the EVO processor, and is supported on the TSYS processor. If a value is not passed with the field, Authorize.Net sends a default value of 0000 to the processor.
Numeric, 4 digits.
transactionSettings This section contains one or more setting elements.
setting Contains settingName and settingValue.
settingName Name of a specific setting to be modified for this transaction.
Setting recurringBilling to true does not create a recurring transaction. This data is simply passed to the payment processor. To create a recurring transaction, see the Recurring Billing documentation.
One of the following:

allowPartialAuth
duplicateWindow
emailCustomer
recurringBilling
settingValue Indicate whether the specified setting is enabled or disabled.
Boolean (true, false, 1, or 0)
userFields User-defined fields are allowed. This data is not stored with the transaction, and is only available in the transaction response.
name Name of the user-defined field.
value Value of the user-defined field.
surcharge Used to record payment card surcharges that are passed along to customers. Contains an amount and a description child element.
Currently supported for TSYS merchants.

For details on surcharge rules, please see Visa's merchant regulations and fees.
amount Amount of the surcharge.
Currently supported for TSYS merchants.

For details on surcharge rules, please see Visa's merchant regulations and fees.
15-digits maximum with a decimal point (no currency sign or symbol). For example, 8.95
description Describes the reason or details for the surcharge.
Currently supported for TSYS merchants.

For details on surcharge rules, please see Visa's merchant regulations and fees.
merchantDescriptor Provides the option to submit a soft descriptor that will appear on the cardholder's statement with the charge.
Currently supported for TSYS merchants.
25 characters, alphanumeric

createTransactionResponse

Element Description Format
refId Merchant-assigned reference ID for the request.
If included in the request, this value is included in the response. This feature might be especially useful for multi-threaded applications.
Up to 20 characters.
messages This section contains information about the results of the request.
resultCode Ok or Error.
Contains additional information about the status of the request.
message Contains specific message information.
code Code number for message.
I00001
E000001
text Text for the error message.
sessionToken Returned for mobile device transactions, instead of a transactionKey.
transactionResponse
responseCode Overall status of the transaction.
1 = Approved
2 = Declined
3 = Error
4 = Held for Review
authCode Authorization or approval code.
6 characters.
avsResultCode Address Verification Service (AVS) response code.
Indicates the result of the AVS filter.
A = Address (Street) matches, ZIP does not.
B = Address information not provided for AVS check.
E = AVS error.
G = Non-U.S. Card Issuing Bank.
N = No Match on Address (Street) or ZIP.
P = AVS not applicable for this transaction.
R = Retry — System unavailable or timed out.
S = Service not supported by issuer.
U = Address information is unavailable.
W = Nine digit ZIP matches, Address (Street) does not.
X = Address (Street) and nine digit ZIP match.
Y = Address (Street) and five digit ZIP match.
Z = Five digit ZIP matches, Address (Street) does not.
cvvResultCode Card code verification (CCV) response code.
Indicates result of the CCV filter.
M = Match.
N = No Match.
P = Not Processed.
S = Should have been present.
U = Issuer unable to process request.
cavvResultCode Cardholder authentication verification response code.
Blank or not present = CAVV not validated.
0 = CAVV not validated because erroneous data was submitted.
1 = CAVV failed validation.
2 = CAVV passed validation.
3 = CAVV validation could not be performed; issuer attempt incomplete.
4 = CAVV validation could not be performed; issuer system error.
5 = Reserved for future use.
6 = Reserved for future use.
7 = CAVV attempt — failed validation — issuer available (U.S.-issued card/non-U.S acquirer).
8 = CAVV attempt — passed validation — issuer available (U.S.-issued card/non-U.S. acquirer).
9 = CAVV attempt — failed validation — issuer unavailable (U.S.-issued card/non-U.S. acquirer).
A = CAVV attempt — passed validation — issuer unavailable (U.S.-issued card/non-U.S. acquirer).
B = CAVV passed validation, information only, no liability shift.
transId The payment gateway assigned identification number for transaction.
The transId value must be used for any follow-on transactions such as a credit, prior authorization and capture, or void.
When testRequest is set to a positive response, or when Test Mode is enabled on the payment gateway, this value will be 0.
refTransId The transaction ID of a related, previously settled transaction.
transHash Payment gateway-generated MD5 hash value that can be used to authenticate the transaction response.
Because transaction responses are returned using an SSL connection, this feature is not necessary for AIM.
Alphanumeric.
testRequest
Indicates whether or not to treat this request as a test transaction.
true, false,1,0.
accountNumber
accountType
messages This element contains one or more elements.
message These messages contain detailed information about the status of a particular transaction.
code Response code that represents the status.
description Text description of the status.
errors This element contains one or more elements.
error This element contains detailed information about any errors returned.
errorCode Error code returned.
errorText Text description of error.
splitTenderPayments If the transaction was a partial authorization transaction, then the split tender payment detail information is listed in this section.
splitTenderPayment Contains information about one split tender transaction.
transId The payment gateway assigned identification number for the transaction.
responseCode The overall status of the transaction.
1 = Approved
2 = Declined
3 = Error
4 = Held for Review
responseToCustomer
authCode The authorization or approval code.
6 characters.
accountNumber Last 4 digits of the card provided.
This field is returned with all transactions.
Alphanumeric (XXXX6835)
accountType Visa, MasterCard, American Express, Discover, Diners Club, or JCB.
Text.
requestedAmount Amount requested in original authorization.
Present if the current transaction is for a prepaid card or if the splitTenderId field was sent in.
Numeric.
approvedAmount Amount approved.
Present if the current transaction is for a prepaid card or if the splitTenderId field was sent in.
balanceOnCard Balance on the debit card or prepaid card.
Can be a positive or negative number. Has a value only if the current transaction is for a prepaid card.
Numeric.
userFields This element contains user fields, if any are defined. This data is NOT stored with the transaction, and is only available in the transaction response.
Name Name of user-defined field.
These values are only echoed back in the response, and are also added to the merchant receipts. No other action is taken with user-defined fields.
value Value of user-defined field.
These values are only echoed back in the response, and are also added to the merchant receipts. No other action is taken with user-defined fields.
profileResponse Contains result of attempt to create a CIM profile.
messages Contains one or more message elements.
resultCode ok or error
message Contains detailed information about the status of a particular transaction.
code Response Code that represents status.
text Text description of status.
customerProfileId Payment gateway assigned ID associated with the customer profile.
numeric
customerPaymentProfileIdList Contains the Customer Payment Profile ID element
numericString Payment gateway assigned ID associated with the customer payment profile
This is only included if the original transaction included a billing address.
Numeric
customerShippingAddressIdList Contains the Customer Shipping Profile ID element
numericString Payment gateway assigned ID associated with the customer shipping profile
This is only included if the original transaction included a shipping address.
Numeric
Request:

Live API Console requests are not supported in IE9 or below.

Enter your sandbox credentials below and all the sample requests will be run against this account. You can sign up for an account really quickly here.

Ok, you're in a real hurry right now, we understand, click here to use default sandbox credentials.

Response:
Loading...
View :

URL :

URL :

URL :

URL :

URL :

URL :

Capture a Previously Authorized Amount

Use this method to capture funds for a transaction that was previously authorized using authOnlyTransaction.

createTransactionRequest

Element Description Format
merchantAuthentication Required.
Contains merchant authentication information.
name Required.
Merchant’s unique API Login ID.
The merchant API Login ID is provided in the Merchant Interface and must be stored securely.

The API Login ID and Transaction Key together provide the merchant authentication required for access to the payment gateway.
20-character maximum.
transactionKey Required.
Merchant’s unique Transaction Key.
The merchant Transaction Key is provided in the Merchant Interface and must be stored securely.

The API Login ID and Transaction Key together provide the merchant authentication required for access to the payment gateway.
16-character maximum.
refId Merchant-assigned reference ID for the request.
If included in the request, this value is included in the response. This feature might be especially useful for multi-threaded applications.
Up to 20 characters.
transactionRequest Required.
This element is a container for transaction specific information.
transactionType Type of credit card transaction.
If the value submitted does not match a supported value, the transaction is rejected.
priorAuthCaptureTransaction
amount Required.
Amount of the transaction.
This is the total amount and must include tax, shipping, and any other charges.
15-digits maximum with a decimal point (no currency sign or symbol). For example, 8.95
terminalNumber The merchant's in-store terminal number. Can identify the cashiers or kiosks used.
Do not use your processor's terminal ID for this field.
Alphanumeric.
refTransId Required.
string
Transaction ID of the original partial authorization transaction.
Required only for refundTransaction, priorAuthCaptureTransaction, and voidTransaction. Do not include this field if you are providing splitTenderId
order Contains information about the order.
invoiceNumber Merchant-defined invoice number associated with the order.
String. 20-character maximum.
description Description of the item purchased.
String. 255-character maximum.

createTransactionResponse

Element Description Format
refId Merchant-assigned reference ID for the request.
If included in the request, this value is included in the response. This feature might be especially useful for multi-threaded applications.
Up to 20 characters.
messages This section contains information about the results of the request.
resultCode Ok or Error.
Contains additional information about the status of the request.
message Contains specific message information.
code Code number for message.
I00001
E000001
text Text for the error message.
sessionToken Returned for mobile device transactions, instead of a transactionKey.
transactionResponse
responseCode Overall status of the transaction.
1 = Approved
2 = Declined
3 = Error
4 = Held for Review
authCode Authorization or approval code.
6 characters.
avsResultCode Address Verification Service (AVS) response code.
Indicates the result of the AVS filter.
A = Address (Street) matches, ZIP does not.
B = Address information not provided for AVS check.
E = AVS error.
G = Non-U.S. Card Issuing Bank.
N = No Match on Address (Street) or ZIP.
P = AVS not applicable for this transaction.
R = Retry — System unavailable or timed out.
S = Service not supported by issuer.
U = Address information is unavailable.
W = Nine digit ZIP matches, Address (Street) does not.
X = Address (Street) and nine digit ZIP match.
Y = Address (Street) and five digit ZIP match.
Z = Five digit ZIP matches, Address (Street) does not.
cvvResultCode Card code verification (CCV) response code.
Indicates result of the CCV filter.
M = Match.
N = No Match.
P = Not Processed.
S = Should have been present.
U = Issuer unable to process request.
cavvResultCode Cardholder authentication verification response code.
Blank or not present = CAVV not validated.
0 = CAVV not validated because erroneous data was submitted.
1 = CAVV failed validation.
2 = CAVV passed validation.
3 = CAVV validation could not be performed; issuer attempt incomplete.
4 = CAVV validation could not be performed; issuer system error.
5 = Reserved for future use.
6 = Reserved for future use.
7 = CAVV attempt — failed validation — issuer available (U.S.-issued card/non-U.S acquirer).
8 = CAVV attempt — passed validation — issuer available (U.S.-issued card/non-U.S. acquirer).
9 = CAVV attempt — failed validation — issuer unavailable (U.S.-issued card/non-U.S. acquirer).
A = CAVV attempt — passed validation — issuer unavailable (U.S.-issued card/non-U.S. acquirer).
B = CAVV passed validation, information only, no liability shift.
transId The payment gateway assigned identification number for transaction.
The transId value must be used for any follow-on transactions such as a credit, prior authorization and capture, or void.
When testRequest is set to a positive response, or when Test Mode is enabled on the payment gateway, this value will be 0.
refTransId The transaction ID of a related, previously settled transaction.
transHash Payment gateway-generated MD5 hash value that can be used to authenticate the transaction response.
Because transaction responses are returned using an SSL connection, this feature is not necessary for AIM.
Alphanumeric.
testRequest
Indicates whether or not to treat this request as a test transaction.
true, false,1,0.
accountNumber
accountType
messages This element contains one or more elements.
message These messages contain detailed information about the status of a particular transaction.
code Response code that represents the status.
description Text description of the status.
errors This element contains one or more elements.
error This element contains detailed information about any errors returned.
errorCode Error code returned.
errorText Text description of error.
splitTenderPayments If the transaction was a partial authorization transaction, then the split tender payment detail information is listed in this section.
splitTenderPayment Contains information about one split tender transaction.
transId The payment gateway assigned identification number for the transaction.
When the testRequest field is set to a positive response, or when Test Mode is enabled on the payment gateway, this value will be 0.
responseCode The overall status of the transaction.
1 = Approved
2 = Declined
3 = Error
4 = Held for Review
responseToCustomer
authCode The authorization or approval code.
6 characters.
accountNumber Last 4 digits of the card provided.
This field is returned with all transactions.
Alphanumeric (XXXX6835)
accountType Visa, MasterCard, American Express, Discover, Diners Club, or JCB.
Text.
requestedAmount Amount requested in original authorization.
Present if the current transaction is for a prepaid card or if the splitTenderId field was sent in.
Numeric.
approvedAmount Amount approved.
Present if the current transaction is for a prepaid card or if the splitTenderId field was sent in.
balanceOnCard Balance on the debit card or prepaid card.
Can be a positive or negative number. Has a value only if the current transaction is for a prepaid card.
Numeric.
userFields This element contains user fields, if any are defined.
Name Name of user-defined field.
These values are only echoed back in the response, and are also added to the merchant receipts. No other action is taken with user-defined fields.
value Value of user-defined field.
These values are only echoed back in the response, and are also added to the merchant receipts. No other action is taken with user-defined fields.
Request:

Live API Console requests are not supported in IE9 or below.

Enter your sandbox credentials below and all the sample requests will be run against this account. You can sign up for an account really quickly here.

Ok, you're in a real hurry right now, we understand, click here to use default sandbox credentials.

Response:
Loading...
View :

URL :

URL :

URL :

URL :

URL :

URL :

Capture Funds Authorized Through Another Channel

Use this method to capture funds which have been authorized through another channel. For example, phone authorization. If you need to capture an authorizeOnlyTransaction, use priorAuthCaptureTransaction instead.

createTransactionRequest

Element Description Format
merchantAuthentication Required.
Contains merchant authentication information.
name Required.
Merchant’s unique API Login ID.
The merchant API Login ID is provided in the Merchant Interface and must be stored securely.

The API Login ID and Transaction Key together provide the merchant authentication required for access to the payment gateway.
20-character maximum.
transactionKey Required.
Merchant’s unique Transaction Key.
The merchant Transaction Key is provided in the Merchant Interface and must be stored securely.

The API Login ID and Transaction Key together provide the merchant authentication required for access to the payment gateway.
16-character maximum.
refId Merchant-assigned reference ID for the request.
If included in the request, this value is included in the response. This feature might be especially useful for multi-threaded applications.
Up to 20 characters.
transactionRequest Required.
This element is a container for transaction specific information.
transactionType Type of credit card transaction.
If the value submitted does not match a supported value, the transaction is rejected.
captureOnlyTransaction
amount Required.
Amount of the transaction.
This is the total amount and must include tax, shipping, and any other charges.
15-digits maximum with a decimal point (no currency sign or symbol). For example, 8.95
terminalNumber The merchant's in-store terminal number. Can identify the cashiers or kiosks used.
Do not use your processor's terminal ID for this field.
Alphanumeric.
authCode Required.
string
Authorization code. This may have been obtained from a verbal authorization or through another channel.
employeeId Merchant-assigned employee ID.
The employeeId field is required for the EVO processor, and is supported on the TSYS processor. If a value is not passed with the field, Authorize.Net sends a default value of 0000 to the processor.
Numeric, 4 digits.
surcharge Used to record payment card surcharges that are passed along to customers. Contains an amount and a description child element.
Currently supported for TSYS merchants.

For details on surcharge rules, please see Visa's merchant regulations and fees.
amount Amount of the surcharge.
Currently supported for TSYS merchants.

For details on surcharge rules, please see Visa's merchant regulations and fees.
15-digits maximum with a decimal point (no currency sign or symbol). For example, 8.95
description Describes the reason or details for the surcharge.
Currently supported for TSYS merchants.

For details on surcharge rules, please see Visa's merchant regulations and fees.
merchantDescriptor Provides the option to submit a soft descriptor that will appear on the cardholder's statement with the charge.
Currently supported for TSYS merchants.
25 characters, alphanumeric
order Contains information about the order.
invoiceNumber Merchant-defined invoice number associated with the order.
String. 20-character maximum.
description Description of the item purchased.
String. 255-character maximum.
surcharge Used to record payment card surcharges that are passed along to customers. Contains an amount and a description child element.
Currently supported for TSYS merchants.

For details on surcharge rules, please see Visa's merchant regulations and fees.
amount Amount of the surcharge.
Currently supported for TSYS merchants.

For details on surcharge rules, please see Visa's merchant regulations and fees.
15-digits maximum with a decimal point (no currency sign or symbol). For example, 8.95
description Describes the reason or details for the surcharge.
Currently supported for TSYS merchants.

For details on surcharge rules, please see Visa's merchant regulations and fees.
merchantDescriptor Provides the option to submit a soft descriptor that will appear on the cardholder's statement with the charge.
Currently supported for TSYS merchants.
25 characters, alphanumeric

createTransactionResponse

Element Description Format
refId Merchant-assigned reference ID for the request.
If included in the request, this value is included in the response. This feature might be especially useful for multi-threaded applications.
Up to 20 characters.
messages This section contains information about the results of the request.
resultCode Ok or Error.
Contains additional information about the status of the request.
message Contains specific message information.
code Code number for message.
I00001
E000001
text Text for the error message.
sessionToken Returned for mobile device transactions, instead of a transactionKey.
transactionResponse
responseCode Overall status of the transaction.
1 = Approved
2 = Declined
3 = Error
4 = Held for Review
authCode Authorization or approval code.
6 characters.
avsResultCode Address Verification Service (AVS) response code.
Indicates the result of the AVS filter.
A = Address (Street) matches, ZIP does not.
B = Address information not provided for AVS check.
E = AVS error.
G = Non-U.S. Card Issuing Bank.
N = No Match on Address (Street) or ZIP.
P = AVS not applicable for this transaction.
R = Retry — System unavailable or timed out.
S = Service not supported by issuer.
U = Address information is unavailable.
W = Nine digit ZIP matches, Address (Street) does not.
X = Address (Street) and nine digit ZIP match.
Y = Address (Street) and five digit ZIP match.
Z = Five digit ZIP matches, Address (Street) does not.
cvvResultCode Card code verification (CCV) response code.
Indicates result of the CCV filter.
M = Match.
N = No Match.
P = Not Processed.
S = Should have been present.
U = Issuer unable to process request.
cavvResultCode Cardholder authentication verification response code.
Blank or not present = CAVV not validated.
0 = CAVV not validated because erroneous data was submitted.
1 = CAVV failed validation.
2 = CAVV passed validation.
3 = CAVV validation could not be performed; issuer attempt incomplete.
4 = CAVV validation could not be performed; issuer system error.
5 = Reserved for future use.
6 = Reserved for future use.
7 = CAVV attempt — failed validation — issuer available (U.S.-issued card/non-U.S acquirer).
8 = CAVV attempt — passed validation — issuer available (U.S.-issued card/non-U.S. acquirer).
9 = CAVV attempt — failed validation — issuer unavailable (U.S.-issued card/non-U.S. acquirer).
A = CAVV attempt — passed validation — issuer unavailable (U.S.-issued card/non-U.S. acquirer).
B = CAVV passed validation, information only, no liability shift.
transId The payment gateway assigned identification number for transaction.
The transId value must be used for any follow-on transactions such as a credit, prior authorization and capture, or void.
When testRequest is set to a positive response, or when Test Mode is enabled on the payment gateway, this value will be 0.
refTransId The transaction ID of a related, previously settled transaction.
transHash Payment gateway-generated MD5 hash value that can be used to authenticate the transaction response.
Because transaction responses are returned using an SSL connection, this feature is not necessary for AIM.
Alphanumeric.
testRequest
Indicates whether or not to treat this request as a test transaction.
true, false,1,0.
accountNumber
accountType
messages This element contains one or more elements.
message These messages contain detailed information about the status of a particular transaction.
code Response code that represents the status.
description Text description of the status.
errors This element contains one or more elements.
error This element contains detailed information about any errors returned.
errorCode Error code returned.
errorText Text description of error.
splitTenderPayments If the transaction was a partial authorization transaction, then the split tender payment detail information is listed in this section.
splitTenderPayment Contains information about one split tender transaction.
transId The payment gateway assigned identification number for the transaction.
When the testRequest field is set to a positive response, or when Test Mode is enabled on the payment gateway, this value will be 0.
responseCode The overall status of the transaction.
1 = Approved
2 = Declined
3 = Error
4 = Held for Review
responseToCustomer
authCode The authorization or approval code.
6 characters.
accountNumber Last 4 digits of the card provided.
This field is returned with all transactions.
Alphanumeric (XXXX6835)
accountType Visa, MasterCard, American Express, Discover, Diners Club, or JCB.
Text.
requestedAmount Amount requested in original authorization.
Present if the current transaction is for a prepaid card or if the splitTenderId field was sent in.
Numeric.
approvedAmount Amount approved.
Present if the current transaction is for a prepaid card or if the splitTenderId field was sent in.
balanceOnCard Balance on the debit card or prepaid card.
Can be a positive or negative number. Has a value only if the current transaction is for a prepaid card.
Numeric.
userFields This element contains user fields, if any are defined.
Name Name of user-defined field.
These values are only echoed back in the response, and are also added to the merchant receipts. No other action is taken with user-defined fields.
value Value of user-defined field.
These values are only echoed back in the response, and are also added to the merchant receipts. No other action is taken with user-defined fields.
Request:

Live API Console requests are not supported in IE9 or below.

Enter your sandbox credentials below and all the sample requests will be run against this account. You can sign up for an account really quickly here.

Ok, you're in a real hurry right now, we understand, click here to use default sandbox credentials.

Response:
Loading...
View :

URL :

URL :

URL :

URL :

URL :

URL :

Refund a Transaction

This transaction type is used to refund a customer for a transaction that was successfully settled through the payment gateway. Note that credit card information and bank account information are mutually exclusive, so you should not submit both.

createTransactionRequest

Element Description Format
merchantAuthentication Required.
Contains merchant authentication information.
name Required.
Merchant’s unique API Login ID.
The merchant API Login ID is provided in the Merchant Interface and must be stored securely.

The API Login ID and Transaction Key together provide the merchant authentication required for access to the payment gateway.
20-character maximum.
transactionKey Required.
Merchant’s unique Transaction Key.
The merchant Transaction Key is provided in the Merchant Interface and must be stored securely.

The API Login ID and Transaction Key together provide the merchant authentication required for access to the payment gateway.
16-character maximum.
refId Merchant-assigned reference ID for the request.
If included in the request, this value is included in the response. This feature might be especially useful for multi-threaded applications.
Up to 20 characters.
transactionRequest Required.
This element is a container for transaction specific information.
transactionType Type of credit card transaction.
If the value submitted does not match a supported value, the transaction is rejected.
refundTransaction
amount Required.
Amount of the transaction.
This is the total amount and must include tax, shipping, and any other charges.
15-digits maximum with a decimal point (no currency sign or symbol). For example, 8.95
terminalNumber The merchant's in-store terminal number. Can identify the cashiers or kiosks used.
Do not use your processor's terminal ID for this field.
Alphanumeric.
refTransId Required.
Transaction ID of the original settled transaction.
String.
payment This section includes payment information.
creditCard The following elements belong to the element; include them only for credit card transactions.
When issuing a credit card refund, the request must include either a full card number and expiration, or previous transId and last 4 digits of the card number. If you don't have the last 4 digits, you can use getTransactionDetails to get the payment object needed to issue a refund.
cardNumber Required.
The customer’s credit card number.
4 digits without spaces.

Only the last four digits are required for credit card refunds.
expirationDate Required.
The expiration date should be submitted masked as simply "XXXX"
Optional for Card Present.
bankAccount The following element belongs to the bankAccount element; include it only for bank account transactions.
accountNumber Account number, masked.
XXXX1111
order Contains information about order.
invoiceNumber Merchant-defined invoice number associated with the order.
description Description of the item purchased.
lineItems Contains one or more elements (the maximum is 30 line items.
lineItem Describes one line item of the order.
itemId Item identification.
Up to 31 characters.
name Name of the item.
Up to 31 characters.
description Description of the item.
Up to 255 characters.
quantity Quantity purchased.
Up to two decimal places. Must be a positive number.
unitPrice Price of an item per unit, excluding tax, freight, and duty.
tax Contains information about any taxes applied.
amount Amount of tax. Total amount of the transaction must include this amount.
Format can include up to two decimal points. For example, 1.27.
name Name of tax.
description Description of tax.
duty Contains information about any duty applied.
amount Amount of duty.
name Name of duty.
description Description of duty.
shipping Contains shipping information.
amount Items in this section describe shipping charges applied.
name Amount of shipping charges.
description Description of shipping charges.
taxExempt Indicates whether or not order is exempt from tax.
true, false
poNumber The merchant-assigned purchase order number.
Purchase order number must be created dynamically on the merchant's server or provided on a per-transaction basis. The payment gateway does not perform this function.
Up to 25 characters (no symbols).
customer The following fields contain customer information.
type Type of customer.
individual, business
id Merchant assigned customer ID.
Unique identifier to represent the customer associated with the transaction.
Customer ID must be created dynamically on the merchant's server or provided for each transaction. The payment gateway does not perform this function.
Up to 20 characters (no symbols).
email The customer’s valid email address.
Required only when using a European Payment Processor.

Email address to which the customer’s copy of the email receipt is sent when Email Receipts is configured in the Merchant Interface. The email is sent to the customer only if the email address format is valid.
Up to 255 characters.
For example, janedoe@customer.com
billTo This section contains billing address information.
If EVO is your payment processor and you submit any of the following billTo fields, you must submit all of them.

firstName
lastName
address
city
state
zip
firstName First name associated with customer’s billing address.

Required only when using a European Payment Processor.
Up to 50 characters (no symbols).
lastName Last name associated with customer’s billing address.

Required only when using a European Payment Processor.
Up to 50 characters (no symbols).
company Company associated with customer’s billing address.
Up to 50 characters (no symbols).
address Customer’s billing address.

Required if merchant would like to use the Address Verification Service security feature.

Required when using GPN Canada or Worldpay Streamline Processing Platform.
Up to 60 characters (no symbols).
city City of customer’s billing address.

Required only when using a European Payment Processor.
Up to 40 characters (no symbols).
state State of customer’s billing address.

Required only when using a European Payment Processor.
Up to 40 characters (no symbols) or a valid two-character state code.
zip ZIP code of customer’s billing address.

Required if merchant would like to use the Address Verification Service security feature.

Required when using GPN Canada or Worldpay Streamline Processing Platform.
Up to 20 characters (no symbols).
country Country of customer’s billing address.

Required only when using a European Payment Processor.
Up to 60 characters (no symbols).
phoneNumber Phone number associated with customer’s billing address.
Up to 25 digits (no letters).
For example,
(123)123-1234
faxNumber Fax number associated with customer’s billing address.
Up to 25 digits (no letters).
For example,
(123)123-1234
shipTo This section contains shipping information.
If EVO is your payment processor and you submit any of the following shipTo fields, you must submit all of them.

firstName
lastName
address
city
state
zip
firstName First name associated with customer’s shipping address.
Up to 50 characters (no symbols).
lastName Last name associated with customer’s shipping address.
Up to 50 characters (no symbols).
company Company associated with customer’s shipping address.
Up to 50 characters (no symbols).
address Customer’s shipping address.
Up to 60 characters (no symbols).
city City of customer’s shipping address.

Up to 40 characters (no symbols).
state State of customer’s shipping address.
Up to 40 characters (no symbols) or a valid two-character state code.
zip ZIP code of customer’s shipping address.
Up to 20 characters (no symbols).
country Country of customer’s shipping address.
Up to 60 characters (no symbols).
employeeId Merchant-assigned employee ID.
The employeeId field is required for the EVO processor, and is supported on the TSYS processor. If a value is not passed with the field, Authorize.Net sends a default value of 0000 to the processor.
Numeric, 4 digits.
transactionSettings This section contains one or more setting elements.
setting Contains settingName and settingValue.
settingName Name of a specific setting to be modified for this transaction.
Setting recurringBilling to true does not create a recurring transaction. This data is simply passed to the payment processor. To create a recurring transaction, see the Recurring Billing documentation.
One of the following:

allowPartialAuth
duplicateWindow
emailCustomer
recurringBilling
settingValue Indicate whether the specified setting is enabled or disabled.
Boolean (true, false, 1, or 0)
surcharge Used to record payment card surcharges that are passed along to customers. Contains an amount and a description child element.
Currently supported for TSYS merchants.

For details on surcharge rules, please see Visa's merchant regulations and fees.
amount Amount of the surcharge.
Currently supported for TSYS merchants.

For details on surcharge rules, please see Visa's merchant regulations and fees.
15-digits maximum with a decimal point (no currency sign or symbol). For example, 8.95
description Describes the reason or details for the surcharge.
Currently supported for TSYS merchants.

For details on surcharge rules, please see Visa's merchant regulations and fees.
merchantDescriptor Provides the option to submit a soft descriptor that will appear on the cardholder's statement with the charge.
Currently supported for TSYS merchants.
25 characters, alphanumeric
userFields Any value supplied by the merchant. This data is not stored with the transaction, and is only available in the transaction response
name Name of the user-defined field.

User reference field provided by the system for the merchant’s use. The value of this field will return to the merchant in the response exactly as it was submitted.
value Value of the user-defined field.

User reference field provided by the system for the merchant’s use. The value of this field will return to the merchant in the response exactly as it was submitted.
surcharge Used to record payment card surcharges that are passed along to customers. Contains an amount and a description child element.
Currently supported for TSYS merchants.

For details on surcharge rules, please see Visa's merchant regulations and fees.
amount Amount of the surcharge.
Currently supported for TSYS merchants.

For details on surcharge rules, please see Visa's merchant regulations and fees.
15-digits maximum with a decimal point (no currency sign or symbol). For example, 8.95
description Describes the reason or details for the surcharge.
Currently supported for TSYS merchants.

For details on surcharge rules, please see Visa's merchant regulations and fees.
merchantDescriptor Provides the option to submit a soft descriptor that will appear on the cardholder's statement with the charge.
Currently supported for TSYS merchants.
25 characters, alphanumeric

createTransactionResponse

Element Description Format
refId Merchant-assigned reference ID for the request.
If included in the request, this value is included in the response. This feature might be especially useful for multi-threaded applications.
Up to 20 characters.
messages This section contains information about the results of the request.
resultCode Ok or Error.
Contains additional information about the status of the request.
message Contains specific message information.
code Code number for message.
I00001
E000001
text Text for the error message.
transactionResponse
responseCode Overall status of the transaction.
1 = Approved
2 = Declined
3 = Error
4 = Held for Review
avsResultCode Address Verification Service (AVS) response code.
Indicates the result of the AVS filter.
A = Address (Street) matches, ZIP does not.
B = Address information not provided for AVS check.
E = AVS error.
G = Non-U.S. Card Issuing Bank.
N = No Match on Address (Street) or ZIP.
P = AVS not applicable for this transaction.
R = Retry — System unavailable or timed out.
S = Service not supported by issuer.
U = Address information is unavailable.
W = Nine digit ZIP matches, Address (Street) does not.
X = Address (Street) and nine digit ZIP match.
Y = Address (Street) and five digit ZIP match.
Z = Five digit ZIP matches, Address (Street) does not.
cvvResultCode Card code verification (CCV) response code.
Indicates result of the CCV filter.
M = Match.
N = No Match.
P = Not Processed.
S = Should have been present.
U = Issuer unable to process request.
cavvResultCode Cardholder authentication verification response code.
Blank or not present = CAVV not validated.
0 = CAVV not validated because erroneous data was submitted.
1 = CAVV failed validation.
2 = CAVV passed validation.
3 = CAVV validation could not be performed; issuer attempt incomplete.
4 = CAVV validation could not be performed; issuer system error.
5 = Reserved for future use.
6 = Reserved for future use.
7 = CAVV attempt — failed validation — issuer available (U.S.-issued card/non-U.S acquirer).
8 = CAVV attempt — passed validation — issuer available (U.S.-issued card/non-U.S. acquirer).
9 = CAVV attempt — failed validation — issuer unavailable (U.S.-issued card/non-U.S. acquirer).
A = CAVV attempt — passed validation — issuer unavailable (U.S.-issued card/non-U.S. acquirer).
B = CAVV passed validation, information only, no liability shift.
transId The payment gateway assigned identification number for transaction.
The transId value must be used for any follow-on transactions such as a credit, prior authorization and capture, or void.
When testRequest is set to a positive response, or when Test Mode is enabled on the payment gateway, this value will be 0.
refTransId The transaction ID of a related, previously settled transaction.
transHash Payment gateway-generated MD5 hash value that can be used to authenticate the transaction response.
Because transaction responses are returned using an SSL connection, this feature is not necessary for AIM.
Alphanumeric.
testRequest
Indicates whether or not to treat this request as a test transaction.
true, false,1,0.
accountNumber
accountType
messages This element contains one or more message elements.
message These messages contain detailed information about the status of a particular transaction.
code Response code that represents the status.
description Text description of the status.
errors This element contains one or more elements.
error This element contains detailed information about any errors returned.
errorCode Error code returned.
errorText Text description of error.
Request:

Live API Console requests are not supported in IE9 or below.

Enter your sandbox credentials below and all the sample requests will be run against this account. You can sign up for an account really quickly here.

Ok, you're in a real hurry right now, we understand, click here to use default sandbox credentials.

Response:
Loading...
View :

URL :

URL :

URL :

URL :

URL :

URL :

Void a Transaction

This transaction type can be used to cancel either an original transaction that is not yet settled or an entire order composed of more than one transaction. A Void prevents the transaction or the order from being sent for settlement. A Void can be submitted against any other transaction type

createTransactionRequest

Element Description Format
merchantAuthentication Required.
Contains merchant authentication information.
name Required.
Merchant’s unique API Login ID.
The merchant API Login ID is provided in the Merchant Interface and must be stored securely.

The API Login ID and Transaction Key together provide the merchant authentication required for access to the payment gateway.
20-character maximum.
transactionKey Required.
Merchant’s unique Transaction Key.
The merchant Transaction Key is provided in the Merchant Interface and must be stored securely.

The API Login ID and Transaction Key together provide the merchant authentication required for access to the payment gateway.
16-character maximum.
refId Merchant-assigned reference ID for the request.
If included in the request, this value is included in the response. This feature might be especially useful for multi-threaded applications.
Up to 20 characters.
transactionRequest Required.
This element is a container for transaction specific information.
transactionType Type of credit card transaction.
If the value submitted does not match a supported value, the transaction is rejected.
voidTransaction
terminalNumber The merchant's in-store terminal number. Can identify the cashiers or kiosks used.
Do not use your processor's terminal ID for this field.
Alphanumeric.
refTransId Required.
Transaction ID of an unsettled transaction.
String.

createTransactionResponse

Element Description Format
refId Merchant-assigned reference ID for the request.
If included in the request, this value is included in the response. This feature might be especially useful for multi-threaded applications.
Up to 20 characters.
messages This section contains information about the results of the request.
resultCode Ok or Error.
Contains additional information about the status of the request.
message Contains specific message information.
code Code number for message.
I00001
E000001
text Text for the error message.
sessionToken Returned for mobile device transactions, instead of a transactionKey.
transactionResponse
responseCode Overall status of the transaction.
1 = Approved
2 = Declined
3 = Error
4 = Held for Review
authCode Authorization or approval code.
6 characters.
avsResultCode Address Verification Service (AVS) response code.
Indicates the result of the AVS filter.
A = Address (Street) matches, ZIP does not.
B = Address information not provided for AVS check.
E = AVS error.
G = Non-U.S. Card Issuing Bank.
N = No Match on Address (Street) or ZIP.
P = AVS not applicable for this transaction.
R = Retry — System unavailable or timed out.
S = Service not supported by issuer.
U = Address information is unavailable.
W = Nine digit ZIP matches, Address (Street) does not.
X = Address (Street) and nine digit ZIP match.
Y = Address (Street) and five digit ZIP match.
Z = Five digit ZIP matches, Address (Street) does not.
cvvResultCode Card code verification (CCV) response code.
Indicates result of the CCV filter.
M = Match.
N = No Match.
P = Not Processed.
S = Should have been present.
U = Issuer unable to process request.
cavvResultCode Cardholder authentication verification response code.
Blank or not present = CAVV not validated.
0 = CAVV not validated because erroneous data was submitted.
1 = CAVV failed validation.
2 = CAVV passed validation.
3 = CAVV validation could not be performed; issuer attempt incomplete.
4 = CAVV validation could not be performed; issuer system error.
5 = Reserved for future use.
6 = Reserved for future use.
7 = CAVV attempt — failed validation — issuer available (U.S.-issued card/non-U.S acquirer).
8 = CAVV attempt — passed validation — issuer available (U.S.-issued card/non-U.S. acquirer).
9 = CAVV attempt — failed validation — issuer unavailable (U.S.-issued card/non-U.S. acquirer).
A = CAVV attempt — passed validation — issuer unavailable (U.S.-issued card/non-U.S. acquirer).
B = CAVV passed validation, information only, no liability shift.
transId The payment gateway assigned identification number for transaction.
The transId value must be used for any follow-on transactions such as a credit, prior authorization and capture, or void.
When testRequest is set to a positive response, or when Test Mode is enabled on the payment gateway, this value will be 0.
refTransId The transaction ID of a related, previously settled transaction.
transHash Payment gateway-generated MD5 hash value that can be used to authenticate the transaction response.
Because transaction responses are returned using an SSL connection, this feature is not necessary for AIM.
Alphanumeric.
testRequest
Indicates whether or not to treat this request as a test transaction.
true, false,1,0.
accountNumber
accountType
messages This element contains one or more elements.
message These messages contain detailed information about the status of a particular transaction.
code Response code that represents the status.
description Text description of the status.
errors This element contains one or more elements.
error This element contains detailed information about any errors returned.
errorCode Error code returned.
errorText Text description of error.
splitTenderPayments If the transaction was a partial authorization transaction, then the split tender payment detail information is listed in this section.
splitTenderPayment Contains information about one split tender transaction.
transId The payment gateway assigned identification number for the transaction.
When the testRequest field is set to a positive response, or when Test Mode is enabled on the payment gateway, this value will be 0.
responseCode The overall status of the transaction.
1 = Approved
2 = Declined
3 = Error
4 = Held for Review
responseToCustomer
authCode The authorization or approval code.
6 characters.
accountNumber Last 4 digits of the card provided.
This field is returned with all transactions.
Alphanumeric (XXXX6835)
accountType Visa, MasterCard, American Express, Discover, Diners Club, or JCB.
Text.
requestedAmount Amount requested in original authorization.
Present if the current transaction is for a prepaid card or if the splitTenderId field was sent in.
Numeric.
approvedAmount Amount approved.
Present if the current transaction is for a prepaid card or if the splitTenderId field was sent in.
balanceOnCard Balance on the debit card or prepaid card.
Can be a positive or negative number. Has a value only if the current transaction is for a prepaid card.
Numeric.
Request:

Live API Console requests are not supported in IE9 or below.

Enter your sandbox credentials below and all the sample requests will be run against this account. You can sign up for an account really quickly here.

Ok, you're in a real hurry right now, we understand, click here to use default sandbox credentials.

Response:
Loading...
View :

URL :

URL :

URL :

URL :

URL :

URL :

Update Split Tender Group

Use this function to update the status of an existing order that contains multiple transactions with the same splitTenderId value.

updateSplitTenderGroupRequest

Element Description Format
merchantAuthentication Required.
Contains merchant authentication information.
name Required.
Merchant’s unique API Login ID.
The merchant API Login ID is provided in the Merchant Interface and must be stored securely.

The API Login ID and Transaction Key together provide the merchant authentication required for access to the payment gateway.
20-character maximum.
transactionKey Required.
Merchant’s unique Transaction Key.
The merchant Transaction Key is provided in the Merchant Interface and must be stored securely.

The API Login ID and Transaction Key together provide the merchant authentication required for access to the payment gateway.
16-character maximum.
refId Merchant-assigned reference ID for the request.
If included in the request, this value is included in the response. This feature might be especially useful for multi-threaded applications.
Up to 20 characters.
splitTenderId Required.
Payment gateway-assigned number associated with the order.
Numeric.
splitTenderStatus Indicates the status of all transactions associated with the order.
Use voided to void the entire order; use completed to indicate there are no further transactions in this order.
voided or completed

updateSplitTenderGroupResponse

Element Description Format
refId Merchant-assigned reference ID for the request.
If included in the request, this value is included in the response. This feature might be especially useful for multi-threaded applications.
Up to 20 characters.

For a SOAP Request/Response sample, see our SOAP method documentation.

Request:

Live API Console requests are not supported in IE9 or below.

Enter your sandbox credentials below and all the sample requests will be run against this account. You can sign up for an account really quickly here.

Ok, you're in a real hurry right now, we understand, click here to use default sandbox credentials.

Response:
Loading...
View :

URL :

URL :

URL :

URL :

URL :

URL :

Debit a Bank Account

Use this method to process an ACH debit transaction using bank account details.

createTransactionRequest

Element Description Format
merchantAuthentication Required.
Contains merchant authentication information.
name Required.
Merchant’s unique API Login ID.
The merchant API Login ID is provided in the Merchant Interface and must be stored securely.

The API Login ID and Transaction Key together provide the merchant authentication required for access to the payment gateway.
20-character maximum.
transactionKey Required.
Merchant’s unique Transaction Key.
The merchant Transaction Key is provided in the Merchant Interface and must be stored securely.

The API Login ID and Transaction Key together provide the merchant authentication required for access to the payment gateway.
16-character maximum.
refId Merchant-assigned reference ID for the request.
If included in the request, this value is included in the response. This feature might be especially useful for multi-threaded applications.
Up to 20 characters.
transactionRequest Required.
This element is a container for transaction specific information.
transactionType Type of transaction.
If the value submitted does not match a supported value, the transaction is rejected.
authCaptureTransaction
amount Required.
Amount of the transaction.
This is the total amount and must include tax, shipping, and any other charges.
15-digits maximum with a decimal point (no currency sign or symbol). For example, 8.95
payment This section includes payment information.
bankAccount The following elements belong to the bankAccount element; include them only for bank account transactions.
accountType
One of the following:

* checking
* savings
* businessChecking
accountNumber Account number, masked.
XXXX1111
routingNumber Bank's routing number.
XXXX0000
nameOnAccount Name of the person who holds the bank account.
22-Character Maximum
echeckType The type of eCheck transaction.
PPD, WEB, CCD, TEL, ARC, BOC
bankName The name of the bank.
checkNumber The number of the check.
This is required when echeckType is set to ARC or BOC.
profile The following field enables you to create a customer profile from the data sent to make the transaction.
createProfile true, false
If set to true, a CIM profile will be generated from the customer and payment data.
solution Contains information about the software that generated the transaction.
id The solution ID is generated by Authorize.Net and provided to the solution provider.
Alphanumeric. Up to 50 characters.
terminalNumber The merchant's in-store terminal number. Can identify the cashiers or kiosks used.
Do not use your processor's terminal ID for this field.
Alphanumeric.
order Contains information about the order.
invoiceNumber Merchant-defined invoice number associated with the order.
String. 20-character maximum.
description Description of the item purchased.
String. 255-character maximum.
lineItems Contains one or more lineItem elements (the maximum is 30 line items.
lineItem Describes one line item of the order.
itemId Item identification.
Up to 31 characters.
name Name of the item.
Up to 31 characters
description Description of the item.
Up to 255 characters.
quantity Quantity purchased.
Up to two decimal places. Must be a positive number.
unitPrice Price of one item.
Price of an item per unit, excluding tax, freight, and duty.
tax Contains information about any taxes applied.
amount Amount of tax.
Total amount of the transaction must include this amount.
Format can include up to two decimal points. For example, 1.27.
name Name of tax.
description Description of tax.
duty Contains information about any duty applied.
amount Amount of duty.
name Name of duty.
description Description of duty.
shipping Items in this section describe shipping charges applied.
amount Amount of shipping charges.
name Name of shipping charges.
description Description of shipping charges.
taxExempt Indicates whether or not order is exempt from tax.
true, false
poNumber The merchant-assigned purchase order number.
Purchase order number must be created dynamically on the merchant's server or provided on a per-transaction basis. The payment gateway does not perform this function.
Up to 25 characters (no symbols).
customer The following fields contain customer information.
type Type of customer.
individual, business
id Merchant assigned customer ID.
Unique identifier to represent the customer associated with the transaction.

Customer ID must be created dynamically on the merchant's server or provided for each transaction. The payment gateway does not perform this function.
Up to 20 characters (no symbols).
email The customer’s valid email address.
Required only when using a European Payment Processor. Processing Platform.

Email address to which the customer’s copy of the email receipt is sent when Email Receipts is configured in the Merchant Interface. The email is sent to the customer only if the email address format is valid.
Up to 255 characters.

For example, janedoe@customer.com
billTo This section contains billing address information.
firstName First name associated with customer’s billing address.
Required only when using a European Payment Processor.
Up to 50 characters (no symbols).
lastName Last name associated with customer’s billing address.
Required only when using a European Payment Processor.
Up to 50 characters (no symbols).
company Company associated with customer’s billing address.
Up to 50 characters (no symbols).
address Customer’s billing address.
Required if merchant would like to use the Address Verification Service security feature.

Required when using GPN Canada or Worldpay Streamline Processing Platform.
Up to 60 characters (no symbols).
city City of customer’s billing address.
Required only when using a European Payment Processor.
Up to 40 characters (no symbols).
state State of customer’s billing address.
Required only when using a European Payment Processor.
Up to 40 characters (no symbols) or a valid two-character state code.
zip ZIP code of customer’s billing address.
Required if merchant would like to use the Address Verification Service security feature.

Required when using GPN Canada or Worldpay Streamline Processing Platform.
Up to 20 characters (no symbols).
country Country of customer’s billing address.
Required only when using a European Payment Processor.
Up to 60 characters (no symbols).
phoneNumber Phone number associated with customer’s billing address.
Up to 25 digits (no letters).

For example,
(123)123-1234
faxNumber Fax number associated with customer’s billing address.
Up to 25 digits (no letters).

For example,
(123)123-1234
shipTo This section contains shipping information.
firstName First name associated with customer’s shipping address.
Up to 50 characters (no symbols).
lastName Last name associated with customer’s shipping address.
Up to 50 characters (no symbols).
company Company associated with customer’s shipping address.
Up to 50 characters (no symbols).
address Customer’s shipping address.
Up to 60 characters (no symbols).
city City of customer’s shipping address.
Up to 40 characters (no symbols).
state State of customer’s shipping address.
Up to 40 characters (no symbols) or a valid two-character state code.
zip ZIP code of customer’s shipping address.
Up to 20 characters (no symbols).
country Country of customer’s shipping address.
Up to 60 characters (no symbols).
customerIP IP address of customer initiating the transaction. If this value is not passed, it will default to 255.255.255.255.
Required only when the merchant is using customer IP based AFDS filters.
Up to 15 characters (no letters).

For example, 255.255.255.255
retail The retail element contains two elements: marketType and deviceType.
marketType 0 for ecommerce
1 for moto
2 for retail
Default value is 2.
deviceType 1, 2, 3, 4, 5, 7, 8, 9, 10
1 = Unknown
2 = Unattended Terminal
3 = Self Service Terminal
4 = Electronic Cash Register
5 = Personal Computer- Based Terminal
7 = Wireless POS
8 = Website
9 = Dial Terminal
10 = Virtual Terminal
transactionSettings This section contains one or more elements.
setting Contains settingName and settingValue.
settingName Name of a specific setting to be modified for this transaction.
Setting recurringBilling to true does not create a recurring transaction. This data is simply passed to the payment processor. To create a recurring transaction, see the Recurring Billing documentation.
One of the following:

allowPartialAuth
duplicateWindow
emailCustomer
recurringBilling
settingValue Indicate whether the specified setting is enabled or disabled.
Boolean (true, false, 1, or 0)
userFields User-defined fields are allowed. This data is not stored with the transaction and is only returned in the transaction response.
name Name of the user-defined field.
value Value of the user-defined field.

createTransactionResponse

Element Description Format
refId Merchant-assigned reference ID for the request.
If included in the request, this value is included in the response. This feature might be especially useful for multi-threaded applications.
Up to 20 characters.
messages This section contains information about the results of the request.
resultCode Ok or Error.
Contains additional information about the status of the request.
message Contains specific message information.
code Code number for message.
I00001
E000001
text Text for the error message.
sessionToken Returned for mobile device transactions, instead of a transactionKey.
transactionResponse Contains transaction response fields.
responseCode Overall status of the transaction.
1 = Approved
2 = Declined
3 = Error
4 = Held for Review
authCode Authorization or approval code.
6 characters.
avsResultCode Address Verification Service (AVS) response code.
Indicates the result of the AVS filter.
A = Address (Street) matches, ZIP does not.
B = Address information not provided for AVS check.
E = AVS error.
G = Non-U.S. Card Issuing Bank.
N = No Match on Address (Street) or ZIP.
P = AVS not applicable for this transaction.
R = Retry — System unavailable or timed out.
S = Service not supported by issuer.
U = Address information is unavailable.
W = Nine digit ZIP matches, Address (Street) does not.
X = Address (Street) and nine digit ZIP match.
Y = Address (Street) and five digit ZIP match.
Z = Five digit ZIP matches, Address (Street) does not.
cvvResultCode Card code verification (CCV) response code.
Indicates result of the CCV filter.
M = Match.
N = No Match.
P = Not Processed.
S = Should have been present.
U = Issuer unable to process request.
cavvResultCode Cardholder authentication verification response code.
Blank or not present = CAVV not validated.
0 = CAVV not validated because erroneous data was submitted.
1 = CAVV failed validation.
2 = CAVV passed validation.
3 = CAVV validation could not be performed; issuer attempt incomplete.
4 = CAVV validation could not be performed; issuer system error.
5 = Reserved for future use.
6 = Reserved for future use.
7 = CAVV attempt — failed validation — issuer available (U.S.-issued card/non-U.S acquirer).
8 = CAVV attempt — passed validation — issuer available (U.S.-issued card/non-U.S. acquirer).
9 = CAVV attempt — failed validation — issuer unavailable (U.S.-issued card/non-U.S. acquirer).
A = CAVV attempt — passed validation — issuer unavailable (U.S.-issued card/non-U.S. acquirer).
B = CAVV passed validation, information only, no liability shift.
transId The payment gateway assigned identification number for transaction.
The transId value must be used for any follow-on transactions such as a credit, prior authorization and capture, or void.
When testRequest is set to a positive response, or when Test Mode is enabled on the payment gateway, this value will be 0.
refTransId The transaction ID of a related, previously settled transaction.
transHash Payment gateway-generated MD5 hash value that can be used to authenticate the transaction response.
Because transaction responses are returned using an SSL connection, this feature is not necessary for AIM.
Alphanumeric.
testRequest
Indicates whether or not to treat this request as a test transaction.
true, false,1,0.
accountNumber
accountType
messages This element contains one or more elements.
message These messages contain detailed information about the status of a particular transaction.
code Response code that represents the status.
description Text description of the status.
errors This element contains one or more elements.
error This element contains detailed information about any errors returned.
errorCode Error code returned.
errorText Text description of error.
splitTenderPayments If the transaction was a partial authorization transaction, then the split tender payment detail information is listed in this section.
splitTenderPayment Contains information about one split tender transaction.
transId The payment gateway assigned identification number for the transaction.
When the testRequest field is set to a positive response, or when Test Mode is enabled on the payment gateway, this value will be 0.
responseCode
responseToCustomer
authCode
accountNumber Last 4 digits of the card provided.
This field is returned with all transactions.
Alphanumeric (XXXX6835)
accountType Visa, MasterCard, American Express, Discover, Diners Club, or JCB.
Text.
requestedAmount Amount requested in original authorization.
Present if the current transaction is for a prepaid card or if the splitTenderId field was sent in.
Numeric.
approvedAmount Amount approved.
Present if the current transaction is for a prepaid card or if the splitTenderId field was sent in.
balanceOnCard Balance on the debit card or prepaid card.
Can be a positive or negative number. Has a value only if the current transaction is for a prepaid card.
Numeric.
userFields This element contains user fields, if any are defined. This data is not stored with the transaction and is only returned in the transaction response.
Name Name of user-defined field.
These values are only echoed back in the response, and are also added to the merchant receipts. No other action is taken with user-defined fields.
value Value of user-defined field.
These values are only echoed back in the response, and are also added to the merchant receipts. No other action is taken with user-defined fields.
Request:

Live API Console requests are not supported in IE9 or below.

Enter your sandbox credentials below and all the sample requests will be run against this account. You can sign up for an account really quickly here.

Ok, you're in a real hurry right now, we understand, click here to use default sandbox credentials.

Response:
Loading...
View :

URL :

URL :

URL :

URL :

URL :

URL :

Credit a Bank Account

This transaction type is used to refund a customer using a bank account credit transaction.

createTransactionRequest

Element Description Format
merchantAuthentication Required.
Contains merchant authentication information.
name Required.
Merchant’s unique API Login ID.
The merchant API Login ID is provided in the Merchant Interface and must be stored securely.

The API Login ID and Transaction Key together provide the merchant authentication required for access to the payment gateway.
20-character maximum.
transactionKey Required.
Merchant’s unique Transaction Key.
The merchant Transaction Key is provided in the Merchant Interface and must be stored securely.

The API Login ID and Transaction Key together provide the merchant authentication required for access to the payment gateway.
16-character maximum.
refId Merchant-assigned reference ID for the request.
If included in the request, this value is included in the response. This feature might be especially useful for multi-threaded applications.
Up to 20 characters.
transactionRequest Required.
This element is a container for transaction specific information.
transactionType Type of transaction.
If the value submitted does not match a supported value, the transaction is rejected.
refundTransaction
amount Required.
Amount of the transaction.
This is the total amount and must include tax, shipping, and any other charges.
15-digits maximum with a decimal point (no currency sign or symbol). For example, 8.95
payment This section includes payment information.
bankAccount The following elements belong to the bankAccount element; include them only for bank account transactions.
accountNumber Account number, masked.
XXXX1111
profile The following fields enable you to charge a transaction using payment or shipping profiles.
customerProfileId The CIM customer ID.
Required if you are using a CIM profile as the source for payment or shipping information.
paymentProfile Contains payment profile information.
paymentProfileId The CIM payment profile ID.
Designates the payment profile to use for payment and billing information. Required if the paymentProfile element exists.
shippingProfileId The CIM shipping profile ID.
Optional. This field is mutually exclusive with the ShipTo section. Use one or the other.
solution Contains information about the software that generated the transaction.
id The solution ID is generated by Authorize.Net and provided to the solution provider.
Alphanumeric. Up to 50 characters.
terminalNumber The merchant's in-store terminal number. Can identify the cashiers or kiosks used.
Do not use your processor's terminal ID for this field.
Alphanumeric.
refTransId Required.
Transaction ID of the original settled transaction.
String.

createTransactionResponse

Element Description Format
refId Merchant-assigned reference ID for the request.
If included in the request, this value is included in the response. This feature might be especially useful for multi-threaded applications.
Up to 20 characters.
messages This section contains information about the results of the request.
resultCode Ok or Error.
Contains additional information about the status of the request.
message Contains specific message information.
code Code number for message.
I00001
E000001
text Text for the error message.
sessionToken Returned for mobile device transactions, instead of a transactionKey.
transactionResponse Contains transaction response information.
responseCode Overall status of the transaction.
1 = Approved
2 = Declined
3 = Error
4 = Held for Review
authCode Authorization or approval code.
6 characters.
avsResultCode Address Verification Service (AVS) response code.
Indicates the result of the AVS filter.
A = Address (Street) matches, ZIP does not.
B = Address information not provided for AVS check.
E = AVS error.
G = Non-U.S. Card Issuing Bank.
N = No Match on Address (Street) or ZIP.
P = AVS not applicable for this transaction.
R = Retry — System unavailable or timed out.
S = Service not supported by issuer.
U = Address information is unavailable.
W = Nine digit ZIP matches, Address (Street) does not.
X = Address (Street) and nine digit ZIP match.
Y = Address (Street) and five digit ZIP match.
Z = Five digit ZIP matches, Address (Street) does not.
cvvResultCode Card code verification (CCV) response code.
Indicates result of the CCV filter.
M = Match.
N = No Match.
P = Not Processed.
S = Should have been present.
U = Issuer unable to process request.
cavvResultCode Cardholder authentication verification response code.
Blank or not present = CAVV not validated.
0 = CAVV not validated because erroneous data was submitted.
1 = CAVV failed validation.
2 = CAVV passed validation.
3 = CAVV validation could not be performed; issuer attempt incomplete.
4 = CAVV validation could not be performed; issuer system error.
5 = Reserved for future use.
6 = Reserved for future use.
7 = CAVV attempt — failed validation — issuer available (U.S.-issued card/non-U.S acquirer).
8 = CAVV attempt — passed validation — issuer available (U.S.-issued card/non-U.S. acquirer).
9 = CAVV attempt — failed validation — issuer unavailable (U.S.-issued card/non-U.S. acquirer).
A = CAVV attempt — passed validation — issuer unavailable (U.S.-issued card/non-U.S. acquirer).
B = CAVV passed validation, information only, no liability shift.
transId The payment gateway assigned identification number for transaction.
The transId value must be used for any follow-on transactions such as a credit, prior authorization and capture, or void.
When testRequest is set to a positive response, or when Test Mode is enabled on the payment gateway, this value will be 0.
refTransId The transaction ID of a related, previously settled transaction.
transHash Payment gateway-generated MD5 hash value that can be used to authenticate the transaction response.
Because transaction responses are returned using an SSL connection, this feature is not necessary for AIM.
Alphanumeric.
testRequest Indicates whether or not to treat this request as a test transaction.
true, false,1,0.
accountNumber
accountType
messages This element contains one or more message elements.
message These messages contain detailed information about the status of a particular transaction.
code Response code that represents the status.
description Text description of the status.
errors This element contains one or more error elements.
error This element contains detailed information about any errors returned.
errorCode Error code returned.
errorText Text description of error.
splitTenderPayments If the transaction was a partial authorization transaction, then the split tender payment detail information is listed in this section.
splitTenderPayment Contains information about one split tender transaction.
transId The payment gateway assigned identification number for the transaction.
When the testRequest field is set to a positive response, or when Test Mode is enabled on the payment gateway, this value will be 0.
responseCode Overall status of the transaction.
1 = Approved

2 = Declined

3 = Error

4 = Held for Review
responseToCustomer
authCode The authorization or approval code.
6 characters.
accountNumber Last 4 digits of the card provided.
This field is returned with all transactions.
Alphanumeric (XXXX6835)
accountType Visa
MasterCard
American Express
Discover
Diners Club
JCB
Text.
requestedAmount Amount requested in original authorization.
Present if the current transaction is for a prepaid card or if the splitTenderId field was sent in.
Numeric.
approvedAmount Amount approved.
Present if the current transaction is for a prepaid card or if the splitTenderId field was sent in.
balanceOnCard Balance on the debit card or prepaid card.
Can be a positive or negative number. Has a value only if the current transaction is for a prepaid card.
Numeric.
order Contains information about the order.
invoiceNumber Merchant-defined invoice number associated with the order.
String. 20-character maximum.
description Description of the item purchased.
String. 255-character maximum.
Request:

Live API Console requests are not supported in IE9 or below.

Enter your sandbox credentials below and all the sample requests will be run against this account. You can sign up for an account really quickly here.

Ok, you're in a real hurry right now, we understand, click here to use default sandbox credentials.

Response:
Loading...
View :

URL :

URL :

URL :

URL :

URL :

URL :

Charge a Customer Profile

Use this method to authorize and capture a payment using a stored customer payment profile.
NOTE: You can use Customer Profiles with CreateTransaction by using the profile field and its children anywhere you can use credit card or bank account information.

createTransactionRequest

Element Description Format
merchantAuthentication Required.
Contains merchant authentication information.
name Required.
Merchant’s unique API Login ID.
The merchant API Login ID is provided in the Merchant Interface and must be stored securely.

The API Login ID and Transaction Key together provide the merchant authentication required for access to the payment gateway.
20-character maximum.
transactionKey Required.
Merchant’s unique Transaction Key.
The merchant Transaction Key is provided in the Merchant Interface and must be stored securely.

The API Login ID and Transaction Key together provide the merchant authentication required for access to the payment gateway.
16-character maximum.
refId Merchant-assigned reference ID for the request.
If included in the request, this value is included in the response. This feature might be especially useful for multi-threaded applications.
Up to 20 characters.
transactionRequest Required.
This element is a container for transaction specific information.
transactionType Type of credit card transaction.
If the value submitted does not match a supported value, the transaction is rejected.
authCaptureTransaction
amount Required.
Amount of the transaction.
This is the total amount and must include tax, shipping, and any other charges.
15-digits maximum with a decimal point (no currency sign or symbol). For example, 8.95
profile The following fields enable you to charge a transaction using payment or shipping profiles.
customerProfileId The CIM customer ID.
Required if you are using a CIM profile as the source for payment or shipping information.
paymentProfile Contains payment profile information.
paymentProfileId The CIM payment profile ID.
Designates the payment profile to use for payment and billing information. Required if the paymentProfile element exists.
cardCode Optional. Because card codes are not stored, they are not a part of the paymentProfileId. A merchant can choose to collect it at checkout for additional security.
shippingProfileId The CIM shipping
profile ID.
Optional. This field is mutually exclusive with the ShipTo section. Use one or the other.
solution Contains information about the software that generated the transaction.
id The solution ID is generated by Authorize.Net and provided to the solution provider.
Alphanumeric. Up to 50 characters.
order Contains information about the order.
invoiceNumber Merchant-defined invoice number associated with the order.
String. 20-character maximum.
description Description of the item purchased.
String. 255-character maximum.
lineItems Contains one or more elements (the maximum is 30 line items.
lineItem Describes one line item of the order.
itemId Item identification.
Up to 31 characters.
name Name of the item.
Up to 31 characters
description Description of the item.
Up to 255 characters.
quantity Quantity purchased.
Up to two decimal places. Must be a positive number
unitPrice Price of one item.
Cost of an item per unit, excluding tax, freight, and duty.
tax Contains information about any taxes applied.
amount Amount of tax.
Total amount of the transaction must include this amount.
Format can include up to two decimal points. For example, 1.27.
name Name of tax.
description Description of tax.
duty Contains information about any duty applied.
amount Amount of duty.
name Name of duty.
description Description of duty.
shipping Items in this section describe shipping charges applied.
amount Amount of shipping charges.
Description of shipping charges.
name Name of shipping charges.
description Description of shipping charges.
taxExempt Indicates whether or not order is exempt from tax.
true, false
poNumber The merchant-assigned purchase order number.
Purchase order number must be created dynamically on the merchant's server or provided on a per-transaction basis. The payment gateway does not perform this function.
Up to 25 characters (no symbols).
customer The following fields contain customer information.
type
individual, business
id Merchant assigned customer ID.
Unique identifier to represent the customer associated with the transaction.

Customer ID must be created dynamically on the merchant's server or provided for each transaction. The payment gateway does not perform this function.
Up to 20 characters (no symbols).
email The customer’s valid email address.
Required only when using a European Payment Processor. Processing Platform.

Email address to which the customer’s copy of the email receipt is sent when Email Receipts is configured in the Merchant Interface. The email is sent to the customer only if the email address format is valid.
Up to 255 characters.

For example, janedoe@customer.com
shipTo This section contains shipping information.
firstName First name associated with customer’s shipping address.
Up to 50 characters (no symbols).
lastName Last name associated with customer’s shipping address.
Up to 50 characters (no symbols).
company Company associated with customer’s shipping address.
Up to 50 characters (no symbols).
address Customer’s shipping address.
Up to 60 characters (no symbols).
city City of customer’s shipping address.
Up to 40 characters (no symbols).
state State of customer’s shipping address.
Up to 40 characters (no symbols) or a valid two-character state code.
zip ZIP code of customer’s shipping address.
Up to 20 characters (no symbols).
country Country of customer’s shipping address.
Up to 60 characters (no symbols).
customerIP IP address of customer initiating the transaction. If this value is not passed, it will default to 255.255.255.255.
Required only when the merchant is using customer IP based AFDS filters.
Up to 15 characters (no letters).

For example, 255.255.255.255
cardholderAuthentication Merchants using a third party cardholder authentication solution can submit the following authentication values with Visa and/or MasterCard transactions.

Note: invalid combinations of the following two fields will generate an error.
authenticationIndicator The electronic commerce indicator (ECI) value for a Visa transaction; or the universal cardholder authentication field indicator (UCAF) for a MasterCard transaction obtained by the merchant after the authentication process.
Required only for transactions processed through 3DSecure programs like Verified by Visa and SecureCode. When submitted with other transaction types, this value is ignored.

This field is currently supported through Chase Paymentech, FDMS Nashville, Global Payments and TSYS.
Special characters included in this value must be URL encoded.
cardholderAuthenticationValue The cardholder authentication verification value (CAVV) for a Visa transaction; or accountholder authentication value (AVV)/ universal cardholder authentication field (UCAF) for a MasterCard transaction obtained by the merchant after the authentication process.
Required only for authorization-only and authorization-and-capture transactions processed through 3DSecure programs like Verified by Visa and SecureCode. When submitted with other transaction types, this value is ignored.

This field is currently supported through Chase Paymentech, FDMS Nashville, Global Payments and TSYS.
Special characters included in this value must be URL encoded.
employeeId Merchant-assigned employee ID.
The employeeId field is required for the EVO processor, and is supported on the TSYS processor. If a value is not passed with the field, Authorize.Net sends a default value of 0000 to the processor.
Numeric, 4 digits.
transactionSettings This section contains one or more elements.
setting Contains settingName and settingValue.
settingName Name of a specific setting to be modified for this transaction.
Setting recurringBilling to true does not create a recurring transaction. This data is simply passed to the payment processor. To create a recurring transaction, see the Recurring Billing documentation.
One of the following:

allowPartialAuth
duplicateWindow
emailCustomer
recurringBilling
settingValue Indicate whether the specified setting is enabled or disabled.
Boolean (true, false, 1, or 0)
userFields Any value supplied by the merchant. This data is not stored with the transaction and is only returned in the transaction response.
name Name of the user-defined field.
User reference field provided by the system for the merchant’s use. The value of this field will return to the merchant in the response exactly as it was submitted.
value Value of the user-defined field.
User reference field provided by the system for the merchant’s use. The value of this field will return to the merchant in the response exactly as it was submitted.
surcharge Used to record payment card surcharges that are passed along to customers. Contains an amount and a description child element.
Currently supported for TSYS merchants.

For details on surcharge rules, please see Visa's merchant regulations and fees.
amount Amount of the surcharge.
Currently supported for TSYS merchants.

For details on surcharge rules, please see Visa's merchant regulations and fees.
15-digits maximum with a decimal point (no currency sign or symbol). For example, 8.95
description Describes the reason or details for the surcharge.
Currently supported for TSYS merchants.

For details on surcharge rules, please see Visa's merchant regulations and fees.
merchantDescriptor Provides the option to submit a soft descriptor that will appear on the cardholder's statement with the charge.
Currently supported for TSYS merchants.
25 characters, alphanumeric

createTransactionResponse

Element Description Format
refId Merchant-assigned reference ID for the request.
If included in the request, this value is included in the response. This feature might be especially useful for multi-threaded applications.
Up to 20 characters.
messages This section contains information about the results of the request.
resultCode Ok or Error.
Contains additional information about the status of the request.
message Contains specific message information.
code Code number for message.
I00001
E000001
text Text for the error message.
sessionToken Returned for mobile device transactions, instead of a transactionKey.
transactionResponse
responseCode Overall status of the transaction.
1 = Approved
2 = Declined
3 = Error
4 = Held for Review
authCode Authorization or approval code.
6 characters.
avsResultCode Address Verification Service (AVS) response code.
Indicates the result of the AVS filter.
A = Address (Street) matches, ZIP does not.
B = Address information not provided for AVS check.
E = AVS error.
G = Non-U.S. Card Issuing Bank.
N = No Match on Address (Street) or ZIP.
P = AVS not applicable for this transaction.
R = Retry — System unavailable or timed out.
S = Service not supported by issuer.
U = Address information is unavailable.
W = Nine digit ZIP matches, Address (Street) does not.
X = Address (Street) and nine digit ZIP match.
Y = Address (Street) and five digit ZIP match.
Z = Five digit ZIP matches, Address (Street) does not.
cvvResultCode Card code verification (CCV) response code.
Indicates result of the CCV filter.
M = Match.
N = No Match.
P = Not Processed.
S = Should have been present.
U = Issuer unable to process request.
cavvResultCode Cardholder authentication verification response code.
Blank or not present = CAVV not validated.
0 = CAVV not validated because erroneous data was submitted.
1 = CAVV failed validation.
2 = CAVV passed validation.
3 = CAVV validation could not be performed; issuer attempt incomplete.
4 = CAVV validation could not be performed; issuer system error.
5 = Reserved for future use.
6 = Reserved for future use.
7 = CAVV attempt — failed validation — issuer available (U.S.-issued card/non-U.S acquirer).
8 = CAVV attempt — passed validation — issuer available (U.S.-issued card/non-U.S. acquirer).
9 = CAVV attempt — failed validation — issuer unavailable (U.S.-issued card/non-U.S. acquirer).
A = CAVV attempt — passed validation — issuer unavailable (U.S.-issued card/non-U.S. acquirer).
B = CAVV passed validation, information only, no liability shift.
transId The payment gateway assigned identification number for transaction.
The transId value must be used for any follow-on transactions such as a credit, prior authorization and capture, or void.
When testRequest is set to a positive response, or when Test Mode is enabled on the payment gateway, this value will be 0.
refTransId The transaction ID of a related, previously settled transaction.
transHash Payment gateway-generated MD5 hash value that can be used to authenticate the transaction response.
Because transaction responses are returned using an SSL connection, this feature is not necessary for AIM.
Alphanumeric.
testRequest
Indicates whether or not to treat this request as a test transaction.
true, false,1,0.
accountNumber
accountType
messages This element contains one or more elements.
message These messages contain detailed information about the status of a particular transaction.
code Response code that represents the status.
description Text description of the status.
errors This element contains one or more elements.
error This element contains detailed information about any errors returned.
errorCode Error code returned.
errorText Text description of error.
splitTenderPayments If the transaction was a partial authorization transaction, then the split tender payment detail information is listed in this section.
splitTenderPayment Contains information about one split tender transaction.
transId The payment gateway assigned identification number for the transaction.
When the testRequest field is set to a positive response, or when Test Mode is enabled on the payment gateway, this value will be 0.
responseCode The overall status of the transaction.
1 = Approved
2 = Declined
3 = Error
4 = Held for Review
responseToCustomer
authCode The authorization or approval code.
6 characters.
accountNumber Last 4 digits of the card provided.
This field is returned with all transactions.
Alphanumeric (XXXX6835)
accountType Visa, MasterCard, American Express, Discover, Diners Club, or JCB.
Text.
requestedAmount Amount requested in original authorization.
Present if the current transaction is for a prepaid card or if the splitTenderId field was sent in.
Numeric.
approvedAmount Amount approved.
Present if the current transaction is for a prepaid card or if the splitTenderId field was sent in.
balanceOnCard Balance on the debit card or prepaid card.
Can be a positive or negative number. Has a value only if the current transaction is for a prepaid card.
Numeric.
userFields This element contains user fields, if any are defined.
Name Name of user-defined field.
These values are only echoed back in the response, and are also added to the merchant receipts. No other action is taken with user-defined fields.
value Value of user-defined field.
These values are only echoed back in the response, and are also added to the merchant receipts. No other action is taken with user-defined fields.
profileResponse Contains result of attempt to create a CIM profile.
messages Contains one or more message elements.
resultCode ok or error
message Contains detailed information about the status of a particular transaction.
code Response Code that represents status.
text Text description of status
customerProfileId Payment gateway assigned ID associated with the customer profile.
Numeric
customerPaymentProfileIdList Contains the Customer Payment Profile ID element
numericString Payment gateway assigned ID associated with the customer payment profile.
This is only included if the original transaction included a billing address.
Numeric
customerShippingProfileIdList Contains the Customer Shipping Profile ID element.
numericString Payment gateway assigned ID associated with the customer shipping profile.
This is only included if the original transaction included a shipping address.
Numeric
Request:

Live API Console requests are not supported in IE9 or below.

Enter your sandbox credentials below and all the sample requests will be run against this account. You can sign up for an account really quickly here.

Ok, you're in a real hurry right now, we understand, click here to use default sandbox credentials.

Response:
Loading...
View :

URL :

URL :

URL :

URL :

URL :

URL :

Charge a Tokenized Credit Card

Use this method to authorize and capture a payment using a tokenized credit card number. The processor must support payment network tokenization and the token must have been issued by a certified token provider.

createTransactionRequest

Element Description Format
merchantAuthentication Required.
Contains merchant authentication information.
name Required.
Merchant’s unique API Login ID.
The merchant API Login ID is provided in the Merchant Interface and must be stored securely.

The API Login ID and Transaction Key together provide the merchant authentication required for access to the payment gateway.
20-character maximum.
transactionKey Required.
Merchant’s unique Transaction Key.
The merchant Transaction Key is provided in the Merchant Interface and must be stored securely.

The API Login ID and Transaction Key together provide the merchant authentication required for access to the payment gateway.
16-character maximum.
refId Merchant-assigned reference ID for the request.
If included in the request, this value is included in the response. This feature might be especially useful for multi-threaded applications.
Up to 20 characters.
transactionRequest Required.
This element is a container for transaction specific information.
transactionType Type of credit card transaction.
If the value submitted does not match a supported value, the transaction is rejected.
authCaptureTransaction
amount Required.
Amount of the transaction.
This is the total amount and must include tax, shipping, and any other charges.
15-digits maximum with a decimal point (no currency sign or symbol). For example, 8.95
payment This section includes payment information.
creditCard Contains tokenized credit card information.
cardNumber Required.
The credit card token.
Between 13 and 16 digits without spaces.
expirationDate Required.
Set this to the value of the token expiration date.
YYYY-MM
isPaymentToken Flag to indicate the credit card is a payment network token.
Set this to true for recurring tokenized transactions.
True or False
cryptogram Required.
Set this to the value of the cryptogram received from the token provider.
This field confirms that the payment data is tokenized, and it must be submitted when the credit card number is a tokenized credit card.
Alphanumeric
solution Contains information about the software that generated the transaction.
id The solution ID is generated by Authorize.Net and provided to the solution provider.
Alphanumeric. Up to 50 characters.
terminalNumber The merchant's in-store terminal number. Can identify the cashiers or kiosks used.
Do not use your processor's terminal ID for this field.
Alphanumeric.
order Contains information about order.
invoiceNumber Merchant-defined invoice number associated with the order.
description Description of the item purchased.
lineItems Contains one or more elements (the maximum is 30 line items.
lineItem Describes one line item of the order.
itemId Item identification.
Up to 31 characters.
name Name of the item.
Up to 31 characters
description Description of the item.
Up to 255 characters.
quantity Quantity purchased.
Up to two decimal places. Must be a positive number
unitPrice Price of one item.
Cost of an item per unit, excluding tax, freight, and duty.
tax Contains information about any taxes applied.
amount Amount of tax.
Total amount of the transaction must include this amount.
Format can include up to two decimal points. For example, 1.27.
name Name of tax.
description Description of tax.
duty Contains information about any duty applied.
amount Amount of duty.
name Name of duty.
description Description of duty.
shipping Items in this section describe shipping charges applied.
amount Amount of shipping charges.
Description of shipping charges.
name Name of shipping charges.
description Description of shipping charges.
taxExempt Indicates whether or not order is exempt from tax.
true, false
poNumber The merchant-assigned purchase order number.
Purchase order number must be created dynamically on the merchant's server or provided on a per-transaction basis. The payment gateway does not perform this function.
Up to 25 characters (no symbols).
customer The following fields contain customer information.
type
individual, business
id Merchant assigned customer ID.
Unique identifier to represent the customer associated with the transaction.

Customer ID must be created dynamically on the merchant's server or provided for each transaction. The payment gateway does not perform this function.
Up to 20 characters (no symbols).
email The customer’s valid email address.
Required only when using a European Payment Processor. Processing Platform.

Email address to which the customer’s copy of the email receipt is sent when Email Receipts is configured in the Merchant Interface. The email is sent to the customer only if the email address format is valid.
Up to 255 characters.

For example, janedoe@customer.com
billTo This section contains billing address information.
If EVO is your payment processor and you submit any of the following billTo fields, you must submit all of them.

firstName
lastName
address
city
state
zip
firstName First name associated with customer’s billing address.
Required only when using a European Payment Processor.
Up to 50 characters (no symbols).
lastName Last name associated with customer’s billing address.
Required only when using a European Payment Processor.
Up to 50 characters (no symbols).
company Company associated with customer’s billing address.
Up to 50 characters (no symbols).
address Customer’s billing address.
Required if merchant would like to use the Address Verification Service security feature.

Required when using GPN Canada or Worldpay Streamline Processing Platform.
Up to 60 characters (no symbols).
city City of customer’s billing address.
Required only when using a European Payment Processor.
Up to 40 characters (no symbols).
state State of customer’s billing address.
Required only when using a European Payment Processor.
Up to 40 characters (no symbols) or a valid two-character state code.
zip ZIP code of customer’s billing address.
Required if merchant would like to use the Address Verification Service security feature.

Required when using GPN Canada or Worldpay Streamline Processing Platform.
Up to 20 characters (no symbols).
country Country of customer’s billing address.
Required only when using a European Payment Processor.
Up to 60 characters (no symbols).
phoneNumber Phone number associated with customer’s billing address.
Up to 25 digits (no letters).

For example,
(123)123-1234
faxNumber Fax number associated with customer’s billing address.
Up to 25 digits (no letters).

For example,
(123)123-1234
shipTo This section contains shipping information.
If EVO is your payment processor and you submit any of the following shipTo fields, you must submit all of them.

firstName
lastName
address
city
state
zip
firstName First name associated with customer’s shipping address.
Up to 50 characters (no symbols).
lastName Last name associated with customer’s shipping address.
Up to 50 characters (no symbols).
company Company associated with customer’s shipping address.
Up to 50 characters (no symbols).
address Customer’s shipping address.
Up to 60 characters (no symbols).
city City of customer’s shipping address.
Up to 40 characters (no symbols).
state State of customer’s shipping address.
Up to 40 characters (no symbols) or a valid two-character state code.
zip ZIP code of customer’s shipping address.
Up to 20 characters (no symbols).
country Country of customer’s shipping address.
Up to 60 characters (no symbols).
customerIP IP address of customer initiating the transaction. If this value is not passed, it will default to 255.255.255.255.
Required only when the merchant is using customer IP based AFDS filters.
Up to 15 characters (no letters).

For example, 255.255.255.255
cardholderAuthentication Merchants using a third party cardholder authentication solution can submit the following authentication values with Visa and/or MasterCard transactions.

Note: invalid combinations of the following two fields will generate an error.
authenticationIndicator The electronic commerce indicator (ECI) value for a Visa transaction; or the universal cardholder authentication field indicator (UCAF) for a MasterCard transaction obtained by the merchant after the authentication process.
Required only for transactions processed through 3DSecure programs like Verified by Visa and SecureCode. When submitted with other transaction types, this value is ignored.

This field is currently supported through Chase Paymentech, FDMS Nashville, Global Payments and TSYS.
Special characters included in this value must be URL encoded.
cardholderAuthenticationValue The cardholder authentication verification value (CAVV) for a Visa transaction; or accountholder authentication value (AVV)/ universal cardholder authentication field (UCAF) for a MasterCard transaction obtained by the merchant after the authentication process.
Required only for authorization-only and authorization-and-capture transactions processed through 3DSecure programs like Verified by Visa and SecureCode. When submitted with other transaction types, this value is ignored.

This field is currently supported through Chase Paymentech, FDMS Nashville, Global Payments and TSYS.
Special characters included in this value must be URL encoded.
retail The retail element contains two elements: marketType and deviceType.
marketType 0 for ecommerce
1 for moto
2 for retail
Default value is 2.
deviceType 1, 2, 3, 4, 5, 7, 8, 9, 10
1 = Unknown
2 = Unattended Terminal
3 = Self Service Terminal
4 = Electronic Cash Register
5 = Personal Computer- Based Terminal
7 = Wireless POS
8 = Website
9 = Dial Terminal
10 = Virtual Terminal
employeeId Merchant-assigned employee ID.
The employeeId field is required for the EVO processor, and is supported on the TSYS processor. If a value is not passed with the field, Authorize.Net sends a default value of 0000 to the processor.
Numeric, 4 digits.
transactionSettings This section contains one or more elements.
setting Contains settingName and settingValue.
settingName Name of a specific setting to be modified for this transaction.
Setting recurringBilling to true does not create a recurring transaction. This data is simply passed to the payment processor. To create a recurring transaction, see the Recurring Billing documentation.
One of the following:

allowPartialAuth
duplicateWindow
emailCustomer
recurringBilling
settingValue Indicate whether the specified setting is enabled or disabled.
Boolean (true, false, 1, or 0)
userFields Any value supplied by the merchant. This data is not stored with the transaction and is only returned in the transaction response.
name Name of the user-defined field.
User reference field provided by the system for the merchant’s use. The value of this field will return to the merchant in the response exactly as it was submitted.
value Value of the user-defined field.
User reference field provided by the system for the merchant’s use. The value of this field will return to the merchant in the response exactly as it was submitted.
surcharge Used to record payment card surcharges that are passed along to customers. Contains an amount and a description child element.
Currently supported for TSYS merchants.

For details on surcharge rules, please see Visa's merchant regulations and fees.
amount Amount of the surcharge.
Currently supported for TSYS merchants.

For details on surcharge rules, please see Visa's merchant regulations and fees.
15-digits maximum with a decimal point (no currency sign or symbol). For example, 8.95
description Describes the reason or details for the surcharge.
Currently supported for TSYS merchants.

For details on surcharge rules, please see Visa's merchant regulations and fees.
merchantDescriptor Provides the option to submit a soft descriptor that will appear on the cardholder's statement with the charge.
Currently supported for TSYS merchants.
25 characters, alphanumeric

createTransactionResponse

Element Description Format
refId Merchant-assigned reference ID for the request.
If included in the request, this value is included in the response. This feature might be especially useful for multi-threaded applications.
Up to 20 characters.
messages This section contains information about the results of the request.
resultCode Ok or Error.
Contains additional information about the status of the request.
message Contains specific message information.
code Code number for message.
I00001
E000001
text Text for the error message.
transactionResponse
responseCode Overall status of the transaction.
1 = Approved
2 = Declined
3 = Error
4 = Held for Review
authCode Authorization or approval code.
6 characters.
avsResultCode Address Verification Service (AVS) response code.
Indicates the result of the AVS filter.
A = Address (Street) matches, ZIP does not.
B = Address information not provided for AVS check.
E = AVS error.
G = Non-U.S. Card Issuing Bank.
N = No Match on Address (Street) or ZIP.
P = AVS not applicable for this transaction.
R = Retry — System unavailable or timed out.
S = Service not supported by issuer.
U = Address information is unavailable.
W = Nine digit ZIP matches, Address (Street) does not.
X = Address (Street) and nine digit ZIP match.
Y = Address (Street) and five digit ZIP match.
Z = Five digit ZIP matches, Address (Street) does not.
cvvResultCode Card code verification (CCV) response code.
Indicates result of the CCV filter.
M = Match.
N = No Match.
P = Not Processed.
S = Should have been present.
U = Issuer unable to process request.
cavvResultCode Cardholder authentication verification response code.
Blank or not present = CAVV not validated.
0 = CAVV not validated because erroneous data was submitted.
1 = CAVV failed validation.
2 = CAVV passed validation.
3 = CAVV validation could not be performed; issuer attempt incomplete.
4 = CAVV validation could not be performed; issuer system error.
5 = Reserved for future use.
6 = Reserved for future use.
7 = CAVV attempt — failed validation — issuer available (U.S.-issued card/non-U.S acquirer).
8 = CAVV attempt — passed validation — issuer available (U.S.-issued card/non-U.S. acquirer).
9 = CAVV attempt — failed validation — issuer unavailable (U.S.-issued card/non-U.S. acquirer).
A = CAVV attempt — passed validation — issuer unavailable (U.S.-issued card/non-U.S. acquirer).
B = CAVV passed validation, information only, no liability shift.
transId The payment gateway assigned identification number for transaction.
The transId value must be used for any follow-on transactions such as a credit, prior authorization and capture, or void.
When testRequest is set to a positive response, or when Test Mode is enabled on the payment gateway, this value will be 0.
refTransId The transaction ID of a related, previously settled transaction.
transHash Payment gateway-generated MD5 hash value that can be used to authenticate the transaction response.
Because transaction responses are returned using an SSL connection, this feature is not necessary for AIM.
Alphanumeric.
testRequest
Indicates whether or not to treat this request as a test transaction.
true, false,1,0.
accountNumber
accountType
messages This element contains one or more elements.
message These messages contain detailed information about the status of a particular transaction.
code Response code that represents the status.
description Text description of the status.
errors This element contains one or more elements.
error This element contains detailed information about any errors returned.
errorCode Error code returned.
errorText Text description of error.
splitTenderPayments If the transaction was a partial authorization transaction, then the split tender payment detail information is listed in this section.
splitTenderPayment Contains information about one split tender transaction.
transId The payment gateway assigned identification number for the transaction.
When the testRequest field is set to a positive response, or when Test Mode is enabled on the payment gateway, this value will be 0.
responseCode
responseToCustomer
authCode
accountNumber Last 4 digits of the card provided.
This field is returned with all transactions.
Alphanumeric (XXXX6835)
accountType Visa, MasterCard, American Express, Discover, Diners Club, or JCB.
Text.
requestedAmount Amount requested in original authorization.
Present if the current transaction is for a prepaid card or if the splitTenderId field was sent in.
Numeric.
approvedAmount Amount approved.
Present if the current transaction is for a prepaid card or if the splitTenderId field was sent in.
balanceOnCard Balance on the debit card or prepaid card.
Can be a positive or negative number. Has a value only if the current transaction is for a prepaid card.
Numeric.
userFields This element contains user fields, if any are defined.
Name Name of user-defined field.
These values are only echoed back in the response, and are also added to the merchant receipts. No other action is taken with user-defined fields.
value Value of user-defined field.
These values are only echoed back in the response, and are also added to the merchant receipts. No other action is taken with user-defined fields.
Request:

Live API Console requests are not supported in IE9 or below.

Enter your sandbox credentials below and all the sample requests will be run against this account. You can sign up for an account really quickly here.

Ok, you're in a real hurry right now, we understand, click here to use default sandbox credentials.

Response:
Loading...
View :

URL :

URL :

URL :

URL :

URL :

URL :

Create an Accept Payment Transaction

Use this function to create an Authorize.Net payment transaction request, using the Accept Payment Nonce in place of card data.

createTransactionRequest

Element Description Format
merchantAuthentication Required.
Contains merchant authentication information.
name Required.
Merchant’s unique API Login ID.
The merchant API Login ID is provided in the Merchant Interface and must be stored securely.

The API Login ID and Transaction Key together provide the merchant authentication required for access to the payment gateway.
20-character maximum.
transactionKey Required.
Merchant’s unique Transaction Key.
The merchant Transaction Key is provided in the Merchant Interface and must be stored securely.

The API Login ID and Transaction Key together provide the merchant authentication required for access to the payment gateway.
16-character maximum.
refId Merchant-assigned reference ID for the request.
If included in the request, this value is included in the response. This feature might be especially useful for multi-threaded applications.
Up to 20 characters.
transactionRequest Required.
This element is a container for transaction specific information.
transactionType Type of credit card transaction.
If the value submitted does not match a supported value, the transaction is rejected.
One of the following:

* authOnlyTransaction
* authCaptureTransaction
amount Required.
Amount of the transaction.
This is the total amount and must include tax, shipping, and any other charges.
15-digits maximum with a decimal point (no currency sign or symbol). For example, 8.95
payment This section includes payment information.
opaqueData Required.
Contains dataDescriptor and dataValue.
dataDescriptor Required.
128 characters
Meta data used to specify how the request
should be processed. The value of dataDescriptor is based on the source of the opaqueData dataValue.
For example, for Accept, the value is COMMON.ACCEPT.INAPP.PAYMENT
dataValue Required.
8192 characters
Base-64 encoded data that contains encrypted payment data. The payment gateway expects the encrypted payment data and meta data for the encryption keys.
solution Contains information about the software that generated the transaction.
id The solution ID is generated by Authorize.Net and provided to the solution provider.
Alphanumeric. Up to 50 characters.
terminalNumber The merchant's in-store terminal number. Can identify the cashiers or kiosks used.
Do not use your processor's terminal ID for this field.
Alphanumeric.
order Contains information about the order.
invoiceNumber Merchant-defined invoice number associated with the order.
description Description of the item purchased.
lineItems Contains one or more elements (the maximum is 30 line items.
lineItem Describes one line item of the order.
itemId Item identification.
Up to 31 characters.
name Name of the item.
Up to 31 characters
description Description of the item.
Up to 255 characters.
quantity Quantity purchased.
Up to two decimal places. Must be a positive number
unitPrice Price of one item.
Cost of an item per unit, excluding tax, freight, and duty.
tax Contains information about any taxes applied.
amount Amount of tax.
Total amount of the transaction must include this amount.
Format can include up to two decimal points. For example, 1.27.
name Name of tax.
description Description of tax.
duty Contains information about any duty applied.
amount Amount of duty.
name Name of duty.
description Description of duty.
shipping Items in this section describe shipping charges applied.
amount Amount of shipping charges.
Description of shipping charges.
name Name of shipping charges.
description Description of shipping charges.
taxExempt Indicates whether or not order is exempt from tax.
true ir false.
poNumber The merchant-assigned purchase order number.
Purchase order number must be created dynamically on the merchant's server or provided on a per-transaction basis. The payment gateway does not perform this function.
Up to 25 characters (no symbols).
customer The following fields contain customer information.
type
individual or business.
id Merchant assigned customer ID.
Unique identifier to represent the customer associated with the transaction.

Customer ID must be created dynamically on the merchant's server or provided for each transaction. The payment gateway does not perform this function.
Up to 20 characters (no symbols).
email The customer’s valid email address.
Required only when using a European Payment Processor. Processing Platform.

Email address to which the customer’s copy of the email receipt is sent when Email Receipts is configured in the Merchant Interface. The email is sent to the customer only if the email address format is valid.
Up to 255 characters.

For example, janedoe@customer.com
billTo This section contains billing address information.
firstName First name associated with customer’s billing address.
Required only when you use a European Payment Processor.
Up to 50 characters (no symbols).
lastName Last name associated with customer’s billing address.
Required only when you use a European Payment Processor.
Up to 50 characters (no symbols).
company Company associated with customer’s billing address.
Up to 50 characters (no symbols).
address Customer’s billing address.
Required if merchant would like to use the Address Verification Service security feature.

Required when using GPN Canada or WorldPay Streamline Processing Platform.
Up to 60 characters (no symbols).
city City of customer’s billing address.
Required only when you use a European Payment Processor.
Up to 40 characters (no symbols).
state State of customer’s billing address.
Required only when you use a European Payment Processor.
Up to 40 characters (no symbols) or a valid two-character state code.
zip ZIP code of customer’s billing address.
Required if merchant would like to use the Address Verification Service security feature.

Required when using GPN Canada or WorldPay Streamline Processing Platform.
Up to 20 characters (no symbols).
country Country of customer’s billing address.
Required only when you use a European Payment Processor.
Up to 60 characters (no symbols).
phoneNumber Phone number associated with customer’s billing address.
Up to 25 digits (no letters).

For example,
(123)123-1234.
faxNumber Fax number associated with customer’s billing address.
Up to 25 digits (no letters).

For example,
(123)123-1234.
shipTo This section contains shipping information.
firstName First name associated with customer’s shipping address.
Up to 50 characters (no symbols).
lastName Last name associated with customer’s shipping address.
Up to 50 characters (no symbols).
company Company associated with customer’s shipping address.
Up to 50 characters (no symbols).
address Customer’s shipping address.
Up to 60 characters (no symbols).
city City of customer’s shipping address.
Up to 40 characters (no symbols).
state State of customer’s shipping address.
Up to 40 characters (no symbols) or a valid two-character state code.
zip ZIP code of customer’s shipping address.
Up to 20 characters (no symbols).
country Country of customer’s shipping address.
Up to 60 characters (no symbols).
customerIP IP address of customer initiating the transaction. If this value is not passed, it will default to 255.255.255.255.
Required only when the merchant is using customer IP based AFDS filters.
Up to 15 characters (no letters).

For example, 255.255.255.255.
cardholderAuthentication Merchants using a third party cardholder authentication solution can submit the following authentication values with Visa and/or MasterCard transactions.
Note: invalid combinations of the following two fields will generate an error.
authenticationIndicator The electronic commerce indicator (ECI) value for a Visa transaction; or the universal cardholder authentication field indicator (UCAF) for a MasterCard transaction obtained by the merchant after the authentication process.
Required only for transactions processed through cardholder authentication programs. When submitted with other transaction types, this value is ignored.

This field is currently supported through Chase Paymentech, FDMS Nashville, Global Payments and TSYS.
Special characters included in this value must be URL-encoded.
cardholderAuthenticationValue The cardholder authentication verification value (CAVV) for a Visa transaction; or accountholder authentication value (AVV)/ universal cardholder authentication field (UCAF) for a MasterCard transaction obtained by the merchant after the authentication process.
Required only for authOnly and authCapture transactions processed through cardholder authentication programs. When submitted with other transaction types, this value is ignored.

This field is currently supported through Chase Paymentech, FDMS Nashville, Global Payments and TSYS.
Special characters included in this value must be URL-encoded.
employeeId Merchant-assigned employee ID.
The employeeId field is required for the EVO processor, and is supported on the TSYS processor. If a value is not passed with the field, Authorize.Net sends a default value of 0000 to the processor.
Numeric, 4 digits.
transactionSettings This section contains one or more elements.
setting Contains settingName and settingValue.
settingName Name of a specific setting to be modified for this transaction.
Setting recurringBilling to true does not create a recurring transaction. This data is simply passed to the payment processor. To create a recurring transaction, see the Recurring Billing documentation.
One of the following:

allowPartialAuth
duplicateWindow
emailCustomer
recurringBilling
settingValue Indicate whether the specified setting is enabled or disabled.
Boolean (true, false, 1, or 0)
userFields User-defined fields are allowed. This data is not stored with the transaction. It is only returned in the transaction response.
name Name of the user-defined field.
value Value of the user-defined field.
surcharge Used to record payment card surcharges that are passed along to customers. Contains an amount and a description child element.
Currently supported for TSYS merchants.

For details on surcharge rules, please see Visa's merchant regulations and fees.
amount Amount of the surcharge.
Currently supported for TSYS merchants.

For details on surcharge rules, please see Visa's merchant regulations and fees.
15-digits maximum with a decimal point (no currency sign or symbol). For example, 8.95
description Describes the reason or details for the surcharge.
Currently supported for TSYS merchants.

For details on surcharge rules, please see Visa's merchant regulations and fees.
merchantDescriptor Provides the option to submit a soft descriptor that will appear on the cardholder's statement with the charge.
Currently supported for TSYS merchants.
25 characters, alphanumeric

createTransactionResponse

Element Description Format
refId Merchant-assigned reference ID for the request.
If included in the request, this value is included in the response. This feature might be especially useful for multi-threaded applications.
Up to 20 characters.
messages This section contains information about the results of the request.
resultCode Ok or Error.
Contains additional information about the status of the request.
message Contains specific message information.
code Code number for message.
I00001
E000001
text Text for the error message.
sessionToken Returned for mobile device transactions, instead of a transactionKey.
transactionResponse
responseCode Overall status of the transaction.
1 = Approved
2 = Declined
3 = Error
4 = Held for Review
authCode Authorization or approval code.
6 characters.
avsResultCode Address Verification Service (AVS) response code.
Indicates the result of the AVS filter.
A = Address (Street) matches, ZIP does not.
B = Address information not provided for AVS check.
E = AVS error.
G = Non-U.S. Card Issuing Bank.
N = No Match on Address (Street) or ZIP.
P = AVS not applicable for this transaction.
R = Retry — System unavailable or timed out.
S = Service not supported by issuer.
U = Address information is unavailable.
W = Nine digit ZIP matches, Address (Street) does not.
X = Address (Street) and nine digit ZIP match.
Y = Address (Street) and five digit ZIP match.
Z = Five digit ZIP matches, Address (Street) does not.
cvvResultCode Card code verification (CCV) response code.
Indicates result of the CCV filter.
M = Match.
N = No Match.
P = Not Processed.
S = Should have been present.
U = Issuer unable to process request.
cavvResultCode Cardholder authentication verification response code.
Blank or not present = CAVV not validated.
0 = CAVV not validated because erroneous data was submitted.
1 = CAVV failed validation.
2 = CAVV passed validation.
3 = CAVV validation could not be performed; issuer attempt incomplete.
4 = CAVV validation could not be performed; issuer system error.
5 = Reserved for future use.
6 = Reserved for future use.
7 = CAVV attempt — failed validation — issuer available (U.S.-issued card/non-U.S acquirer).
8 = CAVV attempt — passed validation — issuer available (U.S.-issued card/non-U.S. acquirer).
9 = CAVV attempt — failed validation — issuer unavailable (U.S.-issued card/non-U.S. acquirer).
A = CAVV attempt — passed validation — issuer unavailable (U.S.-issued card/non-U.S. acquirer).
B = CAVV passed validation, information only, no liability shift.
transId The payment gateway assigned identification number for transaction.
This value must be used for any follow-on transactions such as a credit, prior auth capture, or void.
When testRequest is set to a positive response, or when Test Mode is enabled on the payment gateway, this value will be 0.
refTransId The transaction ID of a related, previously settled transaction.
transHash Payment gateway-generated MD5 hash value that can be used to authenticate the transaction response.
Because transaction responses are returned using an SSL connection, this feature is not necessary for AIM.
Alphanumeric.
testRequest
Indicates whether or not to treat this request as a test transaction.
true, false,1,0
accountNumber
accountType
messages This element contains one or more elements.
message These messages contain detailed information about the status of a particular transaction.
code Response code that represents the status.
description Text description of the status.
errors This element contains one or more elements.
error This element contains detailed information about any errors returned.
errorCode Error code returned.
errorText Text description of error.
splitTenderPayments If the transaction was a partial authorization transaction, then the split tender payment detail information is listed in this section.
splitTenderPayment Contains information about one split tender transaction.
transId The payment gateway assigned identification number for the transaction.
When testRequest is set to a positive response, or when Test Mode is enabled on the payment gateway, this value will be 0.
responseCode
responseToCustomer
authCode
accountNumber Last 4 digits of the card provided.
This field is returned with all transactions.
Alphanumeric (XXXX6835)
accountType Visa, MasterCard, American Express, Discover, Diners Club, or JCB.
Text.
requestedAmount Amount requested in original authorization.
Present if the current transaction is for a prepaid card or if a splitTenderId was sent in.
Numeric.
approvedAmount Amount approved.
Present if the current transaction is for a prepaid card or if a splitTenderId was sent in.
balanceOnCard Balance on the debit card or prepaid card.
Can be a positive or negative number. Has a value only if the current transaction is for a prepaid card.
Numeric.
userFields This element contains user fields, if any are defined.
Name Name of user-defined field.
These values are only echoed back in the response, and are also added to the merchant receipts. No other action is taken with user-defined fields.
value Value of user-defined field.
These values are only echoed back in the response, and are also added to the merchant receipts. No other action is taken with user-defined fields.
Request:

Live API Console requests are not supported in IE9 or below.

Enter your sandbox credentials below and all the sample requests will be run against this account. You can sign up for an account really quickly here.

Ok, you're in a real hurry right now, we understand, click here to use default sandbox credentials.

Response:
Loading...
View :

URL :

URL :

URL :

URL :

URL :

URL :

Get an Accept Payment Page

Use this function to retrieve a form token which can be used to request the Authorize.Net Accept hosted payment page. For more information on using the hosted payment page, see the Accept Hosted Feature Details page.

getHostedPaymentPageRequest

Element Description Format
merchantAuthentication Required.
Contains merchant authentication information.
name Required.
Merchant’s unique API Login ID.
The merchant API Login ID is provided in the Merchant Interface and must be stored securely.

The API Login ID and Transaction Key together provide the merchant authentication required for access to the payment gateway.
20-character maximum.
transactionKey Required.
Merchant’s unique Transaction Key.
The merchant Transaction Key is provided in the Merchant Interface and must be stored securely.

The API Login ID and Transaction Key together provide the merchant authentication required for access to the payment gateway.
16-character maximum.
refId Merchant-assigned reference ID for the request.
If included in the request, this value is included in the response. This feature might be especially useful for multi-threaded applications.
Up to 20 characters.
transactionRequest Required.
This element is a container for transaction specific information.
transactionType Required.
Type of credit card transaction.
If the value submitted does not match a supported value, the transaction is rejected.
One of the following:

* authOnlyTransaction
* authCaptureTransaction
amount Required.
Amount of the transaction.
This is the total amount and must include tax, shipping, and any other charges.
15-digits maximum with a decimal point (no currency sign or symbol). For example, 8.95
solution Contains information about the software that generated the transaction.
id The solution ID is generated by Authorize.Net and provided to the solution provider.
Alphanumeric. Up to 50 characters.
order Contains information about the order.
invoiceNumber Merchant-defined invoice number associated with the order.
description Description of the item purchased.
lineItems Contains one or more elements (the maximum is 30 line items.
lineItem Describes one line item of the order.
itemId Item identification.
Up to 31 characters.
name Name of the item.
Up to 31 characters
description Description of the item.
Up to 255 characters.
quantity Quantity purchased.
Up to two decimal places. Must be a positive number
unitPrice Price of one item.
Cost of an item per unit, excluding tax, freight, and duty.
tax Contains information about any taxes applied.
amount Amount of tax.
Total amount of the transaction must include this amount.
Format can include up to two decimal points. For example, 1.27.
name Name of tax.
description Description of tax.
duty Contains information about any duty applied.
amount Amount of duty.
name Name of duty.
description Description of duty.
shipping Items in this section describe shipping charges applied.
amount Amount of shipping charges.
Description of shipping charges.
name Name of shipping charges.
description Description of shipping charges.
taxExempt Indicates whether or not order is exempt from tax.
true ir false.
poNumber The merchant-assigned purchase order number.
Purchase order number must be created dynamically on the merchant's server or provided on a per-transaction basis. The payment gateway does not perform this function.
Up to 25 characters (no symbols).
customer The following fields contain customer information, and will pre-populate the payment form where appropriate.
type
individual or business.
id Merchant assigned customer ID.
Unique identifier to represent the customer associated with the transaction.

Customer ID must be created dynamically on the merchant's server or provided for each transaction. The payment gateway does not perform this function.
Up to 20 characters (no symbols).
email The customer’s valid email address.
Required only when using a European Payment Processor. Processing Platform.

Email address to which the customer’s copy of the email receipt is sent when Email Receipts is configured in the Merchant Interface. The email is sent to the customer only if the email address format is valid.
Up to 255 characters.

For example, janedoe@customer.com
billTo This section contains billing address information.
firstName First name associated with customer’s billing address.
Required only when you use a European Payment Processor.
Up to 50 characters (no symbols).
lastName Last name associated with customer’s billing address.
Required only when you use a European Payment Processor.
Up to 50 characters (no symbols).
company Company associated with customer’s billing address.
Up to 50 characters (no symbols).
address Customer’s billing address.
Required if merchant would like to use the Address Verification Service security feature.

Required when using GPN Canada or WorldPay Streamline Processing Platform.
Up to 60 characters (no symbols).
city City of customer’s billing address.
Required only when you use a European Payment Processor.
Up to 40 characters (no symbols).
state State of customer’s billing address.
Required only when you use a European Payment Processor.
Up to 40 characters (no symbols) or a valid two-character state code.
zip ZIP code of customer’s billing address.
Required if merchant would like to use the Address Verification Service security feature.

Required when using GPN Canada or WorldPay Streamline Processing Platform.
Up to 20 characters (no symbols).
country Country of customer’s billing address.
Required when any of the billTo fields are sent.
Up to 60 characters (no symbols).
phoneNumber Phone number associated with customer’s billing address.
Up to 25 digits (no letters).

For example,
(123)123-1234.
faxNumber Fax number associated with customer’s billing address.
Up to 25 digits (no letters).

For example,
(123)123-1234.
shipTo This section contains shipping information.
firstName First name associated with customer’s shipping address.
Up to 50 characters (no symbols).
lastName Last name associated with customer’s shipping address.
Up to 50 characters (no symbols).
company Company associated with customer’s shipping address.
Up to 50 characters (no symbols).
address Customer’s shipping address.
Up to 60 characters (no symbols).
city City of customer’s shipping address.
Up to 40 characters (no symbols).
state State of customer’s shipping address.
Up to 40 characters (no symbols) or a valid two-character state code.
zip ZIP code of customer’s shipping address.
Up to 20 characters (no symbols).
country Country of customer’s shipping address.
Up to 60 characters (no symbols).
hostedPaymentSettings This is an array of settings for the session (optional). For more information on these parameters, see the 'Hosted Form Parameter Settings' section in our Accept Hosted feature details page.
settingName Optional. One of:
* hostedPaymentReturnOptions
* hostedPaymentButtonOptions
* hostedPaymentStyleOptions
* hostedPaymentPaymentOptions
* hostedPaymentSecurityOptions
* hostedPaymentShippingAddressOptions
* hostedPaymentBillingAddressOptions
* hostedPaymentCustomerOptions
* hostedPaymentOrderOptions
* hostedPaymentIFrameCommunicatorUrl
settingValue Parameters and values for the specific setting.
For more information on possible parameters for settingValue, see the 'Hosted Form Parameter Settings' section in our Accept Hosted feature details page.
JSON object

getHostedPaymentPageResponse

Element Description Format
refId Merchant-assigned reference ID for the request.
If included in the request, this value is included in the response. This feature might be especially useful for multi-threaded applications.
Up to 20 characters.
messages This section contains information about the results of the request.
resultCode Ok or Error.
Contains additional information about the status of the request.
message Contains specific message information.
code Code number for message.
I00001
E000001
text Text for the error message.
token 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.
String
Request:

Live API Console requests are not supported in IE9 or below.

Enter your sandbox credentials below and all the sample requests will be run against this account. You can sign up for an account really quickly here.

Ok, you're in a real hurry right now, we understand, click here to use default sandbox credentials.

Response:
Loading...
View :

URL :

URL :

URL :

URL :

URL :

URL :

Mobile In-App Transactions

Enables you to pass Accept Mobile, Apple Pay, or Android Pay payment data to Authorize.Net. For more information about in-app payment transactions, see the Mobile In-App Feature Details page.

Create an Accept Transaction

Use this function to create an Authorize.Net payment transaction request, using the Accept Payment Nonce in place of card data.

createTransactionRequest

Element Description Format
merchantAuthentication Required.
Contains merchant authentication information.
name Required.
Merchant’s unique API Login ID.
The merchant API Login ID is provided in the Merchant Interface and must be stored securely.

The API Login ID and Transaction Key together provide the merchant authentication required for access to the payment gateway.
20-character maximum.
transactionKey Required.
Merchant’s unique Transaction Key.
The merchant Transaction Key is provided in the Merchant Interface and must be stored securely.

The API Login ID and Transaction Key together provide the merchant authentication required for access to the payment gateway.
16-character maximum.
refId Merchant-assigned reference ID for the request.
If included in the request, this value is included in the response. This feature might be especially useful for multi-threaded applications.
Up to 20 characters.
transactionRequest Required.
This element is a container for transaction specific information.
transactionType Type of credit card transaction.
If the value submitted does not match a supported value, the transaction is rejected.
One of the following:

* authOnlyTransaction
* authCaptureTransaction
amount Required.
Amount of the transaction.
This is the total amount and must include tax, shipping, and any other charges. The amount can either be hard coded or posted to a script.
Up to 15 digits with a decimal point (no dollar symbol. For example, 8.95.
payment This section includes payment information.
opaqueData Required.
Contains dataDescriptor and dataValue.
dataDescriptor Required.
128 characters
Meta data used to specify how the request
should be processed. The value of dataDescriptor is based on the source of the opaqueData dataValue.
For example, for Accept, the value is COMMON.ACCEPT.INAPP.PAYMENT
dataValue Required.
8192 characters
Base-64 encoded data that contains encrypted payment data. The payment gateway expects the encrypted payment data and meta data for the encryption keys.
solution Contains information about the software that generated the transaction.
id The solution ID is generated by Authorize.Net and provided to the solution provider.
Alphanumeric. Up to 50 characters.
order Contains information about the order.
invoiceNumber Merchant-defined invoice number associated with the order.
Description Description of the item purchased.
lineItems Contains one or more elements (the maximum is 30 line items.
lineItem Describes one line item of the order.
itemId Item identification.
Up to 31 characters.
name Name of the item.
Up to 31 characters
description Description of the item.
Up to 255 characters.
quantity Quantity purchased.
Up to two decimal places. Must be a positive number
unitPrice Price of one item.
Cost of an item per unit, excluding tax, freight, and duty.
tax Contains information about any taxes applied.
amount Amount of tax.
Total amount of the transaction must include this amount.
Format can include up to two decimal points. For example, 1.27.
name Name of tax.
description Description of tax.
duty Contains information about any duty applied.
amount Amount of duty.
name Name of duty.