Overview
ViewBlockedAccounts is a web service method allowing an external system to search for blocked bank accounts using a date range.
Input
From your application call:
- Web service: https://ws.netcash.co.za/NIWS/niws_nif.svc
- Method: ViewBlockedAccounts
Field | Explanation |
Service Key | Debit Order Service Key |
Start_date | CCYYMMDD |
End_date | CCYYMMDD |
Output
Failed requests will return one of the following codes.
Numeric Response | Description |
000 | Success |
Successful
requests will return
Field | Value |
AccountName | AN |
AccountNumber | N |
ActionDate | N |
BankAccountNumber | N |
BlackListType | A |
BranchCode | N |
DateBlocked | N |
Description | AN |
UnpaidCode | N |
Examples
Request
<RetrieveBlockedAccounts> <MethodParameters> <ServiceKey>B06317BA-XXX-4295-AAAA-E16A01234950</ServiceKey> <StartDate>20250601</StartDate> <EndDate>20250610</EndDate> </MethodParameters> </RetrieveBlockedAccounts>
Response
<RetrieveBlockedAccounts> <MethodParameters> <RetrieveBlockedAccountsResponse> <BlockedAccounts> <BlockedAccount> <AccountName>ABC SHOES</AccountName> <AccountNumber>52100000076</AccountNumber> <ActionDate>20250601</ActionDate> <BankAccountNumber>1310XXXX36</BankAccountNumber> <BlackListType>Consecutive Unpaids</BlackListType> <BranchCode>632005</BranchCode> <DateBlocked>20250602</DateBlocked> <Description>RZAB500 - MR XYZ - Code: 2</Description> <UnpaidCode>2</UnpaidCode> </BlockedAccount> <BlockedAccount> <AccountName>ABC SHOES</AccountName> <AccountNumber>52100000076</AccountNumber> <ActionDate>20250602</ActionDate> <BankAccountNumber>127XXXXX85</BankAccountNumber> <BlackListType>Consecutive Unpaids</BlackListType> <BranchCode>632005</BranchCode> <DateBlocked>20250603</DateBlocked> <Description>RZ5XX2PL - MRS YZ - Code: 2</Description> <UnpaidCode>2</UnpaidCode> </BlockedAccount> </BlockedAccounts> <ErrorCode>000</ErrorCode> </RetrieveBlockedAccountsResponse> </MethodParameters> </RetrieveBlockedAccounts>
If there are no records, then only display “There are no records to display”
Should the request be unsuccessful, the following code(s)
Code | Description |
100 | Authentication error (Service key supplied is not valid and active or the Account or service is not Active) |
200 | General web service error, contact support. |
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