Overview

Bank Account Validation is a web service that uses an algorithm to validate the bank account number, branch code and account type combination 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, bank account verification, bank codes or payments. This service does NOT verify (See Bank Account Verification) that the account is active or belong 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

Click here for the quick start guides for:

• Netcash System Permissions

Web Service Methods

The list of Netcash web service methods can be found here

QuickStart Guides

We have developed some Quick Start Guides to help you understand this service and to help you get started.

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.

Universal Branch Code Processing

Most South African Banks now use a Universal Branch Code (UBC) for transactional banking (also known as a Central Branch Code (CBC)). Any software that allows for the capture of bank account details should implement these as it reduces the risk of users entering incorrect branch codes or having to request additional information to complete bank details. Payment failures are significantly reduced when using universal branch codes.

Technical Information

NIWS_Validation is an online, synchronous web service that allows an external system to request validation and receive an immediate response. This service permits only a single request per web service call.

From your application call:

Method: GetBankListWithDefaultBranchCode
Service key: Account Service Key
Web service: https://ws.netcash.co.za/NIWS/niws_validation.svc

Method: ValidateBankAccount
Service key: Account Service Key

Participating Banks and Universal Branch Codes

Recommended User Experience

1. Call the web service with method GetBankListWithDefaultBranchCode
   or
2. Manually create a table in the application database with the bank branches and codes as indicated above.

The suggested method is to create a user experience whereby the user will in the application:

• In the application: select a bank “Drop down” menu which if a bank is selected -prefill branch code text box (where there is such a CBC) but
• The Branch Code Text Box Field is to remain editable so that user can change it if so desired. Please note that the change might result in non-payment as the CBC is preferred.
• If the bank required is not in the dropdown – user to select “other bank” and type the six (6) digit numeric branch code in the text box. Left-pad the input with “0” where data entered is less than 6 chars.
• Netcash will offer all blue and bold items above as “dropdown list” in our systems. We will accept black and italic items if entered by the user if “other bank” is selected in dropdown menu, together with any other valid branch codes not listed herein (for validation purposes).
• For all black and bold above; default account type in the database to 1 (cheque/current) except
  • for Nedbank
    • If a Nedbank account number starts with ‘2’ make type 2 (savings) else
    • If Nedbank account number starts with ‘1’ leave type 1 and
    • If a Nedbank account number starts with ‘9’/or is a Corporate Saver Account; make the account type 2 (savings) and only use branch code 720026.
  • for Postbank
    • Always use account type “2” (savings) for all Postbank transactions

All non-listed (above) banks – user to select the actual account type (1 = Current/Cheque, 2 = Savings)

NIWS_Validation is an online, synchronous web service that allows an external system to request validation and receive an immediate response. This service permits only a single request per web service call.

Code Samples

The Service

Example

public ValidateBankAccount(string ServiceKey, string AccountNumber, string BranchCode, string AccountType)
        {
            //initialise client 
            NIWS_Validation.NIWS_ValidationClient client = new NIWS_Validation.NIWS_ValidationClient();

            //call the ValidateBankAccount method equal to a string variable
            string Request = client.ValidateBankAccount(ServiceKey, AccountNumber, BranchCode, AccountType);

            //close client after response is received
            client.Close();

//convert response received for request
            int response = Convert.ToInt32(Request);

            //if 0 save to system or do something else
            switch (response)
            {
                case 0: //do something
                    break; 
                case 1: //do something
                    break;
                case 2: //do something
                    break;
                case 3: //do something
                    break;
                case 4: //do something
                    break;
                case 100: //do something
                    break;
                default: Web service error contact support@netcash.co.za";
                    break;
            }
        }

Getting Bank with Branch Code

private void GetBankListWithDefaultBranchCode (string ServiceKey)
        {
            //initialise client 
            NIWS_Validation.NIWS_ValidationClient client = new NIWS_Validation.NIWS_ValidationClient();

            //call the GetBankListWithDefaultBranchCode method equal to a string variable
            string BankListResult = client.GetBankListWithDefaultBranchCode(ServiceKey);

            //do something with xml file
            //for example
            File.WriteAllText("BankList.xml", BankListResult);

                XmlDocument XmlDoc = new XmlDocument();

                XmlDoc.Load("BankList.xml");

                XmlElement XmlEl = XmlDoc.DocumentElement;
                XmlNodeList XmlNode = XmlEl.SelectNodes("/BankListResponse/BankList/Bank");

                foreach (XmlNode node in XmlNode)
                {
                    //loop through file
                }
        }

Output

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

Testing

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