Authorize.net Connector for CData Sync

Build 24.0.9175
  • Authorize.net
    • Establishing a Connection
    • Advanced Features
      • SSL Configuration
      • Firewall and Proxy
    • Data Model
      • Views
        • BatchStatistics
        • CustomerProfileDetails
        • CustomerProfiles
        • CustomerProfileTransactionList
        • SettledBatchList
        • TransactionDetailItems
        • TransactionDetails
        • TransactionList
        • UnsettledTransactionList
    • Connection String Options
      • Authentication
        • LoginID
        • TransactionKey
        • UseSandbox
      • SSL
        • SSLServerCert
      • Firewall
        • FirewallType
        • FirewallServer
        • FirewallPort
        • FirewallUser
        • FirewallPassword
      • Proxy
        • ProxyAutoDetect
        • ProxyServer
        • ProxyPort
        • ProxyAuthScheme
        • ProxyUser
        • ProxyPassword
        • ProxySSLType
        • ProxyExceptions
      • Logging
        • LogModules
      • Schema
        • Location
        • BrowsableSchemas
        • Tables
        • Views
      • Miscellaneous
        • MaxRows
        • Other
        • PseudoColumns
        • Timeout
        • UserDefinedViews

Authorize.net Connector for CData Sync

Overview

The CData Sync App provides a straightforward way to continuously pipeline your Authorize.net data to any database, data lake, or data warehouse, making it easily available for Analytics, Reporting, AI, and Machine Learning.

The Authorize.net connector can be used from the CData Sync application to pull data from Authorize.net and move it to any of the supported destinations.

Authorize.net Version Support

Latest version of Authorize.net API, consisting of Transaction Reporting and Customer Profiles endpoints.

Authorize.net Connector for CData Sync

Establishing a Connection

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.

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.

Authorize.net Connector for CData Sync

Advanced Features

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

User Defined Views

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

SSL Configuration

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

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

For further information, see Query Processing.

Logging

For an overview of configuration settings that can be used to refine CData logging, see Logging. Only two connection properties are required for basic logging, but there are numerous features that support more refined logging, which enables you to use the LogModules connection property to specify subsets of information to be logged.

Authorize.net Connector for CData Sync

SSL Configuration

Customizing the SSL Configuration

By default, the Sync App 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.

Authorize.net Connector for CData Sync

Firewall and Proxy

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

Authorize.net Connector for CData Sync

Data Model

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.

Authorize.net Connector for CData Sync

Views

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.

Authorize.net Connector for CData Sync

BatchStatistics

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.

Authorize.net Connector for CData Sync

CustomerProfileDetails

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.

Authorize.net Connector for CData Sync

CustomerProfiles

Query Customer Profile IDs for Authorize.net merchant account.

Columns

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

Authorize.net Connector for CData Sync

CustomerProfileTransactionList

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.

Authorize.net Connector for CData Sync

SettledBatchList

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.

Authorize.net Connector for CData Sync

TransactionDetailItems

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.

Authorize.net Connector for CData Sync

TransactionDetails

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.

Authorize.net Connector for CData Sync

TransactionList

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.

Authorize.net Connector for CData Sync

UnsettledTransactionList

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.

Authorize.net Connector for CData Sync

Connection String Options

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


PropertyDescription
LoginIDThe Authorize.net Login Id.
TransactionKeyThe Authorize.net transaction key.
UseSandboxA boolean indicating if you are using a Sandbox account. The provider makes requests to the production environment by default.

SSL


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

Firewall


PropertyDescription
FirewallTypeSpecifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServerIdentifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPortSpecifies the TCP port to be used for a proxy-based firewall.
FirewallUserIdentifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPasswordSpecifies the password of the user account authenticating to a proxy-based firewall.

Proxy


PropertyDescription
ProxyAutoDetectSpecifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServerThe hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPortThe TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthSchemeSpecifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUserThe username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPasswordThe password associated with the user specified in the ProxyUser connection property.
ProxySSLTypeThe SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptionsA semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Logging


PropertyDescription
LogModulesSpecifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Schema


PropertyDescription
LocationSpecifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemasOptional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
TablesOptional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
ViewsOptional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Miscellaneous


PropertyDescription
MaxRowsSpecifies the maximum rows returned for queries without aggregation or GROUP BY.
OtherSpecifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
UserDefinedViewsSpecifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.
Authorize.net Connector for CData Sync

Authentication

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


PropertyDescription
LoginIDThe Authorize.net Login Id.
TransactionKeyThe Authorize.net transaction key.
UseSandboxA boolean indicating if you are using a Sandbox account. The provider makes requests to the production environment by default.
Authorize.net Connector for CData Sync

LoginID

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.

Authorize.net Connector for CData Sync

TransactionKey

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.

Authorize.net Connector for CData Sync

UseSandbox

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

Authorize.net Connector for CData Sync

SSL

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


PropertyDescription
SSLServerCertSpecifies the certificate to be accepted from the server when connecting using TLS/SSL.
Authorize.net Connector for CData Sync

SSLServerCert

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

Authorize.net Connector for CData Sync

Firewall

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


PropertyDescription
FirewallTypeSpecifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServerIdentifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPortSpecifies the TCP port to be used for a proxy-based firewall.
FirewallUserIdentifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPasswordSpecifies the password of the user account authenticating to a proxy-based firewall.
Authorize.net Connector for CData Sync

FirewallType

Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

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

The following table provides port number information for each of the supported protocols.

Protocol Default Port Description
TUNNEL 80 The port where the Sync App opens a connection to Authorize.net. Traffic flows back and forth via the proxy at this location.
SOCKS4 1080 The port where the Sync App opens a connection to Authorize.net. SOCKS 4 then passes theFirewallUser value to the proxy, which determines whether the connection request should be granted.
SOCKS5 1080 The port where the Sync App sends data to Authorize.net. If the SOCKS 5 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.

Authorize.net Connector for CData Sync

FirewallServer

Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Authorize.net Connector for CData Sync

FirewallPort

Specifies the TCP port to be used for a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Authorize.net Connector for CData Sync

FirewallUser

Identifies the user ID of the account authenticating to a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Authorize.net Connector for CData Sync

FirewallPassword

Specifies the password of the user account authenticating to a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Authorize.net Connector for CData Sync

Proxy

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


PropertyDescription
ProxyAutoDetectSpecifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServerThe hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPortThe TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthSchemeSpecifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUserThe username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPasswordThe password associated with the user specified in the ProxyUser connection property.
ProxySSLTypeThe SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptionsA semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.
Authorize.net Connector for CData Sync

ProxyAutoDetect

Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.

Remarks

When this connection property is set to True, the Sync App checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details).

This connection property takes precedence over other proxy settings. Set to False if you want to manually configure the Sync App to connect to a specific proxy server.

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

Authorize.net Connector for CData Sync

ProxyServer

The hostname or IP address of the proxy server that you want to route HTTP traffic through.

Remarks

The Sync App only routes HTTP traffic through the proxy server specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.

Authorize.net Connector for CData Sync

ProxyPort

The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.

Remarks

The Sync App only routes HTTP traffic through the proxy server port specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead routes HTTP traffic through the proxy server port specified in your system proxy settings.

For other proxy types, see FirewallType.

Authorize.net Connector for CData Sync

ProxyAuthScheme

Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.

Remarks

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.
  • NTLM: The Sync App retrieves an NTLM token.
  • NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
  • NONE: Set this when the ProxyServer does not require authentication.

For all values other than "NONE", you must also set the ProxyUser and ProxyPassword connection properties.

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

Authorize.net Connector for CData Sync

ProxyUser

The username of a user account registered with the proxy server specified in the ProxyServer connection property.

Remarks

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

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:

ProxyAuthScheme Value Value to set for ProxyUser
BASIC The user name of a user registered with the proxy server.
DIGEST The user name of a user registered with the proxy server.
NEGOTIATE The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user.
NTLM The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user.
NONE Do not set the ProxyPassword connection property.

The Sync App only uses this username if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the username specified in your system proxy settings.

Authorize.net Connector for CData Sync

ProxyPassword

The password associated with the user specified in the ProxyUser connection property.

Remarks

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

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:

ProxyAuthScheme Value Value to set for ProxyPassword
BASIC The password associated with the proxy server user specified in ProxyUser.
DIGEST The password associated with the proxy server user specified in ProxyUser.
NEGOTIATE The password associated with the Windows user account specified in ProxyUser.
NTLM The password associated with the Windows user account specified in ProxyUser.
NONE Do not set the ProxyPassword connection property.

For SOCKS 5 authentication or tunneling, see FirewallType.

The Sync App only uses this password if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the password specified in your system proxy settings.

Authorize.net Connector for CData Sync

ProxySSLType

The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.

Remarks

This property determines when to use SSL for the connection to the HTTP proxy specified by ProxyServer. You can set this connection property to the following values :

AUTODefault setting. If ProxyServer is set to an HTTPS URL, the Sync App uses the TUNNEL option. If ProxyServer is set to an HTTP URL, the component uses the NEVER option.
ALWAYSThe connection is always SSL enabled.
NEVERThe connection is not SSL enabled.
TUNNELThe connection is made through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.

Authorize.net Connector for CData Sync

ProxyExceptions

A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

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, set ProxyAutoDetect to False.

Authorize.net Connector for CData Sync

Logging

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


PropertyDescription
LogModulesSpecifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.
Authorize.net Connector for CData Sync

LogModules

Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Remarks

This property lets you customize the log file content by specifying the logging modules to include. Logging modules categorize logged information into distinct areas, such as query execution, metadata, or SSL communication. Each module is represented by a four-character code, with some requiring a trailing space for three-letter names.

For example, EXEC logs query execution, and INFO logs general provider messages. To include multiple modules, separate their names with semicolons as follows: INFO;EXEC;SSL.

The Verbosity connection property takes precedence over the module-based filtering specified by this property. Only log entries that meet the verbosity level and belong to the specified modules are logged. Leave this property blank to include all available modules in the log file.

For a complete list of available modules and detailed guidance on configuring logging, refer to the Advanced Logging section in Logging.

Authorize.net Connector for CData Sync

Schema

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


PropertyDescription
LocationSpecifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemasOptional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
TablesOptional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
ViewsOptional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .
Authorize.net Connector for CData Sync

Location

Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.

Remarks

The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) 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, where %APPDATA% is set to the user's configuration directory:

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

Authorize.net Connector for CData Sync

BrowsableSchemas

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

Remarks

Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.

Authorize.net Connector for CData Sync

Tables

Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .

Remarks

Listing all available tables from some databases can take extra time, thus degrading performance. Providing a list of tables in the connection string saves time and improves performance.

If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, 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: If you are connecting to a data source with multiple schemas or catalogs, you must specify each table you want to view by its fully qualified name. This avoids ambiguity between tables that may exist in multiple catalogs or schemas.

Authorize.net Connector for CData Sync

Views

Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Remarks

Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.

If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, 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: If you are connecting to a data source with multiple schemas or catalogs, you must specify each view you want to examine by its fully qualified name. This avoids ambiguity between views that may exist in multiple catalogs or schemas.

Authorize.net Connector for CData Sync

Miscellaneous

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


PropertyDescription
MaxRowsSpecifies the maximum rows returned for queries without aggregation or GROUP BY.
OtherSpecifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
UserDefinedViewsSpecifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.
Authorize.net Connector for CData Sync

MaxRows

Specifies the maximum rows returned for queries without aggregation or GROUP BY.

Remarks

This property sets an upper limit on the number of rows the Sync App returns for queries that do not include aggregation or GROUP BY clauses. This limit ensures that queries do not return excessively large result sets by default.

When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting. If MaxRows is set to "-1", no row limit is enforced unless a LIMIT clause is explicitly included in the query.

This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.

Authorize.net Connector for CData Sync

Other

Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.

Remarks

This property allows advanced users to configure hidden properties for specialized scenarios. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. Multiple properties can be defined in a semicolon-separated list.

Note: It is strongly recommended to set these properties only when advised by the support team to address specific scenarios or issues.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting

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

Authorize.net Connector for CData Sync

PseudoColumns

Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.

Remarks

This property allows you to define which pseudocolumns the Sync App exposes as table columns.

To specify individual pseudocolumns, use the following format: "Table1=Column1;Table1=Column2;Table2=Column3"

To include all pseudocolumns for all tables use: "*=*"

Authorize.net Connector for CData Sync

Timeout

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.

Remarks

This property controls the maximum time, in seconds, that the Sync App waits for an operation to complete before canceling it. If the timeout period expires before the operation finishes, the Sync App cancels the operation and throws an exception.

The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.

Setting this property to 0 disables the timeout, allowing operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server. Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

Authorize.net Connector for CData Sync

UserDefinedViews

Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

Remarks

This property allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the Sync App and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the 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)"
	}
}

You can define multiple views in a single file and specify the filepath using this property. For example: UserDefinedViews=C:\Path\To\UserDefinedViews.json. When you use this property, only the specified views are seen by the Sync App.

Refer to User Defined Views for more information.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 24.0.9175