Adding a Connection to Authorize.net

To add a connection to Authorize.net:

1. In the application console, navigate to the Connections page.
2. At the Add Connections panel, select the icon for the connection you want to add.
3. If the Authorize.net icon is not available, click the Add More icon to download and install the Authorize.net connector from the CData site.

For required properties, see the Settings tab.

For connection properties that are not typically required, see the Advanced tab.

Before You Connect

You can obtain the necessary connection values by logging into your Merchant account and clicking Account > Settings.

The LoginID and TransactionKey are then displayed in the Security Settings section.

Connecting to Authorize.net

Set the following to connect:

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

This section details a selection of advanced features of the Authorize.net Sync App.

User Defined Views

The Sync App allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.

SSL Configuration

Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.

Firewall and Proxy

Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.

Query Processing

The Sync App offloads as much of the SELECT statement processing as possible to Authorize.net and then processes the rest of the query in memory (client-side).

See Query Processing for more information.

Logging

See Logging for an overview of configuration settings that can be used to refine CData logging. For basic logging, you only need to set two connection properties, but there are numerous features that support more refined logging, where you can select subsets of information to be logged using the LogModules connection property.

Customizing the SSL Configuration

By default, the Sync App attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.

To specify another certificate, see the SSLServerCert property for the available formats to do so.

Connecting Through a Firewall or Proxy

HTTP Proxies

To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.

In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.

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

API limitations and requirements are documented in this section; you can use the SupportEnhancedSQL feature, set by default, to circumvent most of these limitations.

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.

Authorize.net Connector for CData Sync 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.
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.

Table 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		The total amount of all transactions as returned in the response of a getBatchStatistics call. Only applicable for credit card transactions.
BatchStatisticsCount	Integer		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.
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.

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

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.

Table 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 TransactionList WHERE CustomerProfileId = '1915622429'

SELECT * FROM TransactionList 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.
SettlementTimeLocal	Datetime		Date and time the transaction was submitted in local format: YYYY-MM-DDTHH:MM:SS.mmm
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.

Query settled batches for an Authorize.net merchant account.

Table Specific Information

The following columns can be specified in the WHERE clause for the SettledBatchList table: 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-01' AND SettlementTime < '2014-09-20' 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-01'

Get data before the SettlementTime value.

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

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.

Pseudo-Columns

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 TransactionDetails to retrieve Items for an Authorize.net merchant account.

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

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

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

Table 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.
SettlementTimeLocal	Datetime		Date and time the transaction was submitted in local format: YYYY-MM-DDTHH:MM:SS.mmm
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.

Query Unsettled Transactions for an Authorize.net merchant account.

Table Specific Information

This table does not support any columns in the WHERE clause.

SELECT * FROM UnsettledTransactionList

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.

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	The certificate to be accepted from the server when connecting using TLS/SSL.

Firewall

---

Property	Description
FirewallType	The protocol used by a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
FirewallPassword	A password used to authenticate to a proxy-based firewall.

Proxy

---

Property	Description
ProxyAutoDetect	This indicates whether to use the system proxy settings or not.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Logging

---

Property	Description
LogModules	Core modules to be included in the log file.

Schema

---

Property	Description
Location	A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Tables	This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Views	Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Miscellaneous

---

Property	Description
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Other	These hidden properties are used only in specific use cases.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViews	A filepath pointing to the JSON configuration file containing your custom views.

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.

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.

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.

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	The certificate to be accepted from the server when connecting using TLS/SSL.

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

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is 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

If not specified, any certificate trusted by the machine is accepted.

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

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

---

Property	Description
FirewallType	The protocol used by a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
FirewallPassword	A password used to authenticate to a proxy-based firewall.

The protocol used by a proxy-based firewall.

Remarks

This property specifies the protocol that the Sync App will use to tunnel traffic through the FirewallServer proxy. Note that by default, the Sync App connects to the system proxy; to disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.

Type	Default Port	Description
TUNNEL	80	When this is set, the Sync App opens a connection to Authorize.net and traffic flows back and forth through the proxy.
SOCKS4	1080	When this is set, the Sync App sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted.
SOCKS5	1080	When this is set, the Sync App sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes.

To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.

The name or IP address of a proxy-based firewall.

Remarks

This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.

Note that the Sync App uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.

The TCP port for a proxy-based firewall.

Remarks

This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.

The user name to use to authenticate with a proxy-based firewall.

Remarks

The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.

A password used to authenticate to a proxy-based firewall.

Remarks

This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.

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

---

Property	Description
ProxyAutoDetect	This indicates whether to use the system proxy settings or not.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

This indicates whether to use the system proxy settings or not.

Remarks

This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.

The hostname or IP address of a proxy to route HTTP traffic through.

Remarks

The hostname or IP address of a proxy to route HTTP traffic through. The Sync App can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.

If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.

By default, the Sync App uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.

The TCP port the ProxyServer proxy is running on.

Remarks

The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.

The authentication type to use to authenticate to the ProxyServer proxy.

Remarks

This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.

Note that the Sync App will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

The authentication type can be one of the following:

• BASIC: The Sync App performs HTTP BASIC authentication.
• DIGEST: The Sync App performs HTTP DIGEST authentication.
• NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
• PROPRIETARY: The Sync App does not generate an NTLM or Kerberos token. You must supply this token in the Authorization header of the HTTP request.

If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.

A user name to be used to authenticate to the ProxyServer proxy.

Remarks

The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:

user@domain
domain\user

A password to be used to authenticate to the ProxyServer proxy.

Remarks

This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.

If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.

If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.

For SOCKS 5 authentication or tunneling, see FirewallType.

By default, the Sync App uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.

The SSL type to use when connecting to the ProxyServer proxy.

Remarks

This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:

AUTO	Default setting. If the URL is an HTTPS URL, the Sync App will use the TUNNEL option. If the URL is an HTTP URL, the component will use the NEVER option.
ALWAYS	The connection is always SSL enabled.
NEVER	The connection is not SSL enabled.
TUNNEL	The connection is through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.

A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Remarks

The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.

Note that the Sync App uses the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

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

---

Property	Description
LogModules	Core modules to be included in the log file.

Core modules to be included in the log file.

Remarks

Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.

See the Logging page for an overview.

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

---

Property	Description
Location	A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Tables	This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Views	Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

A path to the directory that contains the schema files defining tables, views, and stored procedures.

Remarks

The path to a directory which contains the schema files for the Sync App (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is "%APPDATA%\\CData\\AuthorizeNet Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:

Platform	%APPDATA%
Windows	The value of the APPDATA environment variable
Linux	~/.config

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Remarks

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.

Remarks

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Remarks

Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

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

---

Property	Description
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Other	These hidden properties are used only in specific use cases.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViews	A filepath pointing to the JSON configuration file containing your custom views.

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

Remarks

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

These hidden properties are used only in specific use cases.

Remarks

The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting

DefaultColumnSize	Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMT	Determines whether to convert date-time values to GMT, instead of the local time of the machine.
RecordToFile=filename	Records the underlying socket data transfer to the specified file.

This property indicates whether or not to include pseudo columns as columns to the table.

Remarks

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".

The value in seconds until the timeout error is thrown, canceling the operation.

Remarks

If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.

If Timeout expires and the operation is not yet complete, the Sync App throws an exception.

A filepath pointing to the JSON configuration file containing your custom views.

Remarks

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The Sync App automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the Sync App.

This User Defined View configuration file is formatted as follows:

• Each root element defines the name of a view.
• Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

{
	"MyView": {
		"query": "SELECT * FROM SettledBatchList WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json

Note that the specified path is not embedded in quotation marks.