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.
Latest version of Authorize.net API, consisting of Transaction Reporting and Customer Profiles endpoints.
For required properties, see the Settings tab.
For connection properties that are not typically required, see the Advanced tab.
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:
This section details a selection of advanced features of the Authorize.net Sync App.
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 .
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" .
Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.
For further information, see Query Processing.
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.
To authenticate to an HTTP proxy, set the following:
Set the following properties:
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.
The Sync App uses the Authorize.net API to process supported filters. The Sync App processes other filters client-side within the Sync App.
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.
| Name | Description |
| BatchStatistics | Query BatchStatistics for an Authorize.net merchant account. |
| CustomerProfileDetails | Query Customer Profile Details for Authorize.net merchant account. |
| CustomerProfiles | Query Customer Profile IDs for Authorize.net merchant account. |
| CustomerProfileTransactionList | Query Transactions in a batch for an Authorize.net merchant account. |
| SettledBatchList | Query settled batches for an Authorize.net merchant account. |
| TransactionDetailItems | Query TransactionDetails to retrieve Items for an Authorize.net merchant account. |
| TransactionDetails | Query TransactionDetails for an Authorize.net merchant account. |
| TransactionList | Query Transactions in a batch for an Authorize.net merchant account. |
| UnsettledTransactionList | Query Unsettled Transactions for an Authorize.net merchant account. |
Query BatchStatistics for an Authorize.net merchant account.
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')
| Name | Type | Statistic | Description |
| BatchId [KEY] | String | The unique batch Id. | |
| AccountType [KEY] | String | The card type for this transaction (including eCheck). Valid values are Visa, MasterCard, AmericanExpress, Discover, JCB, DinersClub, and eCheck. Note a batch will contain either credit card or eCheck statistics, because eCheck transactions go in their own batch.
The allowed values are Visa, MasterCard, AmericanExpress, Discover, JCB, DinersClub, eCheck. | |
| SettlementTime | Datetime | Date and time the batch was settled. | |
| SettlementState | String | The status of the batch. Valid values are settledSuccessfully or error.
The allowed values are settledSuccessfully, error. | |
| PaymentMethod | String | The payment method associated with the batch. Valid values are creditCard or eCheck.
The allowed values are creditCard, eCheck. | |
| MarketType | String | The market type associated with the batch. Valid values are 0 (eCommerce), 1 (MOTO), or 2 (Retail). | |
| Product | String | The product associated with the batch. Valid values are Card Not Present or Card Present.
The allowed values are Card Not Present, Card Present. | |
| ReturnedItemAmount | Decimal | The total amount of all returned items. Only applicable for eCheck transactions. | |
| ReturnedItemCount | Integer | The total count of all returned items. Only applicable for eCheck transactions. | |
| ChargeBackAmount | Decimal | The total amount of all charge backs. Only applicable for credit card transactions. | |
| ChargeBackCount | Integer | The total count of all charge backs. Only applicable for credit card transactions. | |
| CorrectionNoticeCount | Integer | The total count of all correction notices. Only applicable for credit card transactions. | |
| ChargeChargeBackAmount | Decimal | Only applicable for credit card transactions. | |
| ChargeChargeBackCount | Integer | Only applicable for credit card transactions. | |
| BatchStatisticsAmount | Decimal | The total amount of all transactions as returned in the response of a getBatchStatistics call. Only applicable for credit card transactions. | |
| BatchStatisticsCount | Integer | The total count of all transactions as returned in the response of a getBatchStatistics call. Only applicable for credit card transactions. | |
| ChargeReturnedItemsAmount | Decimal | The total amount of returned items purchased using credit cards. | |
| ChargeReturnedItemsCount | Integer | The total count of returned items purchased using credit cards. | |
| RefundReturnedItemsAmount | Decimal | The total amount of returned items that have been refunded. | |
| RefundReturnedItemsCount | Integer | The total count of returned items that have been refunded. | |
| ChargeAmount | Decimal | The total amount of all charge (i.e., Sale) transactions. | |
| ChargeCount | Integer | The total count of all charge transactions. | |
| RefundAmount | Decimal | The total amount of all refund transactions. | |
| RefundCount | Integer | The total count of all refund transactions. | |
| VoidCount | Integer | The total count of all voided transactions. | |
| DeclineCount | Integer | The total count of all declined transactions. | |
| ErrorCount | Integer | The total count of all transactions that resulted in an error. |
Query Customer Profile Details for Authorize.net merchant account.
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')
| 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. | |
| String | Email address associated with the customer profile. | ||
| Description | String | Description of the customer or customer profile. Required only when no values for merchantCustomerId and email are submitted. | |
| FirstName | String | First name associated with customer's billing address. | |
| LastName | String | Last name associated with customer's billing address. | |
| Company | String | Company associated with customer's billing address. | |
| Address | String | Customer's billing address. | |
| City | String | City of customer's billing address. | |
| State | String | State of customer's billing address. | |
| Zip | String | The postal code of customer's billing address. | |
| Country | String | Country of customer's billing address. | |
| PhoneNumber | String | Phone number associated with customer's billing address. | |
| FaxNumber | String | Fax number associated with customer's billing address. | |
| DefaultPaymentProfile | Boolean | Indicates whether this profile is the default.If a customer profile does not have a default payment profile, then the defaultPaymentProfile element is not displayed in the getCustomerProfileResponse.If a profile has multiple payment profiles, the default profile returns defaultPaymentProfile set to true. Non-default profiles do not return defaultPaymentProfile. | |
| CustomerPaymentProfileId | String | Payment gateway assigned ID associated with the customer payment profile. | |
| CardNumber | String | The customer's masked credit card number. All sensitive payment information in the output is masked. | |
| ExpirationDate | String | The expiration date for the customer's credit card. | |
| CardType | String | Type of credit card. Possible values: Visa, Mastercard, AmericanExpress, Discover, JCB, or DinersClub. | |
| IssuerNumber | String | Unique identifier (IIN) for the issuer of the card. This element is only returned if you set the includeIssuerInfo field to true in the request. | |
| IsPaymentToken | Boolean | Indicates whether the payment method used an encrypted token. | |
| AccountType | String | The type of bank account used for the eCheck.net transaction. Possible values: checking, savings, or businessChecking. | |
| RoutingNumber | String | The ABA routing number. | |
| AccountNumber | String | The bank account number. | |
| NameOnAccount | String | Name of the person who holds the bank account. | |
| EcheckType | String | The type of eCheck transaction. Do not use TEL, ARC, or BOC for recurring charges. Possible values:PPD, WEB, or CCD. | |
| BankName | String | The name of the bank. |
Query Customer Profile IDs for Authorize.net merchant account.
| Name | Type | Statistic | Description |
| CustomerProfileId | String | The ID number associated with a customer profile. |
Query Transactions in a batch for an Authorize.net merchant account.
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')
| Name | Type | Statistic | Description |
| TransId [KEY] | String | The unique transaction Id. | |
| SubmitTime | Datetime | Date and time the transaction was submitted. | |
| SettlementTimeLocal | Datetime | Date and time the transaction was submitted in local format: YYYY-MM-DDTHH:MM:SS.mmm | |
| TransactionStatus | String | The status of the transaction. | |
| InvoiceNumber | String | The invoice number for the transaction. | |
| FirstName | String | The first name of the customer for the transaction. | |
| LastName | String | The last name of the customer for the transaction. | |
| AccountType | String | The card type for this transaction (including eCheck). Valid values are: Visa, MasterCard, AmericanExpress, Discover, JCB, DinersClub, eCheck.
The allowed values are Visa, MasterCard, AmericanExpress, Discover, JCB, DinersClub, eCheck. | |
| AccountNumber | String | The account number for the transaction. | |
| SettleAmount | Decimal | The amount that was submitted for settlement. | |
| HasReturnedItems | Boolean | Indicates that this transaction contains returned items. | |
| SubscriptionId | String | The subscription Id. | |
| SubscriptionPayNum | Integer | Identifies the number of this transaction, in terms of how many transactions have been submitted for this subscription. | |
| MarketType | String | The market type used to process the transaction. Valid values: 0 (eCommerce), 1 (MOTO), 2 (Retail). | |
| Product | String | The product method used to process the transaction. Valid values: Card Not Present, Card Present.
The allowed values are Card Not Present, Card Present. | |
| MobileDeviceId | String | The unique identifier of the mobile device. | |
| CustomerProfileId | String | The ID number associated with the customer profile. | |
| CustomerPaymentProfileId | String | The ID of the customer payment profile used to charge this transaction. |
Query settled batches for an Authorize.net merchant account.
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'
| 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. |
| Name | Type | Description |
| IncludeStatistics | Boolean | Identifies whether to retrieve the batch statistics in addition to the basic batch details. The default value is false. |
Query TransactionDetails to retrieve Items for an Authorize.net merchant account.
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')
| Name | Type | Statistic | Description |
| TransId [KEY] | String | The unique transaction Id. | |
| ItemId [KEY] | String | The Id assigned to an item. | |
| BatchId | String | The Id of the batch the transaction is in. | |
| SettlementTime | Datetime | Date and time the transaction was settled. | |
| SettlementState | String | Status of the batch. Valid values: settledSuccessfully, settlementError, pendingSettlement. | |
| ResponseCode | Integer | The overall status of the transaction. Valid values: 1 (Approved), 2 (Declined), 3 (Error), 4 (Held for review).
The allowed values are 1, 2, 3, 4. | |
| InvoiceNumber | String | The invoice number for the transaction. | |
| PurchaseOrderNumber | String | The purchase order number for the transaction. | |
| AuthAmount | Decimal | The amount authorized or refunded. | |
| CustomerId | String | The merchant-assigned customer Id. | |
| CustomerEmail | String | The email address of the customer. | |
| ReturnedItemId | String | The transaction ID for returned item. | |
| ReturnedItemDate | Datetime | Date the item was returned. | |
| ReturnedItemCode | String | The ACH return code. | |
| ReturnedItemDescription | String | A text description of the reason for the return. | |
| ItemName | String | The short description of the item. | |
| ItemDescription | String | The detailed description of the item. | |
| ItemQuantity | Double | The number of items sold. | |
| ItemUnitPrice | Decimal | The cost of the item per unit, excluding tax, freight, and duty. | |
| ItemTaxable | Boolean | Indicates whether the item is subject to tax. |
Query TransactionDetails for an Authorize.net merchant account.
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')
| Name | Type | Statistic | Description |
| TransId [KEY] | String | The unique transaction Id. | |
| RefTransId | String | The transaction Id of the original transaction. This only appears for linked credits (transaction type refundTransaction). | |
| SplitTenderId | String | Identifies the split tender order, if applicable. This only appears for transactions that are part of a larger partial authorization order. | |
| SubmitTime | Datetime | Date and time the transaction was submitted. | |
| TransactionType | String | The type of transaction that was originally submitted. Valid values: authCaptureTransaction, authOnlyTransaction, captureOnlyTransaction, refundTransaction.
The allowed values are authCaptureTransaction, authOnlyTransaction, captureOnlyTransaction, refundTransaction. | |
| TransactionStatus | String | The status of the transaction. | |
| ResponseCode | Integer | The overall status of the transaction. Valid values: 1 (Approved), 2 (Declined), 3 (Error), 4 (Held for review).
The allowed values are 1, 2, 3, 4. | |
| ResponseReasonCode | Integer | A code that represents more details about the result of the transaction. | |
| ResponseReasonDescription | String | A brief description of the result, which corresponds with the response reason code. | |
| AuthCode | String | The authorization or approval code. | |
| AVSResponse | String | Response from the AVS security check. Indicates the result of the AVS filter. | |
| CardCodeResponse | String | Response from the card code security check. Indicates the result of the CCV filter. | |
| CAVVResponse | String | The cardholder authentication verification response code. | |
| FDSFilterAction | String | The action taken for a transaction that triggered one or more of the Advanced Fraud Detection Suite filters. Valid values: reject, decline, hold, authAndHold, report. | |
| FDSFiltersName | String | A comma-separated list of fraud filter names. | |
| FDSFiltersAction | String | A comma-separated list of fraud filter settings. | |
| BatchId | String | The Id of the batch the transaction is in. | |
| SettlementTime | Datetime | Date and time the transaction was settled. | |
| SettlementState | String | Status of the batch. Valid values: settledSuccessfully, settlementError, pendingSettlement.
The allowed values are settledSuccessfully, settlementError, pendingSettlement. | |
| InvoiceNumber | String | The invoice number for the transaction. | |
| Description | String | The description of the transaction. | |
| PurchaseOrderNumber | String | The purchase order number for the transaction. | |
| RequestedAmount | Decimal | The amount requested. This will only be present for partial authorization transactions. For other transactions it is not listed because it is always the same as AuthAmount. | |
| AuthAmount | Decimal | The amount authorized or refunded. | |
| SettleAmount | Decimal | The amount that was submitted for settlement. | |
| TaxAmount | Decimal | The amount of the tax. | |
| TaxName | String | The name of the tax. | |
| TaxDescription | String | The description of the tax. | |
| ShippingAmount | Decimal | The amount charged for shipping. | |
| ShippingName | String | The name of the shipping charges. | |
| ShippingDescription | String | The description of the shipping charges. | |
| DutyAmount | Decimal | The amount of the duty. | |
| DutyName | String | The name of the duty. | |
| DutyDescription | String | The description of the duty. | |
| PrepaidBalanceRemaining | Decimal | The amount remaining on the prepaid card at the time of the transaction. | |
| TaxExempt | Boolean | Indicates whether the item is tax exempt. | |
| CardNumber | String | The credit card number. | |
| CardExpirationDate | String | The expiration date. | |
| CardAccountType | String | The type of credit card. Valid values: Visa, MasterCard, AmericanExpress, Discover, JCB, DinersClub.
The allowed values are Visa, MasterCard, AmericanExpress, Discover, JCB, DinersClub. | |
| BankRoutingNumber | String | The routing number of the bank. | |
| BankAccountNumber | String | The masked bank account number. | |
| BankNameOnAccount | String | The name on the bank account. | |
| BankEcheckType | String | The echeck type used for the transaction. Valid values: PPD, WEB, CCD, TEL.
The allowed values are PPD, WEB.CCD.TEL. | |
| CustomerType | String | The customer type. Valid values: individual, business.
The allowed values are individual, business. | |
| CustomerId | String | The merchant-assigned customer Id. | |
| CustomerEmail | String | The email address of the customer. | |
| BillToFirstName | String | The first name associated with the billing address of the customer. | |
| BillToLastName | String | The last name associated with the billing address of the customer. | |
| BillToCompany | String | The company name associated with the billing address of the customer. | |
| BillToAddress | String | The billing address of the customer. | |
| BillToCity | String | The city of the billing address of the customer. | |
| BillToState | String | The state of the billing address of the customer. | |
| BillToZip | String | The ZIP of the billing address of the customer. | |
| BillToCountry | String | The country of the billing address of the customer. | |
| BillToPhoneNumber | String | The phone number for the billing address of the customer. | |
| BillToFaxNumber | String | The fax number for the billing address of the customer. | |
| ShipToFirstName | String | The first name associated with the shipping address of the customer. | |
| ShipToLastName | String | The last name associated with the shipping address of the customer. | |
| ShipToCompany | String | The company name associated with the shipping address of the customer. | |
| ShipToAddress | String | The shipping address of the customer. | |
| ShipToCity | String | The city of the shipping address of the customer. | |
| ShipToState | String | The state of the shipping address of the customer. | |
| ShipToZip | String | The ZIP of the shipping address of the customer. | |
| ShipToCountry | String | The country of the shipping address of the customer. | |
| SubscriptionId | String | The subscription Id. | |
| SubscriptionPayNum | Integer | Identifies the number of this transaction, in terms of how many transactions have been submitted for this subscription. | |
| SolutionId | String | The solution Id generated by Authorize.net and provided to the solution provider. | |
| SolutionName | String | The name generated by the solution provider and provided to Authorize.net. | |
| CustomerIP | String | The IP address for the customer. | |
| MobileDeviceId | String | The unique identifier of the mobile device. | |
| MarketType | String | The market type used to process the transaction. Valid values: 0 (eCommerce), 1 (MOTO), 2 (Retail). | |
| Product | String | The product method used to process the transaction. Valid values: Card Not Present, Card Present.
The allowed values are Card Not Present, Card Present. |
Query Transactions in a batch for an Authorize.net merchant account.
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')
| Name | Type | Statistic | Description |
| TransId [KEY] | String | The unique transaction Id. | |
| BatchId | String | The unique batch Id. | |
| SubmitTime | Datetime | Date and time the transaction was submitted. | |
| SettlementTimeLocal | Datetime | Date and time the transaction was submitted in local format: YYYY-MM-DDTHH:MM:SS.mmm | |
| TransactionStatus | String | The status of the transaction. | |
| InvoiceNumber | String | The invoice number for the transaction. | |
| FirstName | String | The first name of the customer for the transaction. | |
| LastName | String | The last name of the customer for the transaction. | |
| AccountType | String | The card type for this transaction (including eCheck). Valid values are: Visa, MasterCard, AmericanExpress, Discover, JCB, DinersClub, eCheck.
The allowed values are Visa, MasterCard, AmericanExpress, Discover, JCB, DinersClub, eCheck. | |
| AccountNumber | String | The account number for the transaction. | |
| SettleAmount | Decimal | The amount that was submitted for settlement. | |
| HasReturnedItems | Boolean | Indicates that this transaction contains returned items. | |
| SubscriptionId | String | The subscription Id. | |
| SubscriptionPayNum | Integer | Identifies the number of this transaction, in terms of how many transactions have been submitted for this subscription. | |
| MarketType | String | The market type used to process the transaction. Valid values: 0 (eCommerce), 1 (MOTO), 2 (Retail). | |
| Product | String | The product method used to process the transaction. Valid values: Card Not Present, Card Present.
The allowed values are Card Not Present, Card Present. | |
| MobileDeviceId | String | The unique identifier of the mobile device. |
Query Unsettled Transactions for an Authorize.net merchant account.
This table does not support any columns in the WHERE clause.
SELECT * FROM UnsettledTransactionList
| 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. |
Stored procedures are function-like interfaces that extend the functionality of the Sync App 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.
| 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. |
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.
| 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. |
| Name | Type | Description |
| ResponseCode | String | Overall status of the transaction.Possible values are : 1 = Approved ,2 = Declined ,3 = Error ,4 = Held for Review |
| AvsResultCode | String | Address Verification Service (AVS) response code. Indicates the result of the AVS filter. |
| TransId | String | The payment gateway assigned identification number for transaction. The transId value must be used for any follow-on transactions such as a credit, prior authorization and capture, or void. |
| RefTransID | String | The transaction ID of a related, previously settled transaction. |
| Code | String | Response code that represents the status. |
| Description | String | Text description of the status. |
Use this method to authorize and capture a credit card payment.
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.
| 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. |
| 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. |
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.
| Property | Description |
| LoginID | The Authorize.net Login Id. |
| TransactionKey | The Authorize.net transaction key. |
| UseSandbox | A boolean indicating if you are using a Sandbox account. The provider makes requests to the production environment by default. |
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
| 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. |
| FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
| FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
| FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
| Property | Description |
| ProxyAutoDetect | Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server. |
| ProxyServer | Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic. |
| ProxyPort | Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client. |
| ProxyAuthScheme | Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | Specifies the password of the user specified in the ProxyUser connection property. |
| ProxySSLType | Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
| Property | Description |
| 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. |
| Property | Description |
| 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. |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Tables | Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC . |
| Views | Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC . |
| Property | Description |
| MaxRows | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| Other | Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file. |
This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.
| Property | Description |
| LoginID | The Authorize.net Login Id. |
| TransactionKey | The Authorize.net transaction key. |
| UseSandbox | A boolean indicating if you are using a Sandbox account. The provider makes requests to the production environment by default. |
The Authorize.net Login Id.
The API login Id associated with your payment gateway account. This property is found in the Security Settings under Account -> Settings and is used to authenticate that you are authorized to submit website transactions. Note that this value is not the same as the login Id that you use to log in to the Merchant Interface.
The Authorize.net transaction key.
The transaction key associated with your payment gateway account. This property is found in the Security Settings under Account -> Settings and is used to authenticate that you are authorized to submit website transactions.
A boolean indicating if you are using a Sandbox account. The provider makes requests to the production environment by default.
The Authorize.net API to be used to process transactions. If you are using a production account, this property can be left blank. If you are using a developer test account, set this to 'TRUE'.
This section provides a complete list of the SSL properties you can configure in the connection string for this provider.
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
Specifies the certificate to be accepted from the server when connecting using TLS/SSL.
If you are using a TLS/SSL connection, use this property to specify the TLS/SSL certificate to be accepted from the server. If you specify a value for this property, all other certificates that are not trusted by the machine are rejected.
This property can take the following forms:
| Description | Example |
| A full PEM Certificate (example shortened for brevity) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
| A path to a local file containing the certificate | C:\cert.cer |
| The public key (example shortened for brevity) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
| The MD5 Thumbprint (hex values can also be either space- or colon-separated) | ecadbdda5a1529c58a1e9e09828d70e4 |
| The SHA1 Thumbprint (hex values can also be either space- or colon-separated) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
Note: It is possible to use '*' to signify that all certificates should be accepted, but due to security concerns this is not recommended.
This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.
| Property | Description |
| FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
| 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. |
| FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
| FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
| FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
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.
Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
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.
Specifies the TCP port to be used for a proxy-based firewall.
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.
Identifies the user ID of the account authenticating to a proxy-based firewall.
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.
Specifies the password of the user account authenticating to a proxy-based firewall.
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.
This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.
| Property | Description |
| ProxyAutoDetect | Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server. |
| ProxyServer | Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic. |
| ProxyPort | Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client. |
| ProxyAuthScheme | Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | Specifies the password of the user specified in the ProxyUser connection property. |
| ProxySSLType | Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
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. If you want to configure the Sync App to connect to a specific proxy server, set ProxyAutoDetect to False.
To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.
Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic.
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 (the default), the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.
Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client.
The Sync App only routes HTTP traffic through the ProxyServer port specified in this connection property when ProxyAutoDetect is set to False.
If ProxyAutoDetect is set to True (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.
Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
Supported authentication types :
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.
Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property.
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 username of a user registered with the proxy server. |
| DIGEST | The username 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. |
Note: The Sync App only uses this username if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True (the default), the Sync App instead uses the username specified in your system proxy settings.
Specifies the password of the user specified in the ProxyUser connection property.
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.
Note: The Sync App only uses this password if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True (the default), the Sync App instead uses the password specified in your system proxy settings.
Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
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 :
| AUTO | Default 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. |
| ALWAYS | The connection is always SSL enabled. |
| NEVER | The connection is not SSL enabled. |
| TUNNEL | The 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. |
Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.
The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.
Note: 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.
This section provides a complete list of the Logging properties you can configure in the connection string for this provider.
| Property | Description |
| 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. |
Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.
The Sync App writes details about each operation it performs into the logfile specified by the Logfile connection property.
Each of these logged operations are assigned to a themed category called a module, and each module has a corresponding short code used to labels individual Sync App operations as belonging to that module.
When this connection property is set to a semicolon-separated list of module codes, only operations belonging to the specified modules are written to the logfile. Note that this only affects which operations are logged moving forward and doesn't retroactively alter the existing contents of the logfile. For example: INFO;EXEC;SSL;META;
By default, logged operations from all modules are included.
You can explicitly exclude a module by prefixing it with a "-". For example: -HTTP
To apply filters to submodules, identify them with the syntax <module name>.<submodule name>. For example, the following value causes the Sync App to only log actions belonging to the HTTP module, and further refines it to exclude actions belonging to the Res submodule of the HTTP module: HTTP;-HTTP.Res
Note that the logfile filtering triggered by the Verbosity connection property takes precedence over the filtering imposed by this connection property. This means that operations of a higher verbosity level than the level specified in the Verbosity connection property are not printed in the logfile, even if they belong to one of the modules specified in this connection property.
The available modules and submodules are:
| Module Name | Module Description | Submodules |
| INFO | General Information. Includes the connection string, product version (build number), and initial connection messages. |
|
| EXEC | Query Execution. Includes execution messages for user-written SQL queries, parsed SQL queries, and normalized SQL queries. Success/failure messages for queries and query pages appear here as well. |
|
| HTTP | HTTP protocol messages. Includes HTTP requests/responses (including POST messages), as well as Kerberos related messages. |
|
| WSDL | Messages pertaining to the generation of WSDL/XSD files. | — |
| SSL | SSL certificate messages. |
|
| AUTH | Authentication related failure/success messages. |
|
| SQL | Includes SQL transactions, SQL bulk transfer messages, and SQL result set messages. |
|
| META | Metadata cache and schema messages. |
|
| FUNC | Information related to executing SQL functions. |
|
| TCP | Incoming and outgoing raw bytes on TCP transport layer messages. |
|
| FTP | Messages pertaining to the File Transfer Protocol. |
|
| SFTP | Messages pertaining to the Secure File Transfer Protocol. |
|
| POP | Messages pertaining to data transferred via the Post Office Protocol. |
|
| SMTP | Messages pertaining to data transferred via the Simple Mail Transfer Protocol. |
|
| CORE | Messages relating to various internal product operations not covered by other modules. | — |
| DEMN | Messages related to SQL remoting. | — |
| CLJB | Messages about bulk data uploads (cloud job). |
|
| SRCE | Miscellaneous messages produced by the product that don't belong in any other module. | — |
| TRANCE | Advanced messages concerning low-level product operations. | — |
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
| Property | Description |
| 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. |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Tables | Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC . |
| Views | Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC . |
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.
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 |
Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
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.
Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
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.
Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .
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.
This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.
| Property | Description |
| MaxRows | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| Other | Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file. |
Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
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.
Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.
This property allows advanced users to configure hidden properties for specialized situations, with the advice of our Support team. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. To define multiple properties, use 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.
| Property | Description |
| DefaultColumnSize | Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000. |
| ConvertDateTimeToGMT=True | Converts date-time values to GMT, instead of the local time of the machine. The default value is False (use local time). |
| RecordToFile=filename | Records the underlying socket data transfer to the specified file. |
Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
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:
*=*
Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
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.
Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.
UserDefinedViews 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 use this property to define multiple views in a single file and specify the filepath.
For example:
UserDefinedViews=C:\Path\To\UserDefinedViews.jsonWhen you specify a view in UserDefinedViews, the Sync App only sees that view.
For further information, see User Defined Views.
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.