Authorize.Net Data Model

Authorize.net is a service provider for payment gateways that enables merchants to accept credit card and electronic check payments through their website and via an Internet Protocol connection.

Authorize.net 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.

BatchStatistics

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

Columns

Name	Type	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.

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

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

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.

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

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

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

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

SELECT * FROM UnsettledTransactionList

Columns

Name	Type	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.

If you have any feedback on Gathr documentation, please email us!

Authorize.Net Data Model

Authorize.net Views #

BatchStatistics #

CustomerProfileDetails #

CustomerProfiles #

CustomerProfileTransactionList #

SettledBatchList #

TransactionDetailItems #

TransactionDetails #

TransactionList #

UnsettledTransactionList #

Authorize.net Views

BatchStatistics

CustomerProfileDetails

CustomerProfiles

CustomerProfileTransactionList

SettledBatchList

TransactionDetailItems

TransactionDetails

TransactionList

UnsettledTransactionList