ID Validation – Bulk File

Overview

ID Validations is a web service that uses an algorithm the ID number of an employee, debtor or creditor. Any software that allows for the capture of bank account details should implement this web service as it is critical for the success of other Netcash services requiring bank details such as ID number, verification, bank codes or payments. This service does NOT verify (See ID Verification) that the ID number is active or belongs to the employee, debtor or creditor.

This service is to be used on input of data into the application to ensure that the Banking details supplied are valid. It is recommended that Universal Branch Code processing is used for the validation to be effective

Technical Information

NIWS_Validation is an online, synchronous web service that allows an external system to request validation and receive an immediate response.

NB! This service permits bulk requests per web service call. For single item requests click here

From your application call:

• Web service: https://ws.netcash.co.za/niws/niws_nif.svc
• Method: BatchFileUpload
• Service key: Account service key

Input

Requests to the web service are sent as strings

Example:

public string BatchFileUpload(string ServiceKey, string File)

 

Output

Successful request

If the method call was successful and the file is being processed, the web service will return a file token which is used to retrieve the load report

Example:  20000000.2550236530.0483.2.2

Unsuccessful request

If the method call fails, the web service will return an error code:

Code	Description
100	Authentication failure. Ensure that the service key in the method call is correct
102	Parameter error. One or more of the parameters in the string is incorrect
200	General code exception. Please contact Netcash Technical Support.

Input file structure

Each file has the following mandatory records:

H – Header record identifies the upload and passes instructions to the Netcash server to determine the purpose of the file.
K – Key record must follow the header record. The key record describes the transaction records which follow. The format defined in the key record is used to validate the record structure and content.
T – Transaction records follow the key record. The fields in the transaction records must conform to the layout defined in the key.
F – Footer record must be the last record in the file and confirms that the file is complete.

Header record (H)

Every file must contain a header record as the first record in the file.

Record Structure

Field	Name	Type	Value
1	Record Identifier	AN	“H” – Identifies the record as a header
2	Service Key	AN	GUID (Account service key)
3	Version	AN	1
4	Instruction	AN	ValidateId
5	Batch name	AN	Your batch identifier
6	Action date	N	CCYYMMDD Current date
7	Software vendor code	AN	Your software vendor code issued by Netcash.

Example  H C74EF975-5429-4663-85FB-2A64CA0FB9EF 1 ValidateId My Test Batch 20201030 24ade73c-98cf-47b3-99be-cc7b867b3080

 

Key record (K)

The key record is mandatory and must appear in the file between the header record and the transaction records.

For ValidateId, only the Account reference and the Id number fields are required

Example  K 101 111

 

Transaction record (T)

There must be at least one transaction record in the file.

The transaction records must conform to the order of the fields as described in the key record.

Record structure

Field	Name	Type	Value
101	Account reference	AN22	The unique reference used to identify the mandate. Minimum 2 Maximum 22 characters
111	Id Number	N13	The SA Id number to be validated

Footer record (F)

The footer record indicates that the complete file has been received. It must be the last record in the file. If the record is not present, the system will fail the file without processing any transaction records.

Record structure

Field	Explanation
Record Identifier	“F” – Identifies the record as a footer
No of transactions	This is the count of all the ‘T’ records in the file.
Sum of amounts	0
End-of-file indicator	‘9999’ – Indicates there are no more records.

Example

F 2 0 9999

Example of input file

H C74EXXX5-5499-4663-85FB-2A6XXXXFB9EF 1 ValidateId My Test Batch 20131204 24ade73c-98cf-XXXX-XXXX-cc7b867b3080
K 101 111 
T AB3456 6712316677086
T CD0SX7 4512316665088
F 2 0 9999

 

Retrieve Load report

You will need to request the load report using the file token received from the BatchFileUpload method call.

Input

Using the file token, call:

• Web service: https://ws.netcash.co.za/niws/niws_nif.svc
• Method: RequestFileUploadReport
• Service key: Account service key

Requests to the web service are sent as strings

Example: public string RequestFileUploadReport(string ServiceKey, string FileToken)

Output

If the file submitted is in the correct format, the Load report header will contain “SUCCESSFUL”.

Any format errors detected in upload file will be reported.

File structure

The report is tab delimited with a linefeed character as line terminator.

Note: Only rows which failed validation will be reported. Where the load report is empty and the result is SUCCESSFUL, this indicates that all rows passed the CDV check.

Load report header (occurs once at the start of each load report)

Field	Name	Type	Value
1	Record identifier	AN8	###BEGIN
2	Batch name	AN	{your batch name}
3	Result of upload	A13	SUCCESSFUL / UNSUCCESSFUL / SUCCESSFUL WITH ERRORS
4	Start time of report	AN8	HH:MM AM/PM

Load report message (occurs multiple times – once per error record)

Field	Name	Type	Value
1	Record identifier	AN8	###ERROR
2	Error message	AN	The error message

Load report trailer (occurs once – the last line in the report)

Field	Name	Type	Value
1	Record identifier	AN6	###END
2	End time of report	AN8	HH:MM AM/PM

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