developer:soap-1.6:objects:batchuploadstatus

Differences

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

Link to this comparison view

developer:soap-1.6:objects:batchuploadstatus [2012/08/04 11:35] (current)
tem created
Line 1: Line 1:
 +<embed ..:​contents/>​
 +
 +====== BatchUploadStatus ======
 +
 +Contains information on an uploaded batch.
 +
 +===== Description =====
 +
 +This object contains details on an uploaded batch and describes the status of a batch of transactions that has been uploaded for authorization.
 +
 +===== Properties =====
 +
 +^Type    ^Name     ​^Description ​   ^
 +|Integer |UploadRefNum |Upload reference number (assigned by the gateway).|
 +|String |Status |Current status of the upload batch.|
 +|String |Started |Date and time the batch upload was initiated.|
 +|String |Finished |Date and time the batch upload was completed.|
 +|Integer |Transactions |Total number of transactions in the upload batch.|
 +|Integer |Remaining |Number transactions remaining to be run.|
 +|Integer |Approved |Number of transactions that have been approved.|
 +|Integer |Declined |Number of transactions that have been declined.|
 +|Integer |Errors |Number of transactions that resulted in errors.|
 +
 +
 +===== Places Used =====
 +
 +[[..:​methods:​getBatchUploadStatus]]
 +
 +[[..:​methods:​createBatchUpload]] ​
 +
 +===== 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
 +
 +  $BatchUploadStatus = $client->​getBatchUploadStatus($this->​token,​ $UploadRefNum); ​
 +  echo $BatchUploadStatus->​Status;​
 +?> 
 +</​code> ​
 +
 +==== .NET VB ====
 +<code vb>
 +Dim res As usaepay.BatchUploadStatus = New usaepay.BatchUploadStatus
 +        res = client.getBatchUploadStatus(token,​ uploadrefnum)
 +        MsgBox(res.Status)
 +</​code>​
 +
 +==== .NET C# ====
 +<code c>
 +try
 +            {
 +                res = client.getBatchUploadStatus(token,​ uploadrefnum);​
 +                MessageBox.Show(string.Concat(res.Status));​
 +            }
 +
 +</​code>​
 +
 +==== XML ====
 +
 +<code xml> ​       ​
 +<​getBatchUploadStatusReturn xsi:​type="​ns1:​BatchUploadStatus">​
 +<​Approved xsi:​type="​xsd:​integer">​0</​Approved>​
 +<​UploadRefNum xsi:​type="​xsd:​integer">​440</​UploadRefNum>​
 +<​Declined xsi:​type="​xsd:​integer">​0</​Declined>​
 +<Errors xsi:​type="​xsd:​integer">​0</​Errors>​
 +<​Finished xsi:​type="​xsd:​string"></​Finished>​
 +<​Remaining xsi:​type="​xsd:​integer">​102</​Remaining>​
 +<Started xsi:​type="​xsd:​string">​2008-03-19 09:​55:​19</​Started>​
 +<Status xsi:​type="​xsd:​string">​Paused</​Status>​
 +<​Transactions xsi:​type="​xsd:​integer">​102</​Transactions>​
 +</​getBatchUploadStatusReturn>​
 +</​code>​
 +
 +
 +===== Change History =====
 +
 +^Version ^Change ^
 +|[[developer:​soap-1.2:​objects:​batchuploadstatus|1.2]]| Renamed BatchNum parameter to UploadRefNum |
 +|[[developer:​soap-1.1:​objects:​batchuploadstatus|1.1]] | Soap 1.1 Release |
  
developer/soap-1.6/objects/batchuploadstatus.txt ยท Last modified: 2012/08/04 11:35 by tem

Page Tools