Contains information about a batch awaiting settlement.
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.
Type | Name | Description |
---|---|---|
Integer | BatchRefNum | Batch reference number (assigned by the gateway). |
Integer | Sequence | Batch sequence number |
String | Status | Status of this batch (ie: open, closing, closed) |
String | Opened | Date/time the batch was opened (first transaction was run) |
String | Closed | Date/time the batch was closed (if it has been closed) |
String | Scheduled | Date/time the batch is scheduled to close |
Integer | TransactionCount | Number of transactions in the batch |
Integer | SalesCount | Number of sales in the batch |
Integer | CreditsCount | Number of credits in the batch |
Integer | VoidsCount | Number of voids in the batch |
Double | SalesAmount | Dollar amount of the sales |
Double | CreditsAmount | Dollar amount of the credits |
Double | NetAmount | Dollar amount of the sales-credits |
Double | VoidsAmount | Dollar amount of the voids |
<?php // for directions on how to set up the // WSDL link and create "$token" and "$client," // see: http://wiki.usaepay.com/developer/soap/howto/php $BatchStatus=$this->client->getBatchStatus($this->token, $BatchRefNum); echo $BatchStatus->Status; ?>
<getBatchStatusReturn xsi:type="ns1:BatchStatus"> <BatchRefNum xsi:type="xsd:integer">1936</BatchRefNum> <Closed xsi:type="xsd:string"></Closed> <CreditsAmount xsi:type="xsd:double">0</CreditsAmount> <CreditsCount xsi:type="xsd:integer">0</CreditsCount> <NetAmount xsi:type="xsd:double">245</NetAmount> <Opened xsi:type="xsd:string">04/30/2008T11:26:15</Opened> <SalesAmount xsi:type="xsd:double">245</SalesAmount> <SalesCount xsi:type="xsd:integer">20</SalesCount> <Scheduled xsi:type="xsd:string"></Scheduled> <Sequence xsi:type="xsd:integer">1</Sequence> <Status xsi:type="xsd:string">Open</Status> <TransactionCount xsi:type="xsd:integer">20</TransactionCount> <VoidsAmount xsi:type="xsd:double">0</VoidsAmount> <VoidsCount xsi:type="xsd:integer">0</VoidsCount> </getBatchStatusReturn>
Version | Change |
---|---|
1.2 | Renamed BatchNum Parameter to BatchRefNum |