Overview

Retrieve Batch Status by date is a web service that allows a user to retrieve 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 Collections, Creditor and Salary Payments services only.

Similar Services

  1. Retrieve batch status
  2. Retrieve multiple batch status
  3. Retrieve specific batch status

Technical Information

RetrieveBatchStatusByDate is an online, synchronous web service that allows an external system to request batches uploaded on the service within a supplied date range and receive an immediate response. This service permits only a single request per web service call.

From your application call:

  • Web service: https://ws.netcash.co.za/NIWS/NIWS_NIF.svc
  • Method: RetrieveBatchStatusByDate
  • Submit one of the following Service Keys relevant to the batches to be returned:
    1. Debit Order service key
    2. Creditor Payments service key
    3. Salary Payments service key
    4. Supply the StartDate and EndDate (format = CCYYMMDD)

Output

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 support@netcash.co.za
311 Service key not valid for this service

If there is no error, you will receive a tab-delimited string response containing the batches loaded within the supplied date range against the service key submitted.

Note: The system is limited to returning a maximum of 90 days or 100 batches. If the response exceeds the limitation, the latest 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
Format {Service} batch for {Action date} or (the name supplied in the batch creation request)
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.

Netcash brand guidelines

Please refer to the Netcash brand guidelines here when using any logos, images, icons, labels, descriptions, and references to Netcash in your software.

Testing

See the 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.