Authorize.net v2 Connection Details¶
Introduction¶
Connector Version
This documentation is based on version 23.0.8858 of the connector.
Get Started¶
Authorize.net Version Support
Latest version of Authorize.net API, consisting of Transaction Reporting and Customer Profiles endpoints.
Establish a Connection¶
Before You Connect¶
You can obtain the necessary connection values by logging into your Merchant account and clicking Account > Settings
.
The LoginID
and TransactionKey
are then displayed in the Security Settings
section.
Connect to Authorize.net¶
Set the following to connect:
LoginID
: Set this to the API login ID associated with your payment gateway account. Note that this value is not the same as the login ID that you use to log in to the Merchant Interface.TransactionKey
: Set this to the transaction key associated with your payment gateway account.UseSandbox
(optional): If you are using a developer test account, set this totrue
. If you are using a production account, leave this property set tofalse
.
Important Notes¶
Configuration Files and Their Paths¶
- All references to adding configuration files and their paths refer to files and locations on the Jitterbit agent where the connector is installed. These paths are to be adjusted as appropriate depending on the agent and the operating system. If multiple agents are used in an agent group, identical files will be required on each agent.
Advanced Features¶
This section details a selection of advanced features of the Authorize.net connector.
User Defined Views
The connector allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.
SSL Configuration
Use SSL Configuration to adjust how connector handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert
property under "Connection String Options" for more information.
Proxy
To configure the connector using private agent proxy settings, select the Use Proxy Settings
checkbox on the connection configuration screen.
Query Processing
The connector offloads as much of the SELECT statement processing as possible to Authorize.net and then processes the rest of the query in memory (client-side).
See Query Processing for more information.
User Defined Views¶
The Jitterbit Connector for Authorize.net allows you to define a virtual table whose contents are decided by a pre-configured query. These are called User Defined Views, which are useful in situations where you cannot directly control the query being issued to the driver, e.g. when using the driver from Jitterbit. The User Defined Views can be used to define predicates that are always applied. If you specify additional predicates in the query to the view, they are combined with the query already defined as part of the view.
There are two ways to create user defined views:
- Create a JSON-formatted configuration file defining the views you want.
- DDL statements.
Define Views Using a Configuration File¶
User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json
. The connector automatically detects the views specified in this file.
You can also have multiple view definitions and control them using the UserDefinedViews
connection property. When you use this property, only the specified views are seen by the connector.
This User Defined View configuration file is formatted as follows:
- Each root element defines the name of a view.
- Each root element contains a child element, called
query
, which contains the custom SQL query for the view.
For example:
{
"MyView": {
"query": "SELECT * FROM SettledBatchList WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
Use the UserDefinedViews
connection property to specify the location of your JSON configuration file. For example:
"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"
Define Views Using DDL Statements¶
The connector is also capable of creating and altering the schema via DDL Statements such as CREATE LOCAL VIEW, ALTER LOCAL VIEW, and DROP LOCAL VIEW.
Create a View¶
To create a new view using DDL statements, provide the view name and query as follows:
CREATE LOCAL VIEW [MyViewName] AS SELECT * FROM Customers LIMIT 20;
If no JSON file exists, the above code creates one. The view is then created in the JSON configuration file and is now discoverable. The JSON file location is specified by the UserDefinedViews
connection property.
Alter a View¶
To alter an existing view, provide the name of an existing view alongside the new query you would like to use instead:
ALTER LOCAL VIEW [MyViewName] AS SELECT * FROM Customers WHERE TimeModified > '3/1/2020';
The view is then updated in the JSON configuration file.
Drop a View¶
To drop an existing view, provide the name of an existing schema alongside the new query you would like to use instead.
DROP LOCAL VIEW [MyViewName]
This removes the view from the JSON configuration file. It can no longer be queried.
Schema for User Defined Views¶
User Defined Views are exposed in the UserViews
schema by default. This is done to avoid the view's name clashing with an actual entity in the data model. You can change the name of the schema used for UserViews by setting the UserViewsSchemaName
property.
Work with User Defined Views¶
For example, a SQL statement with a User Defined View called UserViews.RCustomers
only lists customers in Raleigh:
SELECT * FROM Customers WHERE City = 'Raleigh';
An example of a query to the driver:
SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';
Resulting in the effective query to the source:
SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';
That is a very simple example of a query to a User Defined View that is effectively a combination of the view query and the view definition. It is possible to compose these queries in much more complex patterns. All SQL operations are allowed in both queries and are combined when appropriate.
SSL Configuration¶
Customize the SSL Configuration¶
By default, the connector attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.
To specify another certificate, see the SSLServerCert
property for the available formats to do so.
Data Model¶
The Jitterbit Connector for Authorize.net models the Authorize.net API as relational views, or read-only tables. These are defined in schema files, which are simple, text-based configuration files.
API limitations and requirements are documented in this section; you can use the SupportEnhancedSQL
feature, set by default, to circumvent most of these limitations.
Views¶
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.
Jitterbit Connector for 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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
Stored Procedures¶
Stored procedures are function-like interfaces that extend the functionality of the connector 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.
Jitterbit Connector for 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. |
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 | False | The unique transaction Id. required= |
Amount | String | False | 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. required= |
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. |
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 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. |
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 connector 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.
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. |
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. |
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. |
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. |
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. |
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
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. |
DataTypeName | String | The name of the data type. |
DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
Length | Int32 | The number of characters allowed for character data. The number of digits allowed for numeric data. |
NumericPrecision | Int32 | The maximum precision for numeric data. The column length in characters for character and date-time 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. |
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. |
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. |
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. |
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. |
sys_connection_props¶
Returns information on the available connection properties and those set in the connection string.
When querying this table, the config connection string should be used:
jdbc:cdata:authorizenet:config:
This connection string enables you to query this table without a valid connection.
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. |
sys_sqlinfo¶
Describes the SELECT query processing that the connector can offload to the data source.
Discovering the Data Source's SELECT Capabilities¶
Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.
Name | Description | Possible Values |
---|---|---|
AGGREGATE_FUNCTIONS | Supported aggregation functions. | AVG , COUNT , MAX , MIN , SUM , DISTINCT |
COUNT | Whether COUNT function is supported. | YES , NO |
IDENTIFIER_QUOTE_OPEN_CHAR | The opening character used to escape an identifier. | [ |
IDENTIFIER_QUOTE_CLOSE_CHAR | The closing character used to escape an identifier. | ] |
SUPPORTED_OPERATORS | A list of supported SQL operators. | = , > , < , >= , <= , <> , != , LIKE , NOT LIKE , IN , NOT IN , IS NULL , IS NOT NULL , AND , OR |
GROUP_BY | Whether GROUP BY is supported, and, if so, the degree of support. | NO , NO_RELATION , EQUALS_SELECT , SQL_GB_COLLATE |
STRING_FUNCTIONS | Supported string functions. | LENGTH , CHAR , LOCATE , REPLACE , SUBSTRING , RTRIM , LTRIM , RIGHT , LEFT , UCASE , SPACE , SOUNDEX , LCASE , CONCAT , ASCII , REPEAT , OCTET , BIT , POSITION , INSERT , TRIM , UPPER , REGEXP , LOWER , DIFFERENCE , CHARACTER , SUBSTR , STR , REVERSE , PLAN , UUIDTOSTR , TRANSLATE , TRAILING , TO , STUFF , STRTOUUID , STRING , SPLIT , SORTKEY , SIMILAR , REPLICATE , PATINDEX , LPAD , LEN , LEADING , KEY , INSTR , INSERTSTR , HTML , GRAPHICAL , CONVERT , COLLATION , CHARINDEX , BYTE |
NUMERIC_FUNCTIONS | Supported numeric functions. | ABS , ACOS , ASIN , ATAN , ATAN2 , CEILING , COS , COT , EXP , FLOOR , LOG , MOD , SIGN , SIN , SQRT , TAN , PI , RAND , DEGREES , LOG10 , POWER , RADIANS , ROUND , TRUNCATE |
TIMEDATE_FUNCTIONS | Supported date/time functions. | NOW , CURDATE , DAYOFMONTH , DAYOFWEEK , DAYOFYEAR , MONTH , QUARTER , WEEK , YEAR , CURTIME , HOUR , MINUTE , SECOND , TIMESTAMPADD , TIMESTAMPDIFF , DAYNAME , MONTHNAME , CURRENT_DATE , CURRENT_TIME , CURRENT_TIMESTAMP , EXTRACT |
REPLICATION_SKIP_TABLES | Indicates tables skipped during replication. | |
REPLICATION_TIMECHECK_COLUMNS | A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication. | |
IDENTIFIER_PATTERN | String value indicating what string is valid for an identifier. | |
SUPPORT_TRANSACTION | Indicates if the provider supports transactions such as commit and rollback. | YES , NO |
DIALECT | Indicates the SQL dialect to use. | |
KEY_PROPERTIES | Indicates the properties which identify the uniform database. | |
SUPPORTS_MULTIPLE_SCHEMAS | Indicates if multiple schemas may exist for the provider. | YES , NO |
SUPPORTS_MULTIPLE_CATALOGS | Indicates if multiple catalogs may exist for the provider. | YES , NO |
DATASYNCVERSION | The Data Sync version needed to access this driver. | Standard , Starter , Professional , Enterprise |
DATASYNCCATEGORY | The Data Sync category of this driver. | Source , Destination , Cloud Destination |
SUPPORTSENHANCEDSQL | Whether enhanced SQL functionality beyond what is offered by the API is supported. | TRUE , FALSE |
SUPPORTS_BATCH_OPERATIONS | Whether batch operations are supported. | YES , NO |
SQL_CAP | All supported SQL capabilities for this driver. | SELECT , INSERT , DELETE , UPDATE , TRANSACTIONS , ORDERBY , OAUTH , ASSIGNEDID , LIMIT , LIKE , BULKINSERT , COUNT , BULKDELETE , BULKUPDATE , GROUPBY , HAVING , AGGS , OFFSET , REPLICATE , COUNTDISTINCT , JOINS , DROP , CREATE , DISTINCT , INNERJOINS , SUBQUERIES , ALTER , MULTIPLESCHEMAS , GROUPBYNORELATION , OUTERJOINS , UNIONALL , UNION , UPSERT , GETDELETED , CROSSJOINS , GROUPBYCOLLATE , MULTIPLECATS , FULLOUTERJOIN , MERGE , JSONEXTRACT , BULKUPSERT , SUM , SUBQUERIESFULL , MIN , MAX , JOINSFULL , XMLEXTRACT , AVG , MULTISTATEMENTS , FOREIGNKEYS , CASE , LEFTJOINS , COMMAJOINS , WITH , LITERALS , RENAME , NESTEDTABLES , EXECUTE , BATCH , BASIC , INDEX |
PREFERRED_CACHE_OPTIONS | A string value specifies the preferred cacheOptions. | |
ENABLE_EF_ADVANCED_QUERY | Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side. | YES , NO |
PSEUDO_COLUMNS | A string array indicating the available pseudo columns. | |
MERGE_ALWAYS | If the value is true, The Merge Mode is forcibly executed in Data Sync. | TRUE , FALSE |
REPLICATION_MIN_DATE_QUERY | A select query to return the replicate start datetime. | |
REPLICATION_MIN_FUNCTION | Allows a provider to specify the formula name to use for executing a server side min. | |
REPLICATION_START_DATE | Allows a provider to specify a replicate startdate. | |
REPLICATION_MAX_DATE_QUERY | A select query to return the replicate end datetime. | |
REPLICATION_MAX_FUNCTION | Allows a provider to specify the formula name to use for executing a server side max. | |
IGNORE_INTERVALS_ON_INITIAL_REPLICATE | A list of tables which will skip dividing the replicate into chunks on the initial replicate. | |
CHECKCACHE_USE_PARENTID | Indicates whether the CheckCache statement should be done against the parent key column. | TRUE , FALSE |
CREATE_SCHEMA_PROCEDURES | Indicates stored procedures that can be used for generating schema files. |
The following query retrieves the operators that can be used in the WHERE clause:
SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.
Columns¶
Name | Type | Description |
---|---|---|
NAME | String | A component of SQL syntax, or a capability that can be processed on the server. |
VALUE | String | Detail on the supported SQL or SQL syntax. |
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. |
Advanced Configurations Properties¶
The advanced configurations 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. Click the links for further details.
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 | The certificate to be accepted from the server when connecting using TLS/SSL. |
Property | Description |
---|---|
Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC. |
Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA, TableB, TableC. |
Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC. |
Property | Description |
---|---|
MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
Other | These hidden properties are used only in specific use cases. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
Authentication¶
This section provides a complete list of authentication properties you can configure.
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. |
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.
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.
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'.
SSL¶
This section provides a complete list of SSL properties you can configure.
Property | Description |
---|---|
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
SSLServerCert¶
The certificate to be accepted from the server when connecting using TLS/SSL.
Data Type¶
string
Default Value¶
""
Remarks¶
If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.
This property can take the following forms:
Description | Example |
---|---|
A full PEM Certificate (example shortened for brevity) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
A path to a local file containing the certificate | C:\\cert.cer |
The public key (example shortened for brevity) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
The MD5 Thumbprint (hex values can also be either space or colon separated) | ecadbdda5a1529c58a1e9e09828d70e4 |
The SHA1 Thumbprint (hex values can also be either space or colon separated) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
If not specified, any certificate trusted by the machine is accepted.
Certificates are validated as trusted by the machine based on the System's trust store. The trust store used is the 'javax.net.ssl.trustStore' value specified for the system. If no value is specified for this property, Java's default trust store is used (for example, JAVA_HOME\lib\security\cacerts).
Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.
Schema¶
This section provides a complete list of schema properties you can configure.
Property | Description |
---|---|
Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC. |
Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA, TableB, TableC. |
Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC. |
Location¶
A path to the directory that contains the schema files defining tables, views, and stored procedures.
Data Type¶
string
Default Value¶
%APPDATA%\AuthorizeNet Data Provider\Schema
Remarks¶
The path to a directory which contains the schema files for the connector (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location
property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.
If left unspecified, the default location is "%APPDATA%\AuthorizeNet Data Provider\Schema" with %APPDATA%
being set to the user's configuration directory:
Platform | %APPDATA% |
---|---|
Windows | The value of the APPDATA environment variable |
Mac | ~/Library/Application Support |
Linux | ~/.config |
BrowsableSchemas¶
This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Data Type¶
string
Default Value¶
""
Remarks¶
Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.
Tables¶
This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Data Type¶
string
Default Value¶
""
Remarks¶
Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the connector.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.
Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
Views¶
Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.
Data Type¶
string
Default Value¶
""
Remarks¶
Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the connector.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.
Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
Miscellaneous¶
This section provides a complete list of miscellaneous properties you can configure.
Property | Description |
---|---|
MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
Other | These hidden properties are used only in specific use cases. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
MaxRows¶
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Data Type¶
int
Default Value¶
-1
Remarks¶
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Other¶
These hidden properties are used only in specific use cases.
Data Type¶
string
Default Value¶
""
Remarks¶
The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.
Specify multiple properties in a semicolon-separated list.
Integration and Formatting¶
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 | Determines whether to convert date-time values to GMT, instead of the local time of the machine. |
RecordToFile=filename | Records the underlying socket data transfer to the specified file. |
PseudoColumns¶
This property indicates whether or not to include pseudo columns as columns to the table.
Data Type¶
string
Default Value¶
""
Remarks¶
This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".
Timeout¶
The value in seconds until the timeout error is thrown, canceling the operation.
Data Type¶
int
Default Value¶
60
Remarks¶
If Timeout
= 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.
If Timeout
expires and the operation is not yet complete, the connector throws an exception.
UserDefinedViews¶
A filepath pointing to the JSON configuration file containing your custom views.
Data Type¶
string
Default Value¶
""
Remarks¶
User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json
. The connector automatically detects the views specified in this file.
You can also have multiple view definitions and control them using the UserDefinedViews
connection property. When you use this property, only the specified views are seen by the connector.
This User Defined View configuration file is formatted as follows:
- Each root element defines the name of a view.
- Each root element contains a child element, called
query
, which contains the custom SQL query for the view.
For example:
{
"MyView": {
"query": "SELECT * FROM SettledBatchList WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
Use the UserDefinedViews
connection property to specify the location of your JSON configuration file. For example:
"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json
Note that the specified path is not embedded in quotation marks.