Currently set to Index
Currently set to Follow

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:

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:

MethodGetBankListWithDefaultBranchCode
Service keyAccount Service Key
Web servicehttps://ws.netcash.co.za/NIWS/niws_validation.svc

MethodValidateBankAccount
Service keyAccount Service Key

Participating Banks and Universal Branch Codes

Bank Name Central Branch Code (CBC)
Absa Bank 632005
Capitec Bank 470010
First National Bank (South Africa) 250655
Investec Bank 580105
Nedbank (South Africa) 198765
Nedbank Corporate Saver Account 720026
Postbank 460005
Standard Bank (South Africa) 051001
African Bank 430000
Albaraka Bank 800000
Bank Of Namibia 980172
Bidvest Bank 462005
Central Bank Of Lesotho 586611
Citi Bank 350005
Finbond Mutual Bank 589000
First National Bank Lesotho 280061
First National Bank Namibia 282672
First National Bank Swaziland 287364
Grinrod Bank 584000
Hsbc Bank 587000
Jp Morgan Chase Bank 432000
Meeg Bank 471001
Merchantile Bank 450105
Mtn Banking 490991
Standard Bank Namibia 087373
State Bank Of India 801000
Ubank 431010
Unibank 790005
Vbs Mutual Bank 588000

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, 3 Transmission, 4 = Bond/Mortgage)

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

Code Samples

<select id="accountType" name="accountType">
    <option selected="selected" value="1">Cheque Account</option>
    <option value="2">Savings Account</option>
    <option value="3">Transmission Account</option>
    <option value="4">Mortgage Account</option>
</select>
<select id="bankName" name="bankName">
    <option selected="selected" value="632005">Absa Bank</option>
    <option value="470010">Capitec Bank</option>
    <option value="250655">First National Bank (South Africa)</option>
    <option value="580105">Investec Bank</option>
    <option value="198765">Nedbank (South Africa)</option>
    <option value="720026">Nedbank Corporate Saver Account</option>
    <option value="460005">PostBank</option>
    <option value="051001">Standard Bank (South Africa)</option>
    <option value="430000">African Bank</option>
    <option value="800000">Albaraka Bank</option>
    <option value="980172">Bank Of Namibia</option>
    <option value="462005">Bidvest Bank</option>
    <option value="586611">Central Bank Of Lesotho</option>
    <option value="350005">Citi Bank</option>
    <option value="589000">Finbond Mutual Bank</option>
    <option value="280061">First National Bank Lesotho</option>
    <option value="282672">First National Bank Namibia</option>
    <option value="287364">First National Bank Swaziland</option>
    <option value="584000">Grinrod Bank</option>
    <option value="587000">HSBC Bank</option>
    <option value="432000">JP Morgan Chase Bank</option>
    <option value="471001">Meeg Bank</option>
    <option value="450105">Merchantile Bank</option>
    <option value="490991">MTN Go Banking</option>
    <option value="087373">Standard Bank Namibia</option>
    <option value="801000">State Bank Of India</option>
    <option value="431010">UBank</option>
    <option value="790005">Unibank</option>
    <option value="588000">VBS Mutual Bank</option>
</select>
<select id="debitFrequency" name="debitFrequency">
    <option selected="selected" value="Monthly">Monthly</option>
    <option value="Weekly">Weekly</option>
    <option value="Bi-Weekly">Bi-Weekly</option>
    <option value="Annual">Annual</option>
    <option value="other">other</option>
</select>
<select id="debitAccountType" name="debitAccountType">
    <option selected="selected" value="1">Bank Account</option>
    <option value="2">Credit Card</option>
</select>
<select id="ccardType" name="ccardType">
    <option selected="selected" value="1">Master Card</option>
    <option value="2">Visa Card</option>
</select>

The Service

Object Name Description
method GetBankListWithDefaultBranchCode

Parameter:

  • ServiceKey (Netcash account service key). Call the service to receive the list of all banks with their default branch code (XML file). Save the data to system as stated above.
method ValidateBankAccount

Parameters:

  • ServiceKey (Netcash Account Service Key)
  • AccountNumber
  • BranchCode
  • AccountType

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.

Numeric Response Description
0 Bank account details valid
1 Invalid branch code
2 Account number failed check digit validation
3 Invalid account type
4 Input data incorrect
100 Authentication failed
200 Web service error contact support@netcash.co.za

Testing

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 © 2020 Netcash (PTY) Ltd