Currently set to Index
Currently set to Follow
  1. Home
  2. /
  3. Standard Integration
  4. /
  5. ZA Bank Account Validation

Bank Account Validation

Overview

Bank Account Validation is a web service that uses an algorithm see note to validate the bank account number, branch code, and account type combination. Any software that allows for the capture of bank account details this web service as it ensures valid data is sent to Netcash that will enhance the success of transactions processed.  This service does not verify that the account is active or belongs to the individual or company (See Bank Account Verification)

We recommend that Universal Branch Codes are used for the validation to be optimized.

 

Click here for the quick start guides for:

A CDV validation is performed using a combination of the bank account number, account type, and branch code.
It is an algorithm supplied to Netcash and continuously updated by the banking system.
This does not guarantee the validity of the account number at any bank or branch, the account holder or if the account is active.
We suggest that you first validate and then verify the account holder details to ensure accuracy.

Web Service Methods

The list of Netcash web service methods can be found here

Quick Start Guides

Quick Start Guides will help you understand this service and you get started.

Programmers Guide

Refer to our Programmers guide for more detail on how to apply the required methodology in this document. Ensure that the settings for developers are adhered to before you proceed with implementation.

Universal Branch Code Processing

Most South African Banks use a Universal Branch Code (UBC) or a Central Branch Code (CBC) for transactional banking. Any software that allows for the capture of bank account details should as it ensure the banking detail will be valid even if the account holder’s branch closes. Payment failures are significantly reduced when using universal branch codes.

Technical Information – single line request

The below information is for single item Bank Account Validation. For single item RSA ID Validation click here

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

Technical Information – bulk/file requests

The below information refers to Bulk/File requests for multiple Bank Account or RSA ID validations.

Web service:

 

Input File Structure

The file is a tab-delimited text file and 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 – Transactionrecordsfollow 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 confirm that the file is complete.

 

Header record (H)

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

Field Name Type Value
1 Record Identifier AN H
2 Service Key AN Account Service Key
3 Version AN 1
4 Instruction AN Purpose of the file
5 Batch name AN Your identifier
6 Action date N CCYYMMDD
7 Software Vendor Key AN The key issued by Netcash to identify the software origin of transactions. (only used by NetcashISV‘s else use the default value:24ade73c-98cf-47b3-99be-cc7b867b3080)

Field explanations

Field Explanation
Record Id “H” – Identifies the record as a header
Service key Account Service key
Version “1” – This is the Netcash version of the file specification
Instruction

ValidateAcc

or

ValidateId

Batch name Use this field as an identifier of your batch.
Action date Today
Software Vendor Key The key issued by Netcash to identify the software origin of transactions. (only used by NetcashISV‘s else use the default value:24ade73c-98cf-47b3-99be-cc7b867b3080)

 

Example – Bank Account Validation

H C74EXXX5-5499-4663-85FB-2A6XXXXFB9EF 1 ValidateAcc My Validation Batch 20100331 24ade73c-98cf-47b3-99be-cc7b867b3080

Example – ID Validation

H C74EXXX5-5499-4663-85FB-2A6XXXXFB9EF 1 ValidateId My Validation Batch 20100331 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.
  • The key defines the content, order and length of the transactions records in the file. It can be likened to the column headings in a spreadsheet.
  • The key lists all the possible fields contained in the subsequent transaction records, even if not every transaction record contains data in all the fields.
  • While the file is customizable, it is recommended that keys are listed in ascending numerical order for ease of debugging and support.

Example

K 101 111 131 133 134 135 136 301 302 303

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.
    (In the example above, the account reference (field id 101) is defined as the first field in the record therefore every transaction record MUST have the account reference as the first field or it will fail validation)
  • Every transaction record must have the same number of fields as defined in the key record (K).
  • Empty fields should be replaced by a blank tab or a default value, where one has been defined. Where fields are left empty, the Netcash system will assume spaces or zeroes for fields defined in the key record.

Example (Bank Account Validation)

T Acc001 1 632005 0 1 9012347777

Example (ID Validation)

T Acc001 6612110000000

Mandatory field

The fields indicated by tickis mandatory for the specified instruction.

See the full API key legend for value requirements

 

Key Field name ValidateAcc ValidateId
101 Account reference tick tick
111 Id number tick
131 Banking detail type tick
133 Bank account type tick
134 Branch tick
135 Filler tick
136 Account number tick
301 Extra 1
302 Extra 2
303 Extra 3

 

Examples

F 2 0 9999

Example of input file * Bank Account Validation

H C74EXXX5-5499-4663-85FB-2A6XXXXFB9EF 1 ValidateId ID Validation Batch 20100331 24ade73c-98cf-47b3-99be-cc7b867b3080
K 101 111 131 133 134 135 136
T Acc001 1 632005 0 1 9012347777
T Acc002 1 250544 0 1 87255629992
F 2 0 9999

Example of input file * ID Validation

H C74EXXX5-5499-4663-85FB-2A6XXXXFB9EF 1 ValidateId Account Validation Batch 20100331 24ade73c-98cf-47b3-99be-cc7b867b3080
K 101 111 
T Acc001 8002315678987
T Acc002 6612316752345
F 2 0 9999

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
TymeBank 678910
African Bank 430000
Albaraka Bank 800000
Bank of Namibia 980172
Bidvest Bank 462005
Central Bank of Lesotho 586611
Citi Bank 350005
Discovery Bank 679000
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
Mercantile Bank 450105
MTN Banking 490991
Olympus Mobile Bank 585001
Standard Bank Namibia 087373
State Bank of India 801000
Ubank 431010
Unibank 790005
VBS Mutual Bank 588000

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

Version 2020.1

Copyright © 2022 Netcash (PTY) Ltd

Programmers Guide