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