BatchStatus
Contains information about a batch awaiting settlement.
Description
This object contains information about a batch of transactions that has been authorized and is awaiting settlement. It is returned when attempting to determine the status of a batch using the GetBatchStatus method.
This should reflect the same information contained in the Batch Manager section of the merchant console.
Properties
| Type | Name | Description |
|---|---|---|
| Integer | BatchRefNum | Batch reference number (BatchId) (assigned by the gateway). (required) |
| Integer | Sequence | Batch sequence number. (required) |
| String | Status | Status of this batch (ie: open, closing, closed). (required) |
| String | Opened | Date/time the batch was opened (first transaction was run). (required) |
| String | Closed | Date/time the batch was closed (if it has been closed). (required) |
| String | Scheduled | Date/time the batch is scheduled to close. (optional) |
| Integer | TransactionCount | Number of transactions in the batch. (required) |
| Integer | SalesCount | Number of sales in the batch. (optional) |
| Integer | CreditsCount | Number of credits in the batch. (optional) |
| Integer | VoidsCount | Number of voids in the batch. (optional) |
| Double | SalesAmount | Dollar amount of the sales. (required) |
| Double | CreditsAmount | Dollar amount of the credits. (optional) |
| Double | NetAmount | Dollar amount of the sales-credits. (required) |
| Double | VoidsAmount | Dollar amount of the voids.(optional) |
Updated over 5 years ago