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
string	BatchKey	Batch reference number (assigned by the gateway).
string	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

getBatchStatus

Examples

PHP

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

       $BatchStatus=$this->client->getBatchStatus($this->token, $BatchRefNum);

       echo $BatchStatus->Status;
    ?>

.NET VB

    Dim result as newtek.BatchStatus = New newtek.BatchStatus

            result = client.getBatchStatus(token, BatchRefNum)
            MsgBox(result.Status)

.NET C

    newtek.BatchStatus result = new newtek.BatchStatus();

                try
                {
                    result = client.getBatchStatus(token, BatchRefNum);

                    MessageBox.Show(string.Concat(result.Status));

                }

XML

    <getBatchStatusReturn xsi:type="ns1:BatchStatus">
    <BatchRefNum xsi:type="xsd:string">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>

Change History

Version	Change
1.7	Added BatchKey type string
Changed BatchRefNum to type string
1.2	Renamed BatchNum Parameter to BatchRefNum