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

getBatchUploadStatus

createBatchUpload

Examples

PHP

    <?php
    // for directions on how to set up the  
    // WSDL link and create "$token" and "$client,"
    // see: [https://help.usaepay.info/developer/soap-api/howto/php/](https://help.usaepay.info/developer/soap-api/howto/php/)

      $BatchUploadStatus = $client->getBatchUploadStatus($this->token, $UploadRefNum);
      echo $BatchUploadStatus->Status;
    ?>

.NET VB

    Dim res As usaepay.BatchUploadStatus = New usaepay.BatchUploadStatus
            res = client.getBatchUploadStatus(token, uploadrefnum)
            MsgBox(res.Status)

.NET C

    try
                {
                    res = client.getBatchUploadStatus(token, uploadrefnum);
                    MessageBox.Show(string.Concat(res.Status));
                }
    ```


### XML

```xml
    <getBatchUploadStatusReturn xsi:type="ns1:BatchUploadStatus">
    <Approved xsi:type="xsd:integer">0</Approved>
    <UploadRefNum xsi:type="xsd:string">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>

Change Log

Version	Change
1.7	Changed UploadRefNum to type string
1.2	Renamed BatchNum parameter to UploadRefNum
1.1	Soap 1.1 Release