developer:soap-1.6:objects:batchstatus

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

developer:soap-1.6:objects:batchstatus [2012/08/04 11:34] (current)
tem created
Line 1: Line 1:
 +<embed ..:​contents/>​====== 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 [[..:​methods:​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 (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|
 +
 +===== Places Used =====
 +
 +[[..:​methods:​getBatchStatus]] ​
 +
 +===== Examples =====
 +
 +
 +==== PHP ====
 +
 +<code php>
 +<?​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;​
 +?> 
 +</​code> ​
 +
 +==== .NET VB ====
 +<code vb>
 +Dim result as usaepay.BatchStatus = New usaepay.BatchStatus
 + 
 +        result = client.getBatchStatus(token,​ BatchRefNum)
 +        MsgBox(result.Status)
 +</​code>​
 +
 +==== .NET C# ====
 +<code c>
 +usaepay.BatchStatus result = new usaepay.BatchStatus();​
 + 
 +            try
 +            {
 +                result = client.getBatchStatus(token,​ BatchRefNum);​
 + 
 +                MessageBox.Show(string.Concat(result.Status));​
 + 
 +            }
 +
 +</​code>​
 +
 +==== XML ====
 +
 +<code xml> ​       ​
 +<​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>​
 +</​code>​
 +
 +===== Change History =====
 +
 +^Version ^Change ^
 +|[[developer:​soap-1.2:​objects:​BatchStatus|1.2]] | Renamed BatchNum Parameter to BatchRefNum |
  
developer/soap-1.6/objects/batchstatus.txt ยท Last modified: 2012/08/04 11:34 by tem

Page Tools