Cloud

Build 25.0.9539
  • Authorize.net
    • Getting Started
      • Establishing a Connection
      • SSL Configuration
      • Firewall and Proxy
    • Data Model
      • Views
        • BatchStatistics
        • CustomerProfileDetails
        • CustomerProfiles
        • CustomerProfileTransactionList
        • SettledBatchList
        • TransactionDetailItems
        • TransactionDetails
        • TransactionList
        • UnsettledTransactionList
      • Stored Procedures
        • CaptureTransaction
        • ChargeCreditCard
      • System Tables
        • sys_catalogs
        • sys_schemas
        • sys_tables
        • sys_tablecolumns
        • sys_procedures
        • sys_procedureparameters
        • sys_keycolumns
        • sys_foreignkeys
        • sys_primarykeys
        • sys_indexes
        • sys_connection_props
        • sys_sqlinfo
        • sys_identity
        • sys_information
    • Connection String Options
      • Authentication
        • LoginID
        • TransactionKey
        • UseSandbox
      • SSL
        • SSLServerCert
      • Logging
        • Verbosity
      • Schema
        • BrowsableSchemas
      • Miscellaneous
        • MaxRows
        • PseudoColumns
        • ThrowsKeyNotFound
        • Timeout
    • Third Party Copyrights

Authorize.net - CData Cloud

Overview

CData Cloud offers access to Authorize.net across several standard services and protocols, in a cloud-hosted solution. Any application that can connect to a SQL Server database can connect to Authorize.net through CData Cloud.

CData Cloud allows you to standardize and configure connections to Authorize.net as though it were any other OData endpoint or standard SQL Server.

Key Features

  • Full SQL Support: Authorize.net appears as standard relational databases, allowing you to perform operations - Filter, Group, Join, etc. - using standard SQL, regardless of whether these operations are supported by the underlying API.
  • CRUD Support: Both read and write operations are supported, restricted only by security settings that you can configure in Cloud or downstream in the source itself.
  • Secure Access: The administrator can create users and define their access to specific databases and read-only operations or grant full read & write privileges.
  • Comprehensive Data Model & Dynamic Discovery: CData Cloud provides comprehensive access to all of the data exposed in the underlying data source, including full access to dynamic data and easily searchable metadata.

CData Cloud

Getting Started

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

Connecting to Authorize.net

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

Accessing Data from CData Cloud Services

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

CData Cloud

Establishing a Connection

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

Connecting to Authorize.net

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

Now set the following to connect:

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

CData Cloud

SSL Configuration

Customizing the SSL Configuration

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

To specify another certificate, see the SSLServerCert connection property.

CData Cloud

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 Cloud uses when authenticating to the proxy server.
  • ProxyUser: the username of a user account registered with the proxy server.
  • ProxyPassword: the password associated with the ProxyUser.

Other Proxies

Set the following properties:

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

CData Cloud

Data Model

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

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

CData Cloud

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.

CData Cloud - Authorize.net Views

Name Description
BatchStatistics Query BatchStatistics for an Authorize.net merchant account.
CustomerProfileDetails Query Customer Profile Details for Authorize.net merchant account.
CustomerProfiles Query Customer Profile IDs for Authorize.net merchant account.
CustomerProfileTransactionList Query Transactions in a batch for an Authorize.net merchant account.
SettledBatchList Query settled batches for an Authorize.net merchant account.
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.

CData Cloud

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.

CData Cloud

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.

CData Cloud

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.

CData Cloud

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.

CData Cloud

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.

CData Cloud

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.

CData Cloud

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.

CData Cloud

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.

CData Cloud

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.

CData Cloud

Stored Procedures

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

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

CData Cloud - Authorize.net Stored Procedures

Name Description
CaptureTransaction Use this procedure to capture funds for a transaction that was previously authorized using the ChargeCreditCard stored procedure.
ChargeCreditCard Use this method to authorize and capture a credit card payment.

CData Cloud

CaptureTransaction

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

You must specify values for the TransId and Amount fields.

Input

Name Type Required Description
TransId String True The unique transaction Id.
Amount String True Amount of the transaction. This is the total amount and must include tax, shipping, and any other charges. The amount can either be hard coded or posted to a script.
InvoiceNumber String False Merchant-defined invoice number associated with the order.
Orderdescription String False Description of the item purchased.

Result Set Columns

Name Type Description
ResponseCode String Overall status of the transaction.Possible values are : 1 = Approved ,2 = Declined ,3 = Error ,4 = Held for Review
AvsResultCode String Address Verification Service (AVS) response code. Indicates the result of the AVS filter.
TransId String The payment gateway assigned identification number for transaction. The transId value must be used for any follow-on transactions such as a credit, prior authorization and capture, or void.
RefTransID String The transaction ID of a related, previously settled transaction.
Code String Response code that represents the status.
Description String Text description of the status.

CData Cloud

ChargeCreditCard

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

Note: This procedure makes use of indexed parameters. Indexed parameters facilitate providing multiple instances a single parameter as inputs for the procedure.

Suppose there is an input parameter named Param#. To input multiple instances of an indexed parameter like this, execute:

EXEC ProcedureName Param#1 = "value1", Param#2 = "value2", Param#3 = "value3"

In the Input table below, indexed parameters are denoted with a '#' character at the end of their names.

Input

Name Type Required Description
TransId String True The unique transaction Id.
Amount String True Amount of the transaction. This is the total amount and must include tax, shipping, and any other charges. The amount can either be hard coded or posted to a script.
CardNumber String True The customer's credit card number. Optional for Card Present.
ExpirationMonth String True The customer's credit card expiration month.
ExpirationYear String True The customer's credit card expiration year.
CardCode String True The customer's card code. The three- or four-digit number on the back of a credit card (on the front for American Express).
InvoiceNumber String False Merchant-defined invoice number associated with the order.
TransactionDescription String False Description of the item purchased.
ItemId# String False Item identification.
Name# String False Name of the item.
Description# String False Description of the item.
Quantity# String False Quantity purchased.
UnitPrice# String False Price of one item. Price of an item per unit, excluding tax, freight, and duty.
CustomerId String False Merchant assigned customer ID. Unique identifier to represent the customer associated with the transaction.
ShippingAddress String False Customer's shipping address.
ShippingFirstName String False First name associated with customer's shipping address.
ShippingLastName String False Last name associated with customer's shipping address.
ShippingState String False State of customer's shipping address.
ShippingZip String False ZIP code of customer's shipping address.
ShippingCountry String False Country of customer's shipping address.
ShippingCity String False City of customer's shipping address.
CustomerAddress String False Customer's billing address. Required if merchant would like to use the Address Verification Service security feature. Required when using GPN Canada or Worldpay Streamline Processing Platform.
CustomerFirstName String False First name associated with customer's billing address. Required only when using a European Payment Processor.
CustomerLastName String False Last name associated with customer's billing address. Required only when using a European Payment Processor.
CustomerState String False State of customer's billing address. Required only when using a European Payment Processor.
CustomerZip String False ZIP code of customer's billing address. Required if merchant would like to use the Address Verification Service security feature. Required when using GPN Canada or Worldpay Streamline Processing Platform.
CustomerCountry String False Country of customer's billing address. Required only when using a European Payment Processor.
CustomerCity String False City of customer's billing address. Required only when using a European Payment Processor.

Result Set Columns

Name Type Description
ResponseCode String Overall status of the transaction.Possible values are : 1 = Approved ,2 = Declined ,3 = Error ,4 = Held for Review
Code String Response code that represents the status.
Description String Text description of the status.
TransId String The payment gateway assigned identification number for transaction. The transId value must be used for any follow-on transactions such as a credit, prior authorization and capture, or void.
AvsResultCode String Address Verification Service (AVS) response code. Indicates the result of the AVS filter.

CData Cloud

System Tables

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

Schema Tables

The following tables return database metadata for Authorize.net:

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

Data Source Tables

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

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

Query Information Tables

The following table returns query statistics for data modification queries:

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

CData Cloud

sys_catalogs

Lists the available databases.

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

SELECT * FROM sys_catalogs

Columns

Name Type Description
CatalogName String The database name.

CData Cloud

sys_schemas

Lists the available schemas.

The following query retrieves all available schemas:

          SELECT * FROM sys_schemas
          

Columns

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

CData Cloud

sys_tables

Lists the available tables.

The following query retrieves the available tables and views:

          SELECT * FROM sys_tables
          

Columns

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

CData Cloud

sys_tablecolumns

Describes the columns of the available tables and views.

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

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

Columns

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

CData Cloud

sys_procedures

Lists the available stored procedures.

The following query retrieves the available stored procedures:

          SELECT * FROM sys_procedures
          

Columns

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

CData Cloud

sys_procedureparameters

Describes stored procedure parameters.

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

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

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

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

Columns

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

Pseudo-Columns

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

CData Cloud

sys_keycolumns

Describes the primary and foreign keys.

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

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

Columns

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

CData Cloud

sys_foreignkeys

Describes the foreign keys.

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

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
          

Columns

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

CData Cloud

sys_primarykeys

Describes the primary keys.

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

         SELECT * FROM sys_primarykeys
          

Columns

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

CData Cloud

sys_indexes

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

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

          SELECT * FROM sys_indexes WHERE IsPrimary='false'
          

Columns

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

CData Cloud

sys_connection_props

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

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

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

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

CData Cloud

sys_sqlinfo

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

See SQL Compliance for SQL syntax details.

Discovering the Data Source's SELECT Capabilities

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

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

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

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns

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

CData Cloud

sys_identity

Returns information about attempted modifications.

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

         SELECT * FROM sys_identity
          

Columns

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

CData Cloud

sys_information

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information

Columns

NameTypeDescription
ProductStringThe name of the product.
VersionStringThe version number of the product.
DatasourceStringThe name of the datasource the product connects to.
NodeIdStringThe unique identifier of the machine where the product is installed.
HelpURLStringThe URL to the product's help documentation.
LicenseStringThe license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.)
LocationStringThe file path location where the product's library is stored.
EnvironmentStringThe version of the environment or rumtine the product is currently running under.
DataSyncVersionStringThe tier of CData Sync required to use this connector.
DataSyncCategoryStringThe category of CData Sync functionality (e.g., Source, Destination).

CData Cloud

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.

Logging


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

Schema


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

Miscellaneous


PropertyDescription
MaxRowsSpecifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
ThrowsKeyNotFoundSpecifies whether or not throws an exception if there is no rows updated.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
CData Cloud

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.
CData Cloud

LoginID

The Authorize.net Login Id.

Data Type

string

Default Value

""

Remarks

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

CData Cloud

TransactionKey

The Authorize.net transaction key.

Data Type

string

Default Value

""

Remarks

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

CData Cloud

UseSandbox

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

Data Type

bool

Default Value

false

Remarks

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

CData Cloud

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.
CData Cloud

SSLServerCert

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

Data Type

string

Default Value

""

Remarks

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

This property can take the following forms:

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

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

CData Cloud

Logging

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


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

Verbosity

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

Data Type

string

Default Value

"1"

Remarks

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

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

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

CData Cloud

Schema

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


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

BrowsableSchemas

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

Data Type

string

Default Value

""

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.

CData Cloud

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 number of rows returned for queries that do not include either aggregation or GROUP BY.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
ThrowsKeyNotFoundSpecifies whether or not throws an exception if there is no rows updated.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
CData Cloud

MaxRows

Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.

Data Type

int

Default Value

-1

Remarks

The default value for this property, -1, means that no row limit is enforced unless the query explicitly includes a LIMIT clause. (When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting.)

Setting MaxRows to a whole number greater than 0 ensures that queries do not return excessively large result sets by default.

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

CData Cloud

PseudoColumns

Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.

Data Type

string

Default Value

""

Remarks

This property allows you to define which pseudocolumns the Cloud 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:

*=*

CData Cloud

ThrowsKeyNotFound

Specifies whether or not throws an exception if there is no rows updated.

Data Type

bool

Default Value

false

Remarks

Specifies whether or not throws an exception if there is no rows updated.

CData Cloud

Timeout

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.

Data Type

int

Default Value

60

Remarks

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.

Timeout is set to 60 seconds by default. To disable timeouts, set this property to 0.

Disabling the timeout allows 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.

Note: Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

CData Cloud

Third Party Copyrights

LZMA from 7Zip LZMA SDK

LZMA SDK is placed in the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

LZMA2 from XZ SDK

Version 1.9 and older are in the public domain.

Xamarin.Forms

Xamarin SDK

The MIT License (MIT)

Copyright (c) .NET Foundation Contributors

All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

NSIS 3.10

Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.

1. DEFINITIONS

"Contribution" means:

a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:

i) changes to the Program, and

ii) additions to the Program;

where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.

"Contributor" means any person or entity that distributes the Program.

"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.

"Program" means the Contributions distributed in accordance with this Agreement.

"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.

2. GRANT OF RIGHTS

a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.

b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.

c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.

d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.

3. REQUIREMENTS

A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:

a) it complies with the terms and conditions of this Agreement; and

b) its license agreement:

i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;

ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;

iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and

iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.

When the Program is made available in source code form:

a) it must be made available under this Agreement; and

b) a copy of this Agreement must be included with each copy of the Program.

Contributors may not remove or alter any copyright notices contained within the Program.

Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.

4. COMMERCIAL DISTRIBUTION

Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.

For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.

5. NO WARRANTY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.

6. DISCLAIMER OF LIABILITY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. GENERAL

If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.

If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.

All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.

Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.

This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.

Copyright (c) 2026 CData Software, Inc. - All rights reserved.
Build 25.0.9539