Currently set to Index
Currently set to Follow
  1. Home
  2. /
  3. Outbound Payments
  4. /
  5. Retrieve Batch Status

Retrieve Batch Status


Retrieve Batch Status is a web service that allows a user to retrieve up to the last 10 (ten) batches uploaded to the Netcash system. The web service will return all batches, whether they were uploaded via the web service -or manually created via the Netcash web site.

This service relates to the Debit Order CollectionCreditor and Salary Payments services only.

Click here for the quick start guides for:

Programmers Guide

To start, refer our Programmers guide for more detail on how to apply the required methodology in this document.
Please ensure that the settings for Developers are correctly set before you proceed with the implementation below specification.

Web Service Methods

The list of Netcash web service methods can be found here

Technical Information

RetrieveBatchStatus is an online, synchronous web service which allows an external system to request up to the last 10 (ten) batches uploaded on the service and receive an immediate response. This service permits only a single request per web service call.

From your application call:


You will receive the following numeric code which you need to replace with the description in your application.

Numeric Response Description
100 Authentication failed
200 Web service error contact
311 Service key not valid for this service

If there is no error, you will receive a tab-delimited string response containing the last 10 batches loaded against the service key submitted. Note: The system will return a maximum of 10 batches, if fewer than 10 are found in the system, all the batches will be returned.

The format of the response

Field Description
Service key The service key submitted in the request
Batch ID The batch ID allocated by the Netcash system
Batch name The batch name allocated by the Netcash
Format: {Service} batch for {Action date}
EG: Debit batch for 2017-07-01
Status 1 – Unauthorised
2 – Authorised
3 – Locked
4 – Processed
5 – Insufficient funds (Applicable to payment batches only)
Batch volume The number of transactions in the batch
Batch value The total value of the batch
Created on Date and time the batch was loaded to the Netcash system
Format: CCYY-MM-DD HH:MM:SS.mmm
EG: 2017-07-01 08:40:34.517
Authorised on Date and time the batch was authorized on the Netcash system
Format: CCYY-MM-DD HH:MM:SS.mmm
EG: 2017-07-01 08:40:34.517
Batches never authorised will have the default value
1900-01-01 00:00:00.000
Unauthorised on Date and time the batch was unauthorised on the Netcash system
Format: CCYY-MM-DD HH:MM:SS.mmm
This field should be read in conjunction with the status field – batches may have been unauthorised and subsequently re-authorised.


See Testing section for more details. If you require any integration assistance contact our technical support team

Netcash may provide example/sample/demo ‘code snippets’ and/or external links in this Technical Document. Such are for guidance purposes only and may not function on every developer’s system/s. Netcash disclaims any and all liability for the usage of guidance resources provided -and you as the Developer; must accept full responsibility for the usage of such. While every possible effort has been taken to ensure compatibility across multiple system configurations, the contents of this document cannot be guaranteed to work on all systems, with all operating systems -and/or with all system configuration/s.

Version 2020.1

Copyright © 2022 Netcash (PTY) Ltd

Programmers Guide