This page provides a guide to Establishing a Connection to Authorize.net in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.

Connecting to Authorize.net

Establishing a Connection shows how to authenticate to Authorize.net and configure any necessary connection properties to create a database in CData Cloud

Accessing Data from CData Cloud Services

Accessing data from Authorize.net through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.

Connect to Authorize.net by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.

Connecting to Authorize.net

Before you connect, log into your Merchant account and navigate to Account > Settings. Your account Security Settings section displays the LoginID and TransactionKey.

Now set the following to connect:

• LoginID: The API login Id associated with your payment gateway account. (Note: This value is not the same as the login Id that you use to log in to the Merchant Interface.)
• TransactionKey: The transaction key associated with your payment gateway account.
• UseSandbox: Set to false by default, for use with a production account. If you are using a developer test account, set UseSandbox to true.

Customizing the SSL Configuration

By default, the Cloud attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.

To specify another certificate, see the SSLServerCert connection property.

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

• ProxyServer: the hostname or IP address of the proxy server that you want to route HTTP traffic through.
• ProxyPort: the TCP port that the proxy server is running on.
• ProxyAuthScheme: the authentication method the Cloud uses when authenticating to the proxy server.
• ProxyUser: the username of a user account registered with the proxy server.
• ProxyPassword: the password associated with the ProxyUser.

Other Proxies

Set the following properties:

• To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
• To tunnel the connection, set FirewallType to TUNNEL.
• To authenticate, specify FirewallUser and FirewallPassword.
• To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

The CData Cloud models the Authorize.net API as relational views, or read-only tables. These are defined in schema files, which are simple, text-based configuration files.

The Cloud uses the Authorize.net API to process supported filters. The Cloud processes other filters client-side within the Cloud.

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

CData Cloud - Authorize.net Views

Name	Description
BatchStatistics	Query BatchStatistics for an Authorize.net merchant account.
CustomerProfileDetails	Query Customer Profile Details for Authorize.net merchant account.
CustomerProfiles	Query Customer Profile IDs for Authorize.net merchant account.
CustomerProfileTransactionList	Query Transactions in a batch for an Authorize.net merchant account.
SettledBatchList	Query settled batches for an Authorize.net merchant account.
SubscriptionDetails	Query the details of an Automated Recurring Billing (ARB) subscription for an Authorize.net merchant account.
Subscriptions	Query Automated Recurring Billing (ARB) subscriptions for an Authorize.net merchant account.
TransactionDetailItems	Query TransactionDetails to retrieve Items for an Authorize.net merchant account.
TransactionDetails	Query TransactionDetails for an Authorize.net merchant account.
TransactionList	Query Transactions in a batch for an Authorize.net merchant account.
UnsettledTransactionList	Query Unsettled Transactions for an Authorize.net merchant account.

Query BatchStatistics for an Authorize.net merchant account.

View-Specific Information

The BatchId is the only available supported column in the WHERE clause and it is required to retrieve results from BatchStatistics. BatchId can be used with (=) or IN operator.

SELECT * FROM BatchStatistics WHERE BatchId = '236274'

SELECT * FROM BatchStatistics WHERE BatchId IN ('236274', '237832')

Columns

Name	Type	Statistic	Description
BatchId [KEY]	String		The unique batch Id.
AccountType [KEY]	String		The card type for this transaction (including eCheck). Valid values are Visa, MasterCard, AmericanExpress, Discover, JCB, DinersClub, and eCheck. Note a batch will contain either credit card or eCheck statistics, because eCheck transactions go in their own batch. The allowed values are Visa, MasterCard, AmericanExpress, Discover, JCB, DinersClub, eCheck.
SettlementTime	Datetime		Date and time the batch was settled.
SettlementState	String		The status of the batch. Valid values are settledSuccessfully or error. The allowed values are settledSuccessfully, error.
PaymentMethod	String		The payment method associated with the batch. Valid values are creditCard or eCheck. The allowed values are creditCard, eCheck.
MarketType	String		The market type associated with the batch. Valid values are 0 (eCommerce), 1 (MOTO), or 2 (Retail).
Product	String		The product associated with the batch. Valid values are Card Not Present or Card Present. The allowed values are Card Not Present, Card Present.
ReturnedItemAmount	Decimal		The total amount of all returned items. Only applicable for eCheck transactions.
ReturnedItemCount	Integer		The total count of all returned items. Only applicable for eCheck transactions.
ChargeBackAmount	Decimal		The total amount of all charge backs. Only applicable for credit card transactions.
ChargeBackCount	Integer		The total count of all charge backs. Only applicable for credit card transactions.
CorrectionNoticeCount	Integer		The total count of all correction notices. Only applicable for credit card transactions.
ChargeChargeBackAmount	Decimal		Only applicable for credit card transactions.
ChargeChargeBackCount	Integer		Only applicable for credit card transactions.
BatchStatisticsAmount	Decimal		DEPRECATED. The total amount of all transactions as returned in the response of a getBatchStatistics call. Only applicable for credit card transactions.
BatchStatisticsCount	Integer		DEPRECATED. The total count of all transactions as returned in the response of a getBatchStatistics call. Only applicable for credit card transactions.
ChargeReturnedItemsAmount	Decimal		The total amount of returned items purchased using credit cards.
ChargeReturnedItemsCount	Integer		The total count of returned items purchased using credit cards.
RefundReturnedItemsAmount	Decimal		The total amount of returned items that have been refunded.
RefundReturnedItemsCount	Integer		The total count of returned items that have been refunded.
RefundChargebackAmount	Decimal		The total amount of refund eCheck.Net transactions charged back in a batch, expressed in the merchant's default currency.
RefundChargebackCount	Integer		The number of refund eCheck.Net transactions charged back in a batch.
ChargeAmount	Decimal		The total amount of all charge (i.e., Sale) transactions.
ChargeCount	Integer		The total count of all charge transactions.
RefundAmount	Decimal		The total amount of all refund transactions.
RefundCount	Integer		The total count of all refund transactions.
VoidCount	Integer		The total count of all voided transactions.
DeclineCount	Integer		The total count of all declined transactions.
ErrorCount	Integer		The total count of all transactions that resulted in an error.

Query Customer Profile Details for Authorize.net merchant account.

View-Specific Information

The CustomerProfileId is the only available supported column in the WHERE clause and it is required to retrieve results from CustomerProfileDetails. CustomerProfileId can be used with (=) or IN operator.

SELECT * FROM CustomerProfileDetails WHERE CustomerProfileId = '1915622429'

SELECT * FROM CustomerProfileDetails WHERE CustomerProfileId IN ('1915622429', '3215422449')

Columns

Name	Type	Statistic	Description
MerchantCustomerId	String		Merchant-assigned customer reference ID. Must be unique among all of the customer IDs stored with profiles to be able to retrieve.
CustomerProfileId [KEY]	String		Payment gateway-assigned ID associated with the customer profile.This output is present only for successful requests.
Email	String		Email address associated with the customer profile.
Description	String		Description of the customer or customer profile. Required only when no values for merchantCustomerId and email are submitted.
FirstName	String		First name associated with customer's billing address.
LastName	String		Last name associated with customer's billing address.
Company	String		Company associated with customer's billing address.
Address	String		Customer's billing address.
City	String		City of customer's billing address.
State	String		State of customer's billing address.
Zip	String		The postal code of customer's billing address.
Country	String		Country of customer's billing address.
PhoneNumber	String		Phone number associated with customer's billing address.
FaxNumber	String		Fax number associated with customer's billing address.
DefaultPaymentProfile	Boolean		Indicates whether this profile is the default.If a customer profile does not have a default payment profile, then the defaultPaymentProfile element is not displayed in the getCustomerProfileResponse.If a profile has multiple payment profiles, the default profile returns defaultPaymentProfile set to true. Non-default profiles do not return defaultPaymentProfile.
CustomerPaymentProfileId	String		Payment gateway assigned ID associated with the customer payment profile.
CardNumber	String		The customer's masked credit card number. All sensitive payment information in the output is masked.
ExpirationDate	String		The expiration date for the customer's credit card.
CardType	String		Type of credit card. Possible values: Visa, Mastercard, AmericanExpress, Discover, JCB, or DinersClub.
IssuerNumber	String		Unique identifier (IIN) for the issuer of the card. This element is only returned if you set the includeIssuerInfo field to true in the request.
IsPaymentToken	Boolean		Indicates whether the payment method used an encrypted token.
AccountType	String		The type of bank account used for the eCheck.net transaction. Possible values: checking, savings, or businessChecking.
RoutingNumber	String		The ABA routing number.
AccountNumber	String		The bank account number.
NameOnAccount	String		Name of the person who holds the bank account.
EcheckType	String		The type of eCheck transaction. Do not use TEL, ARC, or BOC for recurring charges. Possible values:PPD, WEB, or CCD.
BankName	String		The name of the bank.
PaymentProfileCustomerType	String		The customer type. Possible values: individual, business.
ExcludeFromAccountUpdater	Boolean		Indicates whether the payment profile should be excluded from Account Updater updates.
ProfileType	String		Indicates whether a profile is a guest profile. Possible values: guest, regular
ShipToListFirstName	String		First name associated with this customer's shipping profile.
ShipToListLastName	String		Last name associated with this customer's shipping profile.
ShipToListCompany	String		Company associated with this customer's shipping profile.
ShipToListAddress	String		Address associated with this customer's shipping profile.
ShipToListCity	String		City associated with this customer's shipping profile.
ShipToListState	String		State associated with this customer's shipping profile.
ShipToListZip	String		Postal code of customer’s shipping address.
ShipToListCountry	String		Country of customer’s shipping address.
ShipToListPhoneNumber	String		Phone number associated with customer’s billing address.
ShipToListFaxNumber	String		Fax number associated with customer’s billing address.
ShipToListCustomerAddressId	String		customerAddressId associated with this customer's shipping profile.

Query Customer Profile IDs for Authorize.net merchant account.

Columns

Name	Type	Statistic	Description
CustomerProfileId	String		The ID number associated with a customer profile.

Query Transactions in a batch for an Authorize.net merchant account.

View-Specific Information

The CustomerProfileId is the only available supported column in the WHERE clause and it is required to retrieve results from CustomerProfileTransactionList. CustomerProfileId can be used with the (=) or IN operator.

SELECT * FROM CustomerProfileTransactionList WHERE CustomerProfileId = '1915622429'

SELECT * FROM CustomerProfileTransactionList WHERE CustomerProfileId IN ('1915622429', '3543535')

Columns

Name	Type	Statistic	Description
TransId [KEY]	String		The unique transaction Id.
SubmitTime	Datetime		Date and time the transaction was submitted.
TransactionStatus	String		The status of the transaction.
InvoiceNumber	String		The invoice number for the transaction.
FirstName	String		The first name of the customer for the transaction.
LastName	String		The last name of the customer for the transaction.
AccountType	String		The card type for this transaction (including eCheck). Valid values are: Visa, MasterCard, AmericanExpress, Discover, JCB, DinersClub, eCheck. The allowed values are Visa, MasterCard, AmericanExpress, Discover, JCB, DinersClub, eCheck.
AccountNumber	String		The account number for the transaction.
SettleAmount	Decimal		The amount that was submitted for settlement.
HasReturnedItems	Boolean		Indicates that this transaction contains returned items.
SubscriptionId	String		The subscription Id.
SubscriptionPayNum	Integer		Identifies the number of this transaction, in terms of how many transactions have been submitted for this subscription.
MarketType	String		The market type used to process the transaction. Valid values: 0 (eCommerce), 1 (MOTO), 2 (Retail).
Product	String		The product method used to process the transaction. Valid values: Card Not Present, Card Present. The allowed values are Card Not Present, Card Present.
MobileDeviceId	String		The unique identifier of the mobile device.
CustomerProfileId	String		The ID number associated with the customer profile.
CustomerPaymentProfileId	String		The ID of the customer payment profile used to charge this transaction.
FraudFilterList	String		A list of comma-separated fraud filters.
FraudAction	String		An applicable action due to fraud filters.

Query settled batches for an Authorize.net merchant account.

View-Specific Information

The following columns can be specified in the WHERE clause for the SettledBatchList view: IncludeStatistics and SettlementTime. SettlementTime supports the >, >=, <= and < operators and can be used to specify a range. The default date range is from UTC January 1 two years before the current year until the current time. If SettlementTime is not set as a range the query will return the previous or next 31 days depending on the used operator. IncludeStatistics is false by default. If you set 'IncludeStatistics=true', then statistics are included for the entire range, including the first and last SettlementTime dates. Columns that are statistics have the property 'Statistic = True' in the table below.

SELECT * FROM SettledBatchList WHERE SettlementTime > '2014-09-01T00:00:00' AND SettlementTime < '2014-09-20T00:00:00' AND IncludeStatistics = 'false'

Get data from the last January 1 two years before the current year to the current time.

SELECT * FROM SettledBatchList

Get data after the SettlementTime value.

SELECT * FROM SettledBatchList WHERE SettlementTime > '2014-09-01T00:00:00'

Get data before the SettlementTime value.

SELECT * FROM SettledBatchList WHERE SettlementTime <= '2014-09-01T00:00:00'

Columns

Name	Type	Statistic	Description
BatchId [KEY]	String		The unique batch Id.
SettlementTime	Datetime		Date and time the batch was settled.
SettlementState	String		The status of the batch. Valid values are settledSuccessfully or error. The allowed values are settledSuccessfully, error.
PaymentMethod	String		The payment method associated with the batch. Valid values are creditCard or eCheck. The allowed values are creditCard, eCheck.
MarketType	String		The market type associated with the batch. Valid values are 0 (eCommerce), 1 (MOTO), or 2 (Retail).
Product	String		The product associated with the batch. Valid values are Card Not Present or Card Present. The allowed values are Card Not Present, Card Present.
TotalCharge	Decimal	True	The total charged amount.
TotalRefund	Decimal	True	The total refunded amount.

Pseudocolumns

Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.

Name	Type	Description
IncludeStatistics	Boolean	Identifies whether to retrieve the batch statistics in addition to the basic batch details. The default value is false.

Query the details of an Automated Recurring Billing (ARB) subscription for an Authorize.net merchant account.

View-Specific Information

The SubscriptionId is the only required column in the WHERE clause to retrieve results from SubscriptionDetails and can be used with the (=) operator. You can optionally set IncludeTransactions to true to include the transactions associated with the subscription in the response.

SELECT * FROM SubscriptionDetails WHERE SubscriptionId = '100748'

SELECT * FROM SubscriptionDetails WHERE SubscriptionId = '100748' AND IncludeTransactions = true

SubscriptionDetails returns the full subscription profile, including the payment method, billing address, shipping address, and order information. The payment columns depend on how the subscription was funded: the CardNumber, CardType, and ExpirationDate columns are populated for credit card subscriptions, while the BankAccountType, BankRoutingNumber, BankAccountNumber, NameOnAccount, EcheckType, and BankName columns are populated for bank account (eCheck) subscriptions. Only one payment method applies to a given subscription, so the columns for the other method are null.

When IncludeTransactions is set to true, the ArbTransactions column contains a JSON array of the transactions associated with the subscription. Each element includes the TransId, Response, SubmitTimeUTC, PayNum, and AttemptNum values. The Authorize.net API returns at most the 20 most recent transactions.

Columns

Name	Type	Statistic	Description
RefId	String		Merchant-assigned reference ID for the request. If a value is supplied in the filter, that value is returned in the response.
SubscriptionName	String		Merchant-assigned name for the subscription.
IntervalLength	Integer		The measurement of time, in association with IntervalUnit, that defines the frequency of the billing occurrences.
IntervalUnit	String		The unit of time between billings. The allowed values are days, months.
StartDate	Date		The date the subscription began. This is also the date the initial billing occurred.
TotalOccurrences	Integer		Number of billing occurrences or payments for the subscription.
TrialOccurrences	Integer		Number of billing occurrences or payments in the trial period.
Amount	Decimal		The amount billed to the customer for each payment.
TrialAmount	Decimal		The amount charged for each payment during the trial period.
Status	String		The status of the subscription. The allowed values are active, expired, suspended, canceled, terminated.
MerchantCustomerId	String		The merchant-assigned identifier for the customer associated with the subscription.
CustomerDescription	String		The description of the customer profile associated with the subscription.
CustomerEmail	String		The email address associated with the customer profile.
CustomerProfileId	String		The identifier of the customer profile associated with the subscription.
CustomerType	String		The type of customer associated with the payment profile. The allowed values are individual, business.
BillToFirstName	String		First name associated with the customer's billing address.
BillToLastName	String		Last name associated with the customer's billing address.
BillToCompany	String		Company associated with the customer's billing address.
BillToAddress	String		Street address of the customer's billing address.
BillToCity	String		City of the customer's billing address.
BillToState	String		State of the customer's billing address.
BillToZip	String		ZIP code of the customer's billing address.
BillToCountry	String		Country of the customer's billing address.
BillToPhoneNumber	String		Phone number associated with the customer's billing address.
BillToFaxNumber	String		Fax number associated with the customer's billing address.
BillToEmail	String		Email address associated with the customer's billing address.
CustomerPaymentProfileId	String		The identifier of the customer payment profile used for the subscription.
DefaultPaymentProfile	Boolean		Whether the payment profile is the default payment profile for the customer profile.
CardNumber	String		The masked credit card number used for the subscription.
ExpirationDate	String		The masked expiration date of the credit card used for the subscription.
CardType	String		The type of credit card used for the subscription.
CardArtCardBrand	String		The card brand reported in the card art details of the credit card.
CardArtCardImageHeight	String		The height of the card art image for the credit card.
CardArtCardImageUrl	String		The URL of the card art image for the credit card.
CardArtCardImageWidth	String		The width of the card art image for the credit card.
CardArtCardType	String		The card type reported in the card art details of the credit card.
IssuerNumber	String		The issuer identification number of the credit card.
IsPaymentToken	Boolean		Whether the card number represents a payment token rather than an actual credit card number.
BankAccountType	String		The type of bank account used for the subscription. The allowed values are checking, savings, businessChecking.
BankRoutingNumber	String		The masked routing number of the bank account used for the subscription.
BankAccountNumber	String		The masked account number of the bank account used for the subscription.
NameOnAccount	String		The name of the account holder for the bank account used for the subscription.
EcheckType	String		The type of electronic check transaction used for the subscription. The allowed values are PPD, WEB, CCD, TEL, ARC, BOC.
BankName	String		The name of the bank associated with the bank account used for the subscription.
TokenSource	String		The source of the payment token used for the subscription.
TokenNumber	String		The masked token number used for the subscription.
TokenExpirationDate	String		The masked expiration date of the payment token used for the subscription.
TokenRequestorId	String		The identifier of the requestor of the payment token.
DriversLicenseNumber	String		The masked driver's license number of the customer.
DriversLicenseState	String		The state that issued the customer's driver's license.
DriversLicenseDateOfBirth	String		The date of birth listed on the customer's driver's license.
TaxId	String		The masked tax identification number of the customer.
SubscriptionIds	String		The identifiers of the subscriptions associated with the payment profile.
OriginalNetworkTransId	String		The network transaction identifier of the original transaction for the payment profile.
OriginalAuthAmount	Decimal		The amount of the original authorization for the payment profile.
ExcludeFromAccountUpdater	Boolean		Whether the payment profile is excluded from the Account Updater service.
ShipToFirstName	String		First name associated with the customer's shipping address.
ShipToLastName	String		Last name associated with the customer's shipping address.
ShipToCompany	String		Company associated with the customer's shipping address.
ShipToAddress	String		Street address of the customer's shipping address.
ShipToCity	String		City of the customer's shipping address.
ShipToState	String		State of the customer's shipping address.
ShipToZip	String		ZIP code of the customer's shipping address.
ShipToCountry	String		Country of the customer's shipping address.
ShipToPhoneNumber	String		Phone number associated with the customer's shipping address.
ShipToFaxNumber	String		Fax number associated with the customer's shipping address.
ShipToEmail	String		Email address associated with the customer's shipping address.
CustomerAddressId	String		The identifier of the customer's shipping address.
OrderInvoiceNumber	String		The merchant-assigned invoice number associated with the subscription order.
OrderDescription	String		The description of the subscription order.
ArbTransactions	String		A JSON aggregate of the transactions associated with the subscription,

Pseudocolumns

Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.

Name	Type	Description
SubscriptionId	String	The payment gateway assigned identification number of the subscription. This filter is required.
IncludeTransactions	Boolean	Whether to include the transactions associated with the subscription in the response.

Query Automated Recurring Billing (ARB) subscriptions for an Authorize.net merchant account.

View-Specific Information

The SearchType is the only available, supported column in the WHERE clause and it is required to retrieve results from Subscriptions. SearchType can be used with the (=) operator. Supported values are cardExpiringThisMonth, subscriptionActive, subscriptionExpiringThisMonth, and subscriptionInactive.

SELECT * FROM Subscriptions WHERE SearchType = 'subscriptionActive'

SELECT * FROM Subscriptions WHERE SearchType = 'subscriptionExpiringThisMonth'

Columns

Name	Type	Statistic	Description
RefId	String		Merchant-assigned reference ID for the request. If a value is supplied in the filter, that value is returned in the response.
SubscriptionId [KEY]	String		The payment gateway assigned identification number of the subscription.
Name	String		Merchant-assigned name for the subscription.
Status	String		The status of the subscription. The allowed values are active, expired, suspended, canceled, terminated.
CreatedTimeUTC	Datetime		The date and time the subscription was created, in UTC.
FirstName	String		First name associated with the customer's billing address.
LastName	String		Last name associated with the customer's billing address.
TotalOccurrences	Integer		Number of billing occurrences or payments for the subscription.
PastOccurrences	Integer		Number of billing occurrences or payments that have already been processed for the subscription.
PaymentMethod	String		The payment method used for the subscription. The allowed values are creditCard, eCheck, payPal.
AccountNumber	String		The masked account number used for the subscription.
Invoice	String		The invoice number associated with the subscription.
Amount	Decimal		The amount billed to the customer for each payment.
CurrencyCode	String		The currency code associated with the subscription amount.
CustomerProfileId	Integer		The identifier of the customer profile associated with the subscription.
CustomerPaymentProfileId	Integer		The identifier of the customer payment profile used for the subscription.
CustomerShippingProfileId	Integer		The identifier of the customer shipping profile associated with the subscription.

Pseudocolumns

Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.

Name	Type	Description
SearchType	String	The type of subscriptions to return. This filter is required. The allowed values are cardExpiringThisMonth, subscriptionActive, subscriptionExpiringThisMonth, subscriptionInactive.
OrderBy	String	The field used to sort the returned subscriptions. The allowed values are id, name, status, createTimeStampUTC, lastName, firstName, accountNumber, amount, pastOccurrences.
OrderDescending	Boolean	Whether the returned subscriptions are sorted in descending order of the OrderBy field.

Query TransactionDetails to retrieve Items for an Authorize.net merchant account.

View-Specific Information

The TransId is the only available supported column in the WHERE clause and it is required to retrieve results from TransactionDetailItems. TransId can be used with the (=) or IN operator.

SELECT * FROM TransactionDetailItems WHERE TransId = '23478353'

SELECT * FROM TransactionDetailItems WHERE TransId IN ('23478353', '23479147')

Columns

Name	Type	Statistic	Description
TransId [KEY]	String		The unique transaction Id.
ItemId [KEY]	String		The Id assigned to an item.
BatchId	String		The Id of the batch the transaction is in.
SettlementTime	Datetime		Date and time the transaction was settled.
SettlementState	String		Status of the batch. Valid values: settledSuccessfully, settlementError, pendingSettlement.
ResponseCode	Integer		The overall status of the transaction. Valid values: 1 (Approved), 2 (Declined), 3 (Error), 4 (Held for review). The allowed values are 1, 2, 3, 4.
InvoiceNumber	String		The invoice number for the transaction.
PurchaseOrderNumber	String		The purchase order number for the transaction.
AuthAmount	Decimal		The amount authorized or refunded.
CustomerId	String		The merchant-assigned customer Id.
CustomerEmail	String		The email address of the customer.
ReturnedItemId	String		The transaction ID for returned item.
ReturnedItemDate	Datetime		Date the item was returned.
ReturnedItemCode	String		The ACH return code.
ReturnedItemDescription	String		A text description of the reason for the return.
ItemName	String		The short description of the item.
ItemDescription	String		The detailed description of the item.
ItemQuantity	Double		The number of items sold.
ItemUnitPrice	Decimal		The cost of the item per unit, excluding tax, freight, and duty.
ItemTaxable	Boolean		Indicates whether the item is subject to tax.

Query TransactionDetails for an Authorize.net merchant account.

View-Specific Information

The TransId is the only available supported column in the WHERE clause and it is required to retrieve results from TransactionDetails. TransId can be used with the (=) or IN operator.

SELECT * FROM TransactionDetails WHERE TransId = '23478353'

SELECT * FROM TransactionDetails WHERE TransId IN ('23478353', '23479147')

Columns

Name	Type	Statistic	Description
TransId [KEY]	String		The unique transaction Id.
RefTransId	String		The transaction Id of the original transaction. This only appears for linked credits (transaction type refundTransaction).
SplitTenderId	String		Identifies the split tender order, if applicable. This only appears for transactions that are part of a larger partial authorization order.
SubmitTime	Datetime		Date and time the transaction was submitted.
TransactionType	String		The type of transaction that was originally submitted. Valid values: authCaptureTransaction, authOnlyTransaction, captureOnlyTransaction, refundTransaction. The allowed values are authCaptureTransaction, authOnlyTransaction, captureOnlyTransaction, refundTransaction.
TransactionStatus	String		The status of the transaction.
ResponseCode	Integer		The overall status of the transaction. Valid values: 1 (Approved), 2 (Declined), 3 (Error), 4 (Held for review). The allowed values are 1, 2, 3, 4.
ResponseReasonCode	Integer		A code that represents more details about the result of the transaction.
ResponseReasonDescription	String		A brief description of the result, which corresponds with the response reason code.
AuthCode	String		The authorization or approval code.
AVSResponse	String		Response from the AVS security check. Indicates the result of the AVS filter.
CardCodeResponse	String		Response from the card code security check. Indicates the result of the CCV filter.
CAVVResponse	String		The cardholder authentication verification response code.
FDSFilterAction	String		The action taken for a transaction that triggered one or more of the Advanced Fraud Detection Suite filters. Valid values: reject, decline, hold, authAndHold, report.
FDSFiltersName	String		A comma-separated list of fraud filter names.
FDSFiltersAction	String		A comma-separated list of fraud filter settings.
BatchId	String		The Id of the batch the transaction is in.
SettlementTime	Datetime		Date and time the transaction was settled.
SettlementState	String		Status of the batch. Valid values: settledSuccessfully, settlementError, pendingSettlement. The allowed values are settledSuccessfully, settlementError, pendingSettlement.
InvoiceNumber	String		The invoice number for the transaction.
Description	String		The description of the transaction.
PurchaseOrderNumber	String		The purchase order number for the transaction.
RequestedAmount	Decimal		The amount requested. This will only be present for partial authorization transactions. For other transactions it is not listed because it is always the same as AuthAmount.
AuthAmount	Decimal		The amount authorized or refunded.
SettleAmount	Decimal		The amount that was submitted for settlement.
TaxAmount	Decimal		The amount of the tax.
TaxName	String		The name of the tax.
TaxDescription	String		The description of the tax.
ShippingAmount	Decimal		The amount charged for shipping.
ShippingName	String		The name of the shipping charges.
ShippingDescription	String		The description of the shipping charges.
DutyAmount	Decimal		The amount of the duty.
DutyName	String		The name of the duty.
DutyDescription	String		The description of the duty.
PrepaidBalanceRemaining	Decimal		The amount remaining on the prepaid card at the time of the transaction.
TaxExempt	Boolean		Indicates whether the item is tax exempt.
CardNumber	String		The credit card number.
CardExpirationDate	String		The expiration date.
CardAccountType	String		The type of credit card. Valid values: Visa, MasterCard, AmericanExpress, Discover, JCB, DinersClub. The allowed values are Visa, MasterCard, AmericanExpress, Discover, JCB, DinersClub.
BankRoutingNumber	String		The routing number of the bank.
BankAccountNumber	String		The masked bank account number.
BankNameOnAccount	String		The name on the bank account.
BankEcheckType	String		The echeck type used for the transaction. Valid values: PPD, WEB, CCD, TEL. The allowed values are PPD, WEB.CCD.TEL.
CustomerType	String		The customer type. Valid values: individual, business. The allowed values are individual, business.
CustomerId	String		The merchant-assigned customer Id.
CustomerEmail	String		The email address of the customer.
BillToFirstName	String		The first name associated with the billing address of the customer.
BillToLastName	String		The last name associated with the billing address of the customer.
BillToCompany	String		The company name associated with the billing address of the customer.
BillToAddress	String		The billing address of the customer.
BillToCity	String		The city of the billing address of the customer.
BillToState	String		The state of the billing address of the customer.
BillToZip	String		The ZIP of the billing address of the customer.
BillToCountry	String		The country of the billing address of the customer.
BillToPhoneNumber	String		The phone number for the billing address of the customer.
BillToFaxNumber	String		The fax number for the billing address of the customer.
ShipToFirstName	String		The first name associated with the shipping address of the customer.
ShipToLastName	String		The last name associated with the shipping address of the customer.
ShipToCompany	String		The company name associated with the shipping address of the customer.
ShipToAddress	String		The shipping address of the customer.
ShipToCity	String		The city of the shipping address of the customer.
ShipToState	String		The state of the shipping address of the customer.
ShipToZip	String		The ZIP of the shipping address of the customer.
ShipToCountry	String		The country of the shipping address of the customer.
SubscriptionId	String		The subscription Id.
SubscriptionPayNum	Integer		Identifies the number of this transaction, in terms of how many transactions have been submitted for this subscription.
SolutionId	String		The solution Id generated by Authorize.net and provided to the solution provider.
SolutionName	String		The name generated by the solution provider and provided to Authorize.net.
CustomerIP	String		The IP address for the customer.
MobileDeviceId	String		The unique identifier of the mobile device.
MarketType	String		The market type used to process the transaction. Valid values: 0 (eCommerce), 1 (MOTO), 2 (Retail).
Product	String		The product method used to process the transaction. Valid values: Card Not Present, Card Present. The allowed values are Card Not Present, Card Present.
NetworkTransId	String		The network transaction ID generated by the card network if made available by the processor.
OriginalNetworkTransId	String		The network transaction ID returned in response to the original card-on-file transaction.
OriginalAuthAmount	Decimal		The authorized amount for the original card-on-file transaction.
AuthorizationIndicator	String		Indicates whether the authorization was a pre-authorization or final authorization.
EntryMode	String		Method used to enter transaction information.
EmployeeId	String		Merchant-assigned employee ID.
RecurringBilling	Boolean		Indicates whether or not this is a recurring transaction.
EmvDetails	String		Contains EMV tag information from the transaction.
CustomerSignature	String		Customer signature data for Card Present transactions.
CustomerProfileId	String		Payment gateway assigned ID associated with the customer profile.
CustomerPaymentProfileId	String		The ID of the customer payment profile used to create this payment transaction.
SurchargeAmount	Decimal		Amount of the surcharge.
SurchargeDescription	String		Describes the reason or details for the surcharge.
TipAmount	Decimal		The amount of the tip authorized by the cardholder.
OtherTaxNationalTaxAmount	Decimal		Amount of national tax.
OtherTaxLocalTaxAmount	Decimal		Amount of local tax.
OtherTaxAlternateTaxAmount	Decimal		Amount of alternative tax.
OtherTaxAlternateTaxId	String		Alternate tax identifier.
OtherTaxVatTaxRate	Decimal		VAT tax rate.
OtherTaxVatTaxAmount	Decimal		Amount of VAT tax.
ShipFromFirstName	String		The first name associated with the shipping from address.
ShipFromLastName	String		The last name associated with the shipping from address.
ShipFromCompany	String		The company name associated with the shipping from address.
ShipFromAddress	String		Ship from address.
ShipFromCity	String		City of Ship from address.
ShipFromState	String		State of Ship from address.
ShipFromZip	String		Postal code of Ship from address.
ShipFromCountry	String		Country of Ship from address.

Query Transactions in a batch for an Authorize.net merchant account.

View-Specific Information

The BatchId is the only available supported column in the WHERE clause and it is required to retrieve results from TransactionList. BatchId can be used with the (=) or IN operator.

SELECT * FROM TransactionList WHERE BatchId = '35353'

SELECT * FROM TransactionList WHERE BatchId IN ('35353', '34219')

Columns

Name	Type	Statistic	Description
TransId [KEY]	String		The unique transaction Id.
BatchId	String		The unique batch Id.
SubmitTime	Datetime		Date and time the transaction was submitted.
TransactionStatus	String		The status of the transaction.
InvoiceNumber	String		The invoice number for the transaction.
FirstName	String		The first name of the customer for the transaction.
LastName	String		The last name of the customer for the transaction.
AccountType	String		The card type for this transaction (including eCheck). Valid values are: Visa, MasterCard, AmericanExpress, Discover, JCB, DinersClub, eCheck. The allowed values are Visa, MasterCard, AmericanExpress, Discover, JCB, DinersClub, eCheck.
AccountNumber	String		The account number for the transaction.
SettleAmount	Decimal		The amount that was submitted for settlement.
HasReturnedItems	Boolean		Indicates that this transaction contains returned items.
SubscriptionId	String		The subscription Id.
SubscriptionPayNum	Integer		Identifies the number of this transaction, in terms of how many transactions have been submitted for this subscription.
MarketType	String		The market type used to process the transaction. Valid values: 0 (eCommerce), 1 (MOTO), 2 (Retail).
Product	String		The product method used to process the transaction. Valid values: Card Not Present, Card Present. The allowed values are Card Not Present, Card Present.
MobileDeviceId	String		The unique identifier of the mobile device.
CustomerProfileId	String		Payment gateway assigned ID associated with the customer profile.
CustomerPaymentProfileId	String		The ID of the customer payment profile used to create this payment transaction.
FraudFilterList	String		A list of comma-separated fraud filters.
FraudAction	String		An applicable action due to fraud filters.

Query Unsettled Transactions for an Authorize.net merchant account.

View-Specific Information

This view does not support server-side filtering. The Cloud processes all filtering client-side.

SELECT * FROM UnsettledTransactionList WHERE AccountType = 'Visa'

Columns

Name	Type	Statistic	Description
TransId [KEY]	String		The unique transaction Id.
SubmitTime	Datetime		Date and time the transaction was submitted.
TransactionStatus	String		The status of the transaction.
InvoiceNumber	String		The invoice number for the transaction.
FirstName	String		The first name of the customer for the transaction.
LastName	String		The last name of the customer for the transaction.
AccountType	String		The card type for this transaction (including eCheck). Valid values are: Visa, MasterCard, AmericanExpress, Discover, JCB, DinersClub, eCheck.
AccountNumber	String		The account number for the transaction.
SettleAmount	Decimal		The amount that was submitted for settlement.
HasReturnedItems	Boolean		Indicates that this transaction contains returned items.
SubscriptionId	String		The subscription Id.
SubscriptionPayNum	String		Identifies the number of this transaction, in terms of how many transactions have been submitted for this subscription.
MarketType	String		The market type used to process the transaction. Valid values: 0 (eCommerce), 1 (MOTO), 2 (Retail).
Product	String		The product method used to process the transaction. Valid values: Card Not Present, Card Present. The allowed values are Card Not Present, Card Present.
CustomerProfileId	String		The ID number associated with the customer profile.
CustomerPaymentProfileId	String		The ID of the customer payment profile used to charge this transaction.
FraudFilterList	String		A list of comma-separated fraud filters.
FraudAction	String		An applicable action due to fraud filters.

Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT operations with Authorize.net.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Authorize.net, along with an indication of whether the procedure succeeded or failed.

CData Cloud - Authorize.net Stored Procedures

Name	Description
ARBCancelSubscription	Use this procedure to cancel an existing Automated Recurring Billing (ARB) subscription.
ARBCreateSubscription	Use this procedure to create an Automated Recurring Billing (ARB) subscription.
ARBUpdateSubscription	Use this procedure to update an existing Automated Recurring Billing (ARB) subscription. Only the fields you provide are updated.
AuthorizeCreditCard	Use this procedure to authorize a credit card payment without capturing the funds. Use the CaptureTransaction procedure afterward to capture the authorized amount.
CaptureTransaction	Use this procedure to capture funds for a transaction that was previously authorized using the ChargeCreditCard stored procedure.
ChargeCreditCard	Use this method to authorize and capture a credit card payment.
CreateCustomerProfileFromTransaction	Use this procedure to create a customer profile, payment profile, and shipping profile from an existing successful transaction.
RefundTransaction	Use this procedure to refund a previously settled transaction. Refunds can only be issued for transactions that have already been settled; unsettled transactions must be voided instead.
VoidTransaction	Use this procedure to void a transaction that was previously authorized but has not yet been settled. Only unsettled transactions can be voided.

Use this procedure to cancel an existing Automated Recurring Billing (ARB) subscription.

Stored Procedure-Specific Information

To execute this stored procedure, enter:

    EXEC ARBCancelSubscription SubscriptionId='1234567'

Input

Name	Type	Required	Description
RefId	String	False	Merchant-assigned reference ID for the request. If included, this value is returned in the response.
SubscriptionId	String	True	The payment gateway assigned identification number of the subscription to cancel.

Result Set Columns

Name	Type	Description
RefId	String	Merchant-assigned reference ID for the request.
ResultCode	String	Overall status of the request. Possible values are Ok and Error.
Code	String	Response code that represents the status.
Message	String	Text description of the status.

Use this procedure to create an Automated Recurring Billing (ARB) subscription.

Stored Procedure-Specific Information

To execute this stored procedure, enter:

    EXEC ARBCreateSubscription SubscriptionName='Monthly Subscription', IntervalLength='1', IntervalUnit='months', StartDate='2025-01-01', TotalOccurrences='12', Amount='25.00', CardNumber='4111111111111111', ExpirationDate='2025-12'

Input

Name	Type	Required	Description
RefId	String	False	Merchant-assigned reference ID for the request. If included, this value is returned in the response.
SubscriptionName	String	False	Merchant-assigned name for the subscription.
IntervalLength	Integer	True	The measurement of time, in association with IntervalUnit, that is used to define the frequency of the billing occurrences. If IntervalUnit is months, IntervalLength can be 1 to 12. If IntervalUnit is days, IntervalLength can be 7 to 365.
IntervalUnit	String	True	The unit of time between billings. Allowed values are days and months.
StartDate	Date	True	The date the subscription begins, in YYYY-MM-DD format. This is also the date the initial billing occurs.
TotalOccurrences	Integer	True	Number of billing occurrences or payments for the subscription. Use 9999 to indicate an ongoing subscription without an end date.
TrialOccurrences	Integer	False	Number of billing occurrences or payments in the trial period.
Amount	Decimal	True	The amount to be billed to the customer for each payment. This is the total amount and must include tax, shipping, and any other charges.
TrialAmount	Decimal	False	The amount to be charged for each payment during a trial period. Required when TrialOccurrences is specified.
CardNumber	String	False	The customer's credit card number. Required, together with ExpirationDate, to bill a new credit card. Do not specify together with RoutingNumber/AccountNumber/NameOnAccount or CustomerProfileId/CustomerPaymentProfileId, which bill a new bank account or an existing customer profile instead.
ExpirationDate	String	False	The expiration date of the credit card, in YYYY-MM format. Required, together with CardNumber, to bill a new credit card. Do not specify together with RoutingNumber/AccountNumber/NameOnAccount or CustomerProfileId/CustomerPaymentProfileId, which bill a new bank account or an existing customer profile instead.
CardCode	String	False	The three- or four-digit card verification code. Used only for validation; it is not stored.
BankAccountType	String	False	The type of bank account used to bill a new payment method. Required, together with RoutingNumber, AccountNumber, and NameOnAccount, to bill a new bank account instead of a credit card. Possible values are checking, savings, and businessChecking.
RoutingNumber	String	False	The ABA routing number of the bank account used to bill a new payment method. Required, together with AccountNumber and NameOnAccount, to bill a new bank account instead of a credit card.
AccountNumber	String	False	The account number of the bank account used to bill a new payment method. Required, together with RoutingNumber and NameOnAccount, to bill a new bank account instead of a credit card.
NameOnAccount	String	False	The name of the person who holds the bank account used to bill a new payment method. Required, together with RoutingNumber and AccountNumber, to bill a new bank account instead of a credit card.
EcheckType	String	False	The type of eCheck transaction. Do not use TEL, ARC, or BOC for recurring charges. Possible values are PPD, WEB, or CCD.
BankName	String	False	The name of the bank associated with the bank account used to bill a new payment method.
OpaqueDataDescriptor	String	False	The nonce data descriptor that identifies how the payment nonce in OpaqueDataValue was generated. Required, together with OpaqueDataValue, to bill a payment nonce instead of a credit card, bank account, or existing customer profile.
OpaqueDataValue	String	False	The payment nonce used to bill a new payment method. Required, together with OpaqueDataDescriptor, to bill a payment nonce instead of a credit card, bank account, or existing customer profile.
OrderInvoiceNumber	String	False	Merchant-assigned invoice number for the subscription order.
OrderDescription	String	False	Description of the subscription order.
CustomerType	String	False	The type of customer associated with the subscription. Possible values are individual and business.
CustomerId	String	False	Merchant-assigned identifier for the customer associated with the subscription.
CustomerEmail	String	False	The customer's email address.
CustomerPhoneNumber	String	False	The customer's phone number.
CustomerFaxNumber	String	False	The customer's fax number.
BillToFirstName	String	False	First name associated with the customer's billing address.
BillToLastName	String	False	Last name associated with the customer's billing address.
BillToCompany	String	False	Company name associated with the customer's billing address.
BillToAddress	String	False	Street address associated with the customer's billing address.
BillToCity	String	False	City associated with the customer's billing address.
BillToState	String	False	State associated with the customer's billing address.
BillToZip	String	False	Postal code associated with the customer's billing address.
BillToCountry	String	False	Country associated with the customer's billing address.
ShipToFirstName	String	False	First name associated with the customer's shipping address.
ShipToLastName	String	False	Last name associated with the customer's shipping address.
ShipToCompany	String	False	Company name associated with the customer's shipping address.
ShipToAddress	String	False	Street address associated with the customer's shipping address.
ShipToCity	String	False	City associated with the customer's shipping address.
ShipToState	String	False	State associated with the customer's shipping address.
ShipToZip	String	False	Postal code associated with the customer's shipping address.
ShipToCountry	String	False	Country associated with the customer's shipping address.
CustomerProfileId	String	False	The payment gateway assigned identification number of an existing customer profile to bill for the subscription. Required, together with CustomerPaymentProfileId, to bill an existing customer profile. Do not specify together with CardNumber/ExpirationDate or RoutingNumber/AccountNumber/NameOnAccount, which bill a new credit card or bank account instead. If included, this value is returned in the response.
CustomerPaymentProfileId	String	False	The payment gateway assigned identification number of an existing customer payment profile to bill for the subscription. Required, together with CustomerProfileId, to bill an existing customer profile. Do not specify together with CardNumber/ExpirationDate or RoutingNumber/AccountNumber/NameOnAccount, which bill a new credit card or bank account instead. If included, this value is returned in the response.
CustomerAddressId	String	False	The payment gateway assigned identification number of an existing customer shipping address to associate with the subscription. Applies only when CustomerProfileId is specified. If included, this value is returned in the response.

Result Set Columns

Name	Type	Description
RefId	String	Merchant-assigned reference ID for the request.
ResultCode	String	Overall status of the request. Possible values are Ok and Error.
Code	String	Response code that represents the status.
Message	String	Text description of the status.
SubscriptionId	String	The payment gateway assigned identification number for the subscription.
CustomerProfileId	String	The identifier of the customer profile used for the subscription. This is a newly created profile unless CustomerProfileId was specified in the request to bill an existing profile.
CustomerPaymentProfileId	String	The identifier of the payment profile used for the subscription. This is a newly created payment profile unless CustomerPaymentProfileId was specified in the request to bill an existing profile.
CustomerAddressId	String	The identifier of the customer shipping address associated with the subscription.

Use this procedure to update an existing Automated Recurring Billing (ARB) subscription. Only the fields you provide are updated.

Stored Procedure-Specific Information

To execute this stored procedure, enter:

    EXEC ARBUpdateSubscription SubscriptionId='1234567', Amount='30.00'

Input

Name	Type	Required	Description
RefId	String	False	Merchant-assigned reference ID for the request. If included, this value is returned in the response.
SubscriptionId	String	True	The payment gateway assigned identification number of the subscription to update.
SubscriptionName	String	False	Merchant-assigned name for the subscription.
StartDate	Date	False	The date the subscription begins, in YYYY-MM-DD format. Can only be updated if no successful payments have been completed. The billing interval cannot be changed after the subscription is created.
TotalOccurrences	Integer	False	Number of billing occurrences or payments for the subscription. Use 9999 to indicate an ongoing subscription without an end date.
TrialOccurrences	Integer	False	Number of billing occurrences or payments in the trial period. Can only be updated if the subscription has not begun or is still in the trial period.
Amount	Decimal	False	The amount to be billed to the customer for each payment. This is the total amount and must include tax, shipping, and any other charges.
TrialAmount	Decimal	False	The amount to be charged for each payment during a trial period.
CardNumber	String	False	The customer's credit card number. Required, together with ExpirationDate, to update the payment method to a new credit card. Do not specify together with RoutingNumber/AccountNumber/NameOnAccount or CustomerProfileId/CustomerPaymentProfileId, which update to a new bank account or an existing customer profile instead.
ExpirationDate	String	False	The expiration date of the credit card, in YYYY-MM format. Required, together with CardNumber, to update the payment method to a new credit card. Do not specify together with RoutingNumber/AccountNumber/NameOnAccount or CustomerProfileId/CustomerPaymentProfileId, which update to a new bank account or an existing customer profile instead.
CardCode	String	False	The three- or four-digit card verification code. Used only for validation; it is not stored.
BankAccountType	String	False	The type of bank account used to update the payment method. Required, together with RoutingNumber, AccountNumber, and NameOnAccount, to update to a new bank account instead of a credit card. Possible values are checking, savings, and businessChecking.
RoutingNumber	String	False	The ABA routing number of the bank account used to update the payment method. Required, together with AccountNumber and NameOnAccount, to update to a new bank account instead of a credit card.
AccountNumber	String	False	The account number of the bank account used to update the payment method. Required, together with RoutingNumber and NameOnAccount, to update to a new bank account instead of a credit card.
NameOnAccount	String	False	The name of the person who holds the bank account used to update the payment method. Required, together with RoutingNumber and AccountNumber, to update to a new bank account instead of a credit card.
EcheckType	String	False	The type of eCheck transaction. Do not use TEL, ARC, or BOC for recurring charges. Possible values are PPD, WEB, or CCD.
BankName	String	False	The name of the bank associated with the bank account used to update the payment method.
OpaqueDataDescriptor	String	False	The nonce data descriptor that identifies how the payment nonce in OpaqueDataValue was generated. Required, together with OpaqueDataValue, to update the payment method to a payment nonce instead of a credit card, bank account, or existing customer profile.
OpaqueDataValue	String	False	The payment nonce used to update the payment method. Required, together with OpaqueDataDescriptor, to update the payment method to a payment nonce instead of a credit card, bank account, or existing customer profile.
OrderInvoiceNumber	String	False	Merchant-assigned invoice number for the subscription order.
OrderDescription	String	False	Description of the subscription order.
CustomerType	String	False	The type of customer associated with the subscription. Possible values are individual and business.
CustomerId	String	False	Merchant-assigned identifier for the customer associated with the subscription.
CustomerEmail	String	False	The customer's email address.
CustomerPhoneNumber	String	False	The customer's phone number.
CustomerFaxNumber	String	False	The customer's fax number.
BillToFirstName	String	False	First name associated with the customer's billing address.
BillToLastName	String	False	Last name associated with the customer's billing address.
BillToCompany	String	False	Company name associated with the customer's billing address.
BillToAddress	String	False	Street address associated with the customer's billing address.
BillToCity	String	False	City associated with the customer's billing address.
BillToState	String	False	State associated with the customer's billing address.
BillToZip	String	False	Postal code associated with the customer's billing address.
BillToCountry	String	False	Country associated with the customer's billing address.
ShipToFirstName	String	False	First name associated with the customer's shipping address.
ShipToLastName	String	False	Last name associated with the customer's shipping address.
ShipToCompany	String	False	Company name associated with the customer's shipping address.
ShipToAddress	String	False	Street address associated with the customer's shipping address.
ShipToCity	String	False	City associated with the customer's shipping address.
ShipToState	String	False	State associated with the customer's shipping address.
ShipToZip	String	False	Postal code associated with the customer's shipping address.
ShipToCountry	String	False	Country associated with the customer's shipping address.
CustomerProfileId	String	False	The payment gateway assigned identification number of an existing customer profile to bill for the subscription. Required, together with CustomerPaymentProfileId, to update to an existing customer profile. Do not specify together with CardNumber/ExpirationDate or RoutingNumber/AccountNumber/NameOnAccount, which update to a new credit card or bank account instead. If included, this value is returned in the response.
CustomerPaymentProfileId	String	False	The payment gateway assigned identification number of an existing customer payment profile to bill for the subscription. Required, together with CustomerProfileId, to update to an existing customer profile. Do not specify together with CardNumber/ExpirationDate or RoutingNumber/AccountNumber/NameOnAccount, which update to a new credit card or bank account instead. If included, this value is returned in the response.
CustomerAddressId	String	False	The payment gateway assigned identification number of an existing customer shipping address to associate with the subscription. Applies only when CustomerProfileId is specified. If included, this value is returned in the response.

Result Set Columns

Name	Type	Description
RefId	String	Merchant-assigned reference ID for the request.
ResultCode	String	Overall status of the request. Possible values are Ok and Error.
Code	String	Response code that represents the status.
Message	String	Text description of the status.
CustomerProfileId	String	The identifier of the customer profile associated with the subscription.
CustomerPaymentProfileId	String	The identifier of the payment profile associated with the subscription.
CustomerAddressId	String	The identifier of the customer shipping address associated with the subscription.

Use this procedure to authorize a credit card payment without capturing the funds. Use the CaptureTransaction procedure afterward to capture the authorized amount.

Stored Procedure-Specific Information

To execute this stored procedure, enter:

    EXEC AuthorizeCreditCard Amount='25.00', CurrencyCode='USD', CardNumber='4111111111111111', ExpirationDate='2025-12', CardCode='123'

Input

Name	Type	Required	Description
RefId	String	False	Merchant-assigned reference ID for the request. If included, this value is returned in the response.
Amount	Decimal	True	Amount of the transaction. This is the total amount and must include tax, shipping, and any other charges.
CurrencyCode	String	False	The currency of the transaction.
PaymentTrack1	String	False	Track 1 data from the card's magnetic stripe. Provide PaymentTrack1 or PaymentTrack2 to bill card-present track data instead of CardNumber/ExpirationDate.
PaymentTrack2	String	False	Track 2 data from the card's magnetic stripe. Provide PaymentTrack1 or PaymentTrack2 to bill card-present track data instead of CardNumber/ExpirationDate.
CardNumber	String	False	The customer's credit card number. Provide with ExpirationDate to bill a card-not-present credit card instead of PaymentTrack1/PaymentTrack2.
ExpirationDate	String	False	The customer's credit card expiration date, in YYYY-MM format.
CardCode	String	False	The customer's card code. The three- or four-digit number on the back of a credit card (on the front for American Express).
CreateProfile	Boolean	False	When true, a customer profile is created from the transaction data.
SolutionId	String	False	The solution ID generated by Authorize.Net for a partner solution.
SolutionName	String	False	The solution name associated with the SolutionId.
CallId	String	False	The call ID generated by a digital wallet provider.
TerminalNumber	String	False	The terminal number used for the transaction.
AuthCode	String	False	The authorization code of an original transaction not authorized on the payment gateway.
RefTransId	String	False	The payment gateway assigned transaction ID of the original transaction.
SplitTenderId	String	False	The identifier of a split tender group used to combine multiple transactions.
OrderInvoiceNumber	String	False	Merchant-defined invoice number associated with the order.
OrderDescription	String	False	Description of the item purchased.
SupplierOrderReference	String	False	A supplier order reference number for the order.
LineItemId	String	False	Item identification.
LineItemName	String	False	Name of the item.
LineItemDescription	String	False	Description of the item.
LineItemQuantity	Decimal	False	Quantity purchased.
LineItemUnitPrice	Decimal	False	Price of one item per unit, excluding tax, freight, and duty.
LineItemTaxable	Boolean	False	Indicates whether the line item is taxable.
LineItemUnitOfMeasure	String	False	The unit of measure for the line item.
LineItemTaxAmount	Decimal	False	The tax amount for the line item.
LineItemTotalAmount	Decimal	False	The total amount for the line item.
LineItemCommodityCode	String	False	The commodity code for the line item.
LineItemProductCode	String	False	The product code for the line item.
LineItemProductSKU	String	False	The product SKU for the line item.
LineItemDiscountAmount	Decimal	False	The discount amount for the line item.
TaxAmount	Decimal	False	The tax amount for the order.
TaxName	String	False	The name of the tax for the order.
TaxDescription	String	False	The description of the tax for the order.
DutyAmount	Decimal	False	The duty amount for the order.
DutyName	String	False	The name of the duty for the order.
DutyDescription	String	False	The description of the duty for the order.
ShippingAmount	Decimal	False	The shipping charge amount for the order.
ShippingName	String	False	The name of the shipping charge for the order.
ShippingDescription	String	False	The description of the shipping charge for the order.
TaxExempt	Boolean	False	Indicates whether the transaction is tax exempt.
PONumber	String	False	The purchase order number.
CustomerType	String	False	The type of customer. Possible values are individual and business.
CustomerId	String	False	Merchant assigned customer ID. Unique identifier to represent the customer associated with the transaction.
CustomerEmail	String	False	The customer's email address.
BillToFirstName	String	False	First name associated with customer's billing address.
BillToLastName	String	False	Last name associated with BillTo's billing address.
BillToCompany	String	False	Company associated with customer's billing address.
BillToAddress	String	False	Customer's billing address. Required if the merchant would like to use the Address Verification Service security feature.
BillToCity	String	False	City of customer's billing address.
BillToState	String	False	State of customer's billing address.
BillToZip	String	False	ZIP code of customer's billing address. Required if the merchant would like to use the Address Verification Service security feature.
BillToCountry	String	False	Country of customer's billing address.
BillToPhoneNumber	String	False	Phone number associated with customer's billing address.
BillToFaxNumber	String	False	Fax number associated with customer's billing address.
ShipToFirstName	String	False	First name associated with customer's shipping address.
ShipToLastName	String	False	Last name associated with customer's shipping address.
ShipToCompany	String	False	Company associated with customer's shipping address.
ShipToAddress	String	False	Customer's shipping address.
ShipToCity	String	False	City of customer's shipping address.
ShipToState	String	False	State of customer's shipping address.
ShipToZip	String	False	ZIP code of customer's shipping address.
ShipToCountry	String	False	Country of customer's shipping address.
CustomerIP	String	False	The customer's IP address.
CardholderAuthenticationIndicator	String	False	The cardholder authentication indicator (ECI) value.
CardholderAuthenticationValue	String	False	The cardholder authentication verification value (CAVV).
RetailMarketType	String	False	The market type for the retail transaction.
RetailDeviceType	String	False	The device type for the retail transaction.
EmployeeId	String	False	The identifier of the employee processing the transaction.
TransactionSettingName	String	False	The name of a transaction setting. Allowed values include emailCustomer, merchantEmail, allowPartialAuth, headerEmailReceipt, footerEmailReceipt, recurringBilling, duplicateWindow, and testRequest.
TransactionSettingValue	String	False	The value of the transaction setting identified by TransactionSettingName.
UserFieldName	String	False	The name of a merchant-defined user field.
UserFieldValue	String	False	The value of the merchant-defined user field identified by UserFieldName.
SurchargeAmount	Decimal	False	The surcharge amount applied to the transaction.
SurchargeDescription	String	False	The description of the surcharge.
MerchantDescriptor	String	False	The merchant descriptor that appears on the customer's statement.
SubMerchantIdentifier	String	False	The identifier of the sub-merchant. Required when subMerchant information is provided.
SubMerchantDoingBusinessAs	String	False	The doing-business-as name of the sub-merchant.
SubMerchantPaymentServiceProviderName	String	False	The payment service provider name of the sub-merchant.
SubMerchantPaymentServiceFacilitator	String	False	The payment service facilitator of the sub-merchant.
SubMerchantStreetAddress	String	False	The street address of the sub-merchant.
SubMerchantPhone	String	False	The phone number of the sub-merchant.
SubMerchantEmail	String	False	The email address of the sub-merchant.
SubMerchantPostalCode	String	False	The postal code of the sub-merchant.
SubMerchantCity	String	False	The city of the sub-merchant.
SubMerchantRegionCode	String	False	The region code of the sub-merchant.
SubMerchantCountryCode	String	False	The country code of the sub-merchant.
TipAmount	Decimal	False	The tip amount included in the transaction.
ProcessingOptionsIsFirstRecurringPayment	Boolean	False	Indicates whether this is the first payment in a series of recurring payments.
ProcessingOptionsIsFirstSubsequentAuth	Boolean	False	Indicates whether this is the first in a series of merchant-initiated transactions.
ProcessingOptionsIsSubsequentAuth	Boolean	False	Indicates whether this is a subsequent merchant-initiated transaction.
ProcessingOptionsIsStoredCredentials	Boolean	False	Indicates whether stored credentials are used for the transaction.
SubsequentAuthInformationOriginalNetworkTransId	String	False	The network transaction ID of the original transaction. Required when subsequentAuthInformation is provided.
SubsequentAuthInformationSubsequentAuthReason	String	False	The reason for the subsequent authorization. Required when subsequentAuthInformation is provided.
SubsequentAuthInformationOriginalAuthAmount	Decimal	False	The amount of the original authorization. Required when subsequentAuthInformation is provided.
OtherTaxNationalTaxAmount	Decimal	False	The national tax amount.
OtherTaxLocalTaxAmount	Decimal	False	The local tax amount.
OtherTaxAlternateTaxAmount	Decimal	False	The alternate tax amount.
OtherTaxAlternateTaxId	String	False	The alternate tax identifier.
OtherTaxVatTaxRate	Decimal	False	The VAT tax rate.
OtherTaxVatTaxAmount	Decimal	False	The VAT tax amount.
ShipFromFirstName	String	False	First name associated with the ship-from address.
ShipFromLastName	String	False	Last name associated with the ship-from address.
ShipFromCompany	String	False	Company associated with the ship-from address.
ShipFromAddress	String	False	Street address of the ship-from location.
ShipFromCity	String	False	City of the ship-from location.
ShipFromState	String	False	State of the ship-from location.
ShipFromZip	String	False	ZIP code of the ship-from location.
ShipFromCountry	String	False	Country of the ship-from location.
AuthorizationIndicator	String	False	The authorization indicator. Possible values are pre and final.
TapToPhone	Boolean	False	Indicates whether the transaction was made using a tap-to-phone device.
DebtRepaymentIndicator	Boolean	False	Indicates whether the transaction is a debt repayment.
PurchaseLevel	String	False	The purchase level of the transaction data.
AftInformationAftIndicator	String	False	The Account Funding Transaction (AFT) indicator.
AftInformationAftBusinessApplicationId	String	False	The business application identifier for the account funding transaction.
AftInformationRecipientFirstName	String	False	First name of the recipient in an account funding transaction.
AftInformationRecipientLastName	String	False	Last name of the recipient in an account funding transaction.
AftInformationRecipientMiddleName	String	False	Middle name of the recipient in an account funding transaction.
AftInformationRecipientAddress	String	False	Street address of the recipient in an account funding transaction.
AftInformationRecipientCity	String	False	City of the recipient in an account funding transaction.
AftInformationRecipientState	String	False	State of the recipient in an account funding transaction.
AftInformationRecipientZip	String	False	ZIP code of the recipient in an account funding transaction.
AftInformationRecipientCountry	String	False	Country of the recipient in an account funding transaction.
AftInformationRecipientAccountId	String	False	The account identifier of the recipient in an account funding transaction.
AftInformationRecipientAccountType	String	False	The account type of the recipient in an account funding transaction.
AftInformationSenderFirstName	String	False	First name of the sender in an account funding transaction.
AftInformationSenderMiddleName	String	False	Middle name of the sender in an account funding transaction.
AftInformationSenderLastName	String	False	Last name of the sender in an account funding transaction.
AftInformationSenderName	String	False	Sender business, government, non-government name, or Visa payer name. When name has a value, sender's other name fields should not be present in the transaction.
AftInformationSenderAddress	String	False	Street address of the sender in an account funding transaction.
AftInformationSenderCity	String	False	City of the sender in an account funding transaction.
AftInformationSenderState	String	False	State of the sender in an account funding transaction.
AftInformationSenderZip	String	False	ZIP code of the sender in an account funding transaction.
AftInformationSenderCountry	String	False	Country of the sender in an account funding transaction.
AftInformationSenderType	String	False	The type of sender in an account funding transaction.
AftInformationSenderAccount	String	False	The account of the sender in an account funding transaction.
AftInformationSenderFundsSourceNumber	String	False	The funds source number of the sender in an account funding transaction.
AftInformationSenderFundsSourceType	String	False	The funds source type of the sender in an account funding transaction.
AftInformationSenderDateOfBirth	String	False	The date of birth of the sender in an account funding transaction.
AftInformationSenderIdentificationNumber	String	False	The identification number of the sender in an account funding transaction.
AftInformationSenderPersonalIdType	String	False	The personal identification type of the sender in an account funding transaction.
AftInformationSenderReferenceNumber	String	False	The reference number of the sender in an account funding transaction.
DiscountAmount	Decimal	False	The discount amount for the order.
DiscountName	String	False	The name of the discount for the order.
DiscountDescription	String	False	The description of the discount for the order.

Result Set Columns

Name	Type	Description
RefId	String	Merchant-assigned reference ID for the request.
Code	String	Response code that represents the status.
Message	String	Text description of the status.
ResponseCode	Integer	Overall status of the transaction. Possible values are 1 = Approved, 2 = Declined, 3 = Error, 4 = Held for Review.
AuthCode	String	The authorization or approval code for the transaction.
AvsResultCode	String	Address Verification Service (AVS) response code. Indicates the result of the AVS filter.
CvvResultCode	String	Card code verification (CCV) response code.
CavvResultCode	String	Cardholder authentication verification value (CAVV) response code.
TransId	String	The payment gateway assigned identification number for the transaction. Use this value for any follow-on transactions such as a credit, prior authorization and capture, or void.
RefTransId	String	The transaction ID of a related, previously settled transaction.
TransHash	String	An MD5 hash used to authenticate the response.
AccountNumber	String	The masked account number used for the transaction.
AccountType	String	The account type used for the transaction.
ErrorCode	String	The error code returned when the transaction results in an error.
ErrorText	String	The text description of the error.
SplitTenderPaymentTransId	String	The transaction ID of a payment in a split tender group.
SplitTenderPaymentResponseCode	String	The response code of a payment in a split tender group.
SplitTenderPaymentResponseToCustomer	String	The response message presented to the customer for a payment in a split tender group.
SplitTenderPaymentAuthCode	String	The authorization code of a payment in a split tender group.
SplitTenderPaymentAccountNumber	String	The masked account number of a payment in a split tender group.
SplitTenderPaymentAccountType	String	The account type of a payment in a split tender group.
SplitTenderPaymentRequestedAmount	String	The requested amount for a payment in a split tender group.
SplitTenderPaymentApprovedAmount	String	The approved amount for a payment in a split tender group.
SplitTenderPaymentBalanceOnCard	String	The remaining balance on the card for a payment in a split tender group.
UserFieldName	String	The name of a merchant-defined user field returned in the response.
UserFieldValue	String	The value of the merchant-defined user field returned in the response.
TransHashSha2	String	A SHA-256 hash used to authenticate the response.
NetworkTransId	String	The network transaction ID returned by the processor.

Use this procedure to capture funds for a transaction that was previously authorized using the ChargeCreditCard stored procedure.

You must specify values for the TransId and Amount fields.

Input

Name	Type	Required	Description
TransId	String	True	The unique transaction Id.
Amount	String	True	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.
InvoiceNumber	String	False	Merchant-defined invoice number associated with the order.
Orderdescription	String	False	Description of the item purchased.

Result Set Columns

Name	Type	Description
ResponseCode	String	Overall status of the transaction.Possible values are : 1 = Approved ,2 = Declined ,3 = Error ,4 = Held for Review
AvsResultCode	String	Address Verification Service (AVS) response code. Indicates the result of the AVS filter.
TransId	String	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	String	The transaction ID of a related, previously settled transaction.
Code	String	Response code that represents the status.
Description	String	Text description of the status.

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

Input

Name	Type	Required	Description
TransId	String	True	The unique transaction Id.
Amount	String	True	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.
CardNumber	String	True	The customer's credit card number. Optional for Card Present.
ExpirationMonth	String	True	The customer's credit card expiration month.
ExpirationYear	String	True	The customer's credit card expiration year.
CardCode	String	True	The customer's card code. The three- or four-digit number on the back of a credit card (on the front for American Express).
InvoiceNumber	String	False	Merchant-defined invoice number associated with the order.
TransactionDescription	String	False	Description of the item purchased.
ItemId	String	False	Item identification.
Name	String	False	Name of the item.
Description	String	False	Description of the item.
Quantity	String	False	Quantity purchased.
UnitPrice	String	False	Price of one item. Price of an item per unit, excluding tax, freight, and duty.
CustomerId	String	False	Merchant assigned customer ID. Unique identifier to represent the customer associated with the transaction.
ShippingAddress	String	False	Customer's shipping address.
ShippingFirstName	String	False	First name associated with customer's shipping address.
ShippingLastName	String	False	Last name associated with customer's shipping address.
ShippingState	String	False	State of customer's shipping address.
ShippingZip	String	False	ZIP code of customer's shipping address.
ShippingCountry	String	False	Country of customer's shipping address.
ShippingCity	String	False	City of customer's shipping address.
CustomerAddress	String	False	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.
CustomerFirstName	String	False	First name associated with customer's billing address. Required only when using a European Payment Processor.
CustomerLastName	String	False	Last name associated with customer's billing address. Required only when using a European Payment Processor.
CustomerState	String	False	State of customer's billing address. Required only when using a European Payment Processor.
CustomerZip	String	False	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.
CustomerCountry	String	False	Country of customer's billing address. Required only when using a European Payment Processor.
CustomerCity	String	False	City of customer's billing address. Required only when using a European Payment Processor.

Result Set Columns

Name	Type	Description
ResponseCode	String	Overall status of the transaction.Possible values are : 1 = Approved ,2 = Declined ,3 = Error ,4 = Held for Review
Code	String	Response code that represents the status.
Description	String	Text description of the status.
TransId	String	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.
AvsResultCode	String	Address Verification Service (AVS) response code. Indicates the result of the AVS filter.

Use this procedure to create a customer profile, payment profile, and shipping profile from an existing successful transaction.

Stored Procedure-Specific Information

To execute this stored procedure, enter:

    EXEC CreateCustomerProfileFromTransaction TransId='1234567890'

Input

Name	Type	Required	Description
RefId	String	False	Merchant-assigned reference ID for the request. If included, this value is returned in the response.
TransId	String	True	The payment gateway assigned identification number of the transaction to create the customer profile from.
MerchantCustomerId	String	False	Merchant-assigned identifier for the customer. Used when creating a new customer profile; do not specify together with CustomerProfileId, which adds to an existing profile instead.
Description	String	False	Description of the customer profile. Used when creating a new customer profile; do not specify together with CustomerProfileId, which adds to an existing profile instead.
Email	String	False	The customer's email address. Used when creating a new customer profile; do not specify together with CustomerProfileId, which adds to an existing profile instead.
CustomerProfileId	String	False	An existing customer profile ID to add the payment and shipping profiles from the transaction to. When specified, a new customer profile is not created and the MerchantCustomerId, Description, and Email fields are ignored.
DefaultPaymentProfile	Boolean	False	Whether the payment profile created from the transaction should be marked as the default payment profile. Allowed values are true and false.
DefaultShippingAddress	Boolean	False	Whether the shipping address created from the transaction should be marked as the default shipping address. Allowed values are true and false.
ProfileType	String	False	The type of customer profile to create. Possible values are regular and guest.

Result Set Columns

Name	Type	Description
RefId	String	Merchant-assigned reference ID for the request.
ResultCode	String	Overall status of the request. Possible values are Ok and Error.
Code	String	Response code that represents the status.
Message	String	Text description of the status.
CustomerProfileId	String	The identifier of the customer profile that was created or updated.
CustomerPaymentProfileIdList	String	The identifiers of the payment profiles created from the transaction.
CustomerShippingAddressIdList	String	The identifiers of the shipping address profiles created from the transaction.
ValidationDirectResponseList	String	The raw gateway validation responses returned when the created payment profiles are validated.

Use this procedure to refund a previously settled transaction. Refunds can only be issued for transactions that have already been settled; unsettled transactions must be voided instead.

Stored Procedure-Specific Information

To execute this stored procedure, enter:

    EXEC RefundTransaction RefTransId='1234567890', Amount='25.00', CurrencyCode='USD', CardNumber='1111', ExpirationDate='2025-12'

Input

Name	Type	Required	Description
RefId	String	False	Merchant-assigned reference ID for the request. If included, this value is returned in the response.
Amount	Decimal	True	Amount to refund. This is the total amount and must include tax, shipping, and any other charges. The amount cannot exceed the original transaction amount.
CurrencyCode	String	False	The currency of the refund.
CardNumber	String	False	The customer's credit card number, or the last four digits of the credit card used in the original transaction. Required, together with ExpirationDate, to refund a credit card. Do not specify together with the bank account fields, which refund an eCheck.Net transaction instead.
ExpirationDate	String	False	The expiration date of the credit card used in the original transaction, in YYYY-MM format. Use XXXX if the expiration date is unknown. Required, together with CardNumber, to refund a credit card.
BankAccountType	String	False	The type of bank account used for the eCheck.Net refund. Possible values are checking, savings, and businessChecking.
RoutingNumber	String	False	The ABA routing number of the bank account used for the eCheck.Net refund. Do not specify together with CardNumber and ExpirationDate, which refund a credit card instead.
AccountNumber	String	False	The bank account number used for the eCheck.Net refund. Do not specify together with CardNumber and ExpirationDate, which refund a credit card instead.
NameOnAccount	String	False	The name of the person who holds the bank account used for the eCheck.Net refund.
EcheckType	String	False	The type of eCheck transaction. Possible values are PPD, WEB, CCD, TEL, ARC, and BOC.
BankName	String	False	The name of the bank associated with the bank account used for the eCheck.Net refund.
CheckNumber	String	False	The check number associated with the bank account used for the eCheck.Net refund.
TerminalNumber	String	False	The terminal number used for the transaction.
RefTransId	String	False	The payment gateway assigned identification number of the original transaction to refund. Required to refund a settled transaction; omit only when submitting an unlinked credit.
OrderInvoiceNumber	String	False	Merchant-defined invoice number associated with the order.
OrderDescription	String	False	Description of the item purchased.
LineItemId	String	False	Item identification.
LineItemName	String	False	Name of the item.
LineItemDescription	String	False	Description of the item.
LineItemQuantity	Decimal	False	Quantity purchased.
LineItemUnitPrice	Decimal	False	Price of one item per unit, excluding tax, freight, and duty.
LineItemTaxable	Boolean	False	Indicates whether the line item is taxable.
LineItemUnitOfMeasure	String	False	The unit of measure for the line item.
LineItemTaxAmount	Decimal	False	The tax amount for the line item.
LineItemCommodityCode	String	False	The commodity code for the line item.
LineItemProductCode	String	False	The product code for the line item.
LineItemProductSKU	String	False	The product SKU for the line item.
LineItemDiscountAmount	Decimal	False	The discount amount for the line item.
TaxAmount	Decimal	False	The tax amount for the order.
TaxName	String	False	The name of the tax for the order.
TaxDescription	String	False	The description of the tax for the order.
DutyAmount	Decimal	False	The duty amount for the order.
DutyName	String	False	The name of the duty for the order.
DutyDescription	String	False	The description of the duty for the order.
ShippingAmount	Decimal	False	The shipping charge amount for the order.
ShippingName	String	False	The name of the shipping charge for the order.
ShippingDescription	String	False	The description of the shipping charge for the order.
TaxExempt	Boolean	False	Indicates whether the transaction is tax exempt.
PONumber	String	False	The purchase order number.
CustomerType	String	False	The type of customer. Possible values are individual and business.
CustomerId	String	False	Merchant assigned customer ID. Unique identifier to represent the customer associated with the transaction.
CustomerEmail	String	False	The customer's email address.
BillToFirstName	String	False	First name associated with the customer's billing address.
BillToLastName	String	False	Last name associated with the customer's billing address.
BillToCompany	String	False	Company associated with the customer's billing address.
BillToAddress	String	False	Customer's billing address.
BillToCity	String	False	City of the customer's billing address.
BillToState	String	False	State of the customer's billing address.
BillToZip	String	False	ZIP code of the customer's billing address.
BillToCountry	String	False	Country of the customer's billing address.
BillToPhoneNumber	String	False	Phone number associated with the customer's billing address.
BillToFaxNumber	String	False	Fax number associated with the customer's billing address.
ShipToFirstName	String	False	First name associated with the customer's shipping address.
ShipToLastName	String	False	Last name associated with the customer's shipping address.
ShipToCompany	String	False	Company associated with the customer's shipping address.
ShipToAddress	String	False	Customer's shipping address.
ShipToCity	String	False	City of the customer's shipping address.
ShipToState	String	False	State of the customer's shipping address.
ShipToZip	String	False	ZIP code of the customer's shipping address.
ShipToCountry	String	False	Country of the customer's shipping address.
EmployeeId	String	False	The identifier of the employee processing the transaction.
TransactionSettingName	String	False	The name of a transaction setting. Allowed values include emailCustomer, merchantEmail, allowPartialAuth, headerEmailReceipt, footerEmailReceipt, recurringBilling, duplicateWindow, and testRequest.
TransactionSettingValue	String	False	The value of the transaction setting identified by TransactionSettingName.
UserFieldName	String	False	The name of a merchant-defined user field.
UserFieldValue	String	False	The value of the merchant-defined user field identified by UserFieldName.
SurchargeAmount	Decimal	False	The surcharge amount applied to the transaction.
SurchargeDescription	String	False	The description of the surcharge.
PurchaseLevel	String	False	The purchase level of the transaction data.

Result Set Columns

Name	Type	Description
RefId	String	Merchant-assigned reference ID for the request.
Code	String	Response code that represents the status.
Message	String	Text description of the status.
ResponseCode	Integer	Overall status of the transaction. Possible values are 1 = Approved, 2 = Declined, 3 = Error, 4 = Held for Review.
AuthCode	String	The authorization or approval code for the transaction.
AvsResultCode	String	Address Verification Service (AVS) response code. Indicates the result of the AVS filter.
CvvResultCode	String	Card code verification (CCV) response code.
CavvResultCode	String	Cardholder authentication verification value (CAVV) response code.
TransId	String	The payment gateway assigned identification number for the transaction. Use this value for any follow-on transactions such as a credit, prior authorization and capture, or void.
RefTransId	String	The transaction ID of a related, previously settled transaction.
TransHash	String	An MD5 hash used to authenticate the response.
AccountNumber	String	The masked account number used for the transaction.
AccountType	String	The account type used for the transaction.
ErrorCode	String	The error code returned when the transaction results in an error.
ErrorText	String	The text description of the error.
UserFieldName	String	The name of a merchant-defined user field returned in the response.
UserFieldValue	String	The value of the merchant-defined user field returned in the response.
TransHashSha2	String	A SHA-256 hash used to authenticate the response.

Use this procedure to void a transaction that was previously authorized but has not yet been settled. Only unsettled transactions can be voided.

Stored Procedure-Specific Information

To execute this stored procedure, enter:

    EXEC VoidTransaction RefTransId='1234567890'

Input

Name	Type	Required	Description
RefId	String	False	Merchant-assigned reference ID for the request. If included, this value is returned in the response.
TerminalNumber	String	False	The merchant's in-store terminal number. Can identify the cashiers or kiosks used.
RefTransId	String	True	The payment gateway assigned identification number of the original transaction to void.

Result Set Columns

Name	Type	Description
RefId	String	Merchant-assigned reference ID for the request.
Code	String	Response code that represents the status.
Message	String	Text description of the status.
ResponseCode	Integer	Overall status of the transaction. Possible values are 1 = Approved, 2 = Declined, 3 = Error, 4 = Held for Review.
AuthCode	String	The authorization or approval code for the transaction.
AvsResultCode	String	Address Verification Service (AVS) response code. Indicates the result of the AVS filter.
CvvResultCode	String	Card code verification (CCV) response code.
CavvResultCode	String	Cardholder authentication verification value (CAVV) response code.
TransId	String	The payment gateway assigned identification number for the transaction. Use this value for any follow-on transactions such as a credit, prior authorization and capture, or void.
RefTransId	String	The transaction ID of a related, previously settled transaction.
TransHash	String	An MD5 hash used to authenticate the response.
AccountNumber	String	The masked account number used for the transaction.
AccountType	String	The account type used for the transaction.
ErrorCode	String	The error code returned when the transaction results in an error.
ErrorText	String	The text description of the error.
SplitTenderPaymentTransId	String	The transaction ID of a payment in a split tender group.
SplitTenderPaymentResponseCode	String	The response code of a payment in a split tender group.
SplitTenderPaymentResponseToCustomer	String	The response message presented to the customer for a payment in a split tender group.
SplitTenderPaymentAuthCode	String	The authorization code of a payment in a split tender group.
SplitTenderPaymentAccountNumber	String	The masked account number of a payment in a split tender group.
SplitTenderPaymentAccountType	String	The account type of a payment in a split tender group.
SplitTenderPaymentRequestedAmount	String	The requested amount for a payment in a split tender group.
SplitTenderPaymentApprovedAmount	String	The approved amount for a payment in a split tender group.
SplitTenderPaymentBalanceOnCard	String	The remaining balance on the card for a payment in a split tender group.
TransHashSha2	String	A SHA-256 hash used to authenticate the response.

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for Authorize.net:

• sys_catalogs: Lists the available databases.
• sys_schemas: Lists the available schemas.
• sys_tables: Lists the available tables and views.
• sys_tablecolumns: Describes the columns of the available tables and views.
• sys_procedures: Describes the available stored procedures.
• sys_procedureparameters: Describes stored procedure parameters.
• sys_keycolumns: Describes the primary and foreign keys.
• sys_indexes: Describes the available indexes.

Data Source Tables

The following tables return information about how to connect to and query the data source:

• sys_connection_props: Returns information on the available connection properties.
• sys_sqlinfo: Describes the SELECT queries that the Cloud can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries

• sys_identity: Returns information about batch operations or single updates.

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs

Columns

Name	Type	Description
CatalogName	String	The database name.

Lists the available schemas.

The following query retrieves all available schemas:

          SELECT * FROM sys_schemas
          

Columns

Name	Type	Description
CatalogName	String	The database name.
SchemaName	String	The schema name.

Lists the available tables.

The following query retrieves the available tables and views:

          SELECT * FROM sys_tables
          

Columns

Name	Type	Description
CatalogName	String	The database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view.
TableType	String	The table type (table or view).
Description	String	A description of the table or view.
IsUpdateable	Boolean	Whether the table can be updated.
IsInsertable	Boolean	Whether the table can be inserted into.
IsDeleteable	Boolean	Whether rows can be deleted from the table.

Describes the columns of the available tables and views.

The following query returns the columns and data types for the SettledBatchList table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName = 'SettledBatchList' 

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view containing the column.
ColumnName	String	The column name.
DataTypeName	String	The data type name.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
Length	Int32	The storage size of the column.
DisplaySize	Int32	The designated column's normal maximum width in characters.
NumericPrecision	Int32	The maximum number of digits in numeric data. The column length in characters for character and date-time data.
NumericScale	Int32	The column scale or number of digits to the right of the decimal point.
IsNullable	Boolean	Whether the column can contain null.
Description	String	A brief description of the column.
Ordinal	Int32	The sequence number of the column.
IsAutoIncrement	String	Whether the column value is assigned in fixed increments.
IsGeneratedColumn	String	Whether the column is generated.
IsHidden	Boolean	Whether the column is hidden.
IsArray	Boolean	Whether the column is an array.
IsReadOnly	Boolean	Whether the column is read-only.
IsKey	Boolean	Indicates whether a field returned from sys_tablecolumns is the primary key of the table.
ColumnType	String	The role or classification of the column in the schema. Possible values include SYSTEM, LINKEDCOLUMN, NAVIGATIONKEY, REFERENCECOLUMN, and NAVIGATIONPARENTCOLUMN.
ColumnCapabilities	Int32	A bit mask denoting the column's write capabilities. The value is the sum of the following: 1 if the column is required for INSERTs, 2 if the column is allowed for INSERTs, and 4 if the column is allowed for UPDATEs. A value of 0 indicates that the write capabilities of the column are unknown or that the column is read-only.

Lists the available stored procedures.

The following query retrieves the available stored procedures:

          SELECT * FROM sys_procedures
          

Columns

Name	Type	Description
CatalogName	String	The database containing the stored procedure.
SchemaName	String	The schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure.
Description	String	A description of the stored procedure.
ProcedureType	String	The type of the procedure, such as PROCEDURE or FUNCTION.

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the SelectEntries stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SelectEntries' AND Direction = 1 OR Direction = 2

To include result set columns in addition to the parameters, set the IncludeResultColumns pseudo column to True:

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SelectEntries' AND IncludeResultColumns='True'

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the stored procedure.
SchemaName	String	The name of the schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure containing the parameter.
ColumnName	String	The name of the stored procedure parameter.
Direction	Int32	An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
DataTypeName	String	The name of the data type.
NumericPrecision	Int32	The maximum precision for numeric data. The column length in characters for character and date-time data.
Length	Int32	The number of characters allowed for character data. The number of digits allowed for numeric data.
NumericScale	Int32	The number of digits to the right of the decimal point in numeric data.
IsNullable	Boolean	Whether the parameter can contain null.
IsRequired	Boolean	Whether the parameter is required for execution of the procedure.
IsArray	Boolean	Whether the parameter is an array.
Description	String	The description of the parameter.
Ordinal	Int32	The index of the parameter.
Values	String	The values you can set in this parameter are limited to those shown in this column. Possible values are comma-separated.
SupportsStreams	Boolean	Whether the parameter represents a file that you can pass as either a file path or a stream.
IsPath	Boolean	Whether the parameter is a target path for a schema creation operation.
Default	String	The value used for this parameter when no value is specified.
SpecificName	String	A label that, when multiple stored procedures have the same name, uniquely identifies each identically-named stored procedure. If there's only one procedure with a given name, its name is simply reflected here.
IsCDataProvided	Boolean	Whether the procedure is added/implemented by CData, as opposed to being a native Authorize.net procedure.

Pseudocolumns

Name	Type	Description
IncludeResultColumns	Boolean	Whether the output should include columns from the result set in addition to parameters. Defaults to False.

Describes the primary and foreign keys.

The following query retrieves the primary key for the SettledBatchList table:

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='SettledBatchList' 
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
IsKey	Boolean	Whether the column is a primary key in the table referenced in the TableName field.
IsForeignKey	Boolean	Whether the column is a foreign key referenced in the TableName field.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.
ForeignKeyType	String	Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key.

Describes the primary keys.

The following query retrieves the primary keys from all tables and views:

         SELECT * FROM sys_primarykeys
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
KeySeq	String	The sequence number of the primary key.
KeyName	String	The name of the primary key.

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

          SELECT * FROM sys_indexes WHERE IsPrimary='false'
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the index.
SchemaName	String	The name of the schema containing the index.
TableName	String	The name of the table containing the index.
IndexName	String	The index name.
ColumnName	String	The name of the column associated with the index.
IsUnique	Boolean	True if the index is unique. False otherwise.
IsPrimary	Boolean	True if the index is a primary key. False otherwise.
Type	Int16	An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3).
SortOrder	String	The sort order: A for ascending or D for descending.
OrdinalPosition	Int16	The sequence number of the column in the index.

Returns information on the available connection properties and those set in the connection string.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

Name	Type	Description
Name	String	The name of the connection property.
ShortDescription	String	A brief description.
Type	String	The data type of the connection property.
Default	String	The default value if one is not explicitly set.
Values	String	A comma-separated list of possible values. A validation error is thrown if another value is specified.
Value	String	The value you set or a preconfigured default.
Required	Boolean	Whether the property is required to connect.
Category	String	The category of the connection property.
IsSessionProperty	String	Whether the property is a session property, used to save information about the current connection.
Sensitivity	String	The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms.
PropertyName	String	A camel-cased truncated form of the connection property name.
Ordinal	Int32	The index of the parameter.
CatOrdinal	Int32	The index of the parameter category.
Hierarchy	String	Shows dependent properties associated that need to be set alongside this one.
Visible	Boolean	Informs whether the property is visible in the connection UI.
ETC	String	Various miscellaneous information about the property.

Describes the SELECT query processing that the Cloud can offload to the data source.

See SQL Compliance for SQL syntax details.

Discovering the Data Source's SELECT Capabilities

Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.

Name	Description	Possible Values
AGGREGATE_FUNCTIONS	Supported aggregation functions.	AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT	Whether COUNT function is supported.	YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR	The opening character used to escape an identifier.	[
IDENTIFIER_QUOTE_CLOSE_CHAR	The closing character used to escape an identifier.	]
SUPPORTED_OPERATORS	A list of supported SQL operators.	=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY	Whether GROUP BY is supported, and, if so, the degree of support.	NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIES	The supported varieties of outer joins supported.	NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINS	Whether outer joins are supported.	YES, NO
SUBQUERIES	Whether subqueries are supported, and, if so, the degree of support.	NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONS	Supported string functions.	LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONS	Supported numeric functions.	ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONS	Supported date/time functions.	NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLES	Indicates tables skipped during replication.
REPLICATION_TIMECHECK_COLUMNS	A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication.
IDENTIFIER_PATTERN	String value indicating what string is valid for an identifier.
SUPPORT_TRANSACTION	Indicates if the provider supports transactions such as commit and rollback.	YES, NO
DIALECT	Indicates the SQL dialect to use.
KEY_PROPERTIES	Indicates the properties which identify the uniform database.
SUPPORTS_MULTIPLE_SCHEMAS	Indicates if multiple schemas may exist for the provider.	YES, NO
SUPPORTS_MULTIPLE_CATALOGS	Indicates if multiple catalogs may exist for the provider.	YES, NO
DATASYNCVERSION	The CData Data Sync version needed to access this driver.	Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY	The CData Data Sync category of this driver.	Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL	Whether enhanced SQL functionality beyond what is offered by the API is supported.	TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS	Whether batch operations are supported.	YES, NO
SQL_CAP	All supported SQL capabilities for this driver.	SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS	A string value specifies the preferred cacheOptions.
ENABLE_EF_ADVANCED_QUERY	Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side.	YES, NO
PSEUDO_COLUMNS	A string array indicating the available pseudo columns.
MERGE_ALWAYS	If the value is true, The Merge Mode is forcibly executed in Data Sync.	TRUE, FALSE
REPLICATION_MIN_DATE_QUERY	A select query to return the replicate start datetime.
REPLICATION_MIN_FUNCTION	Allows a provider to specify the formula name to use for executing a server side min.
REPLICATION_START_DATE	Allows a provider to specify a replicate startdate.
REPLICATION_MAX_DATE_QUERY	A select query to return the replicate end datetime.
REPLICATION_MAX_FUNCTION	Allows a provider to specify the formula name to use for executing a server side max.
IGNORE_INTERVALS_ON_INITIAL_REPLICATE	A list of tables which will skip dividing the replicate into chunks on the initial replicate.
CHECKCACHE_USE_PARENTID	Indicates whether the CheckCache statement should be done against the parent key column.	TRUE, FALSE
CREATE_SCHEMA_PROCEDURES	Indicates stored procedures that can be used for generating schema files.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns

Name	Type	Description
NAME	String	A component of SQL syntax, or a capability that can be processed on the server.
VALUE	String	Detail on the supported SQL or SQL syntax.

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

         SELECT * FROM sys_identity
          

Columns

Name	Type	Description
Id	String	The database-generated Id returned from a data modification operation.
Batch	String	An identifier for the batch. 1 for a single operation.
Operation	String	The result of the operation in the batch: INSERTED, UPDATED, or DELETED.
Message	String	SUCCESS or an error message if the update in the batch failed.

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information

Columns

Name	Type	Description
Product	String	The name of the product.
Version	String	The version number of the product.
Datasource	String	The name of the datasource the product connects to.
NodeId	String	The unique identifier of the machine where the product is installed.
HelpURL	String	The URL to the product's help documentation.
License	String	The license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.)
Location	String	The file path location where the product's library is stored.
Environment	String	The version of the environment or rumtine the product is currently running under.
DataSyncVersion	String	The tier of CData Sync required to use this connector.
DataSyncCategory	String	The category of CData Sync functionality (e.g., Source, Destination).

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

Authentication

---

Property	Description
LoginID	The Authorize.net Login Id.
TransactionKey	The Authorize.net transaction key.
UseSandbox	A boolean indicating if you are using a Sandbox account. The provider makes requests to the production environment by default.

SSL

---

Property	Description
SSLServerCert	Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Logging

---

Property	Description
Verbosity	Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Schema

---

Property	Description
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Miscellaneous

---

Property	Description
MaxRows	Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
PseudoColumns	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
ThrowsKeyNotFound	Specifies whether or not throws an exception if there is no rows updated.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.

This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.

---

Property	Description
LoginID	The Authorize.net Login Id.
TransactionKey	The Authorize.net transaction key.
UseSandbox	A boolean indicating if you are using a Sandbox account. The provider makes requests to the production environment by default.

The Authorize.net Login Id.

Data Type

string

Default Value

""

Remarks

The API login Id associated with your payment gateway account. This property is found in the Security Settings under Account -> Settings and is used to authenticate that you are authorized to submit website transactions. Note that this value is not the same as the login Id that you use to log in to the Merchant Interface.

The Authorize.net transaction key.

Data Type

string

Default Value

""

Remarks

The transaction key associated with your payment gateway account. This property is found in the Security Settings under Account -> Settings and is used to authenticate that you are authorized to submit website transactions.

A boolean indicating if you are using a Sandbox account. The provider makes requests to the production environment by default.

Data Type

bool

Default Value

false

Remarks

The Authorize.net API to be used to process transactions. If you are using a production account, this property can be left blank. If you are using a developer test account, set this to 'TRUE'.

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.

---

Property	Description
SSLServerCert	Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Data Type

string

Default Value

""

Remarks

If you are using a TLS/SSL connection, use this property to specify the TLS/SSL certificate to be accepted from the server. If you specify a value for this property, all other certificates that are not trusted by the machine are rejected.

This property can take the following forms:

Description	Example
A full PEM Certificate (example shortened for brevity)	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
A path to a local file containing the certificate	C:\cert.cer
The public key (example shortened for brevity)	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
The MD5 Thumbprint (hex values can also be either space- or colon-separated)	ecadbdda5a1529c58a1e9e09828d70e4
The SHA1 Thumbprint (hex values can also be either space- or colon-separated)	34a929226ae0819f2ec14b4a3d904f801cbb150d

Note: It is possible to use '*' to signify that all certificates should be accepted, but due to security concerns this is not recommended.

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.

---

Property	Description
Verbosity	Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Data Type

string

Default Value

"1"

Remarks

This property defines the level of detail the Cloud includes in the log file. Higher verbosity levels increase the detail of the logged information, but may also result in larger log files and slower performance due to the additional data being captured.

The default verbosity level is 1, which is recommended for regular operation. Higher verbosity levels are primarily intended for debugging purposes. For more information on each level, refer to Logging.

When combined with the LogModules property, Verbosity can refine logging to specific categories of information.