The Netcash API makes use of web services are WCF Soap based web services. Please familiarize yourself with the use of WCF Soap based web services before you attempt to use the Netcash API.
To start, refer our Programmers Guide for more detail on how to apply the required methodology. Please ensure that the Settings for Developers are correctly set before you proceed with the integration.
The following list details the methods that ISV’s can use in order to obtain or send information securely using the Netcash Web Service
The web service error codes can be located here
RequestMandateDataAllows a remote system to request a dump of all the electronic mandates on the Netcash system for a specified Debit order service key
| Endpoint | Method | Explanation |
NIWS NIFhttps://ws.netcash.co.za/NIWS/NIWS_NIF.svc
|
||
| AccountFundsRelease | Allows a remote system to request a payment from the client’s Netcash account into the bank account configured against the account. Inserts a release funds instruction for the Action date requested | |
| AddMandate | Allows a remote system to generate asynchronous electronic mandate to be submitted for signature in the same session | |
| BatchFileUpload | Allows a remote system to upload a prepared NIF file for a variety of instructions. See ** “List of BatchFileUpload instructions” below | |
| GetPaymentLimits | Allows a remote system to request the current Payment line and batch limits configured against the client’s Netcash account. | |
| GetDebitLimits | Allows a remote system to request the current Debit order line and daily limits configured against the client’s Netcash account. | |
| RequestActionDate | Allows a remote system to submit an Action date for a specified account, service, and instruction for validation. Returns the date if valid or the next available date if ForwardActionDate is set to true. Else returns 200. Debit orders and Payments services only. | |
| RequestInterimMerchantStatement | Interim statements are made available every 15 minutes on the current business day. The remote system may only request an interim statement for the current date. The Netcash system will return any transactions which have been committed to the data warehouse as complete at the time of the request, else returns “NO CHANGE”. | |
| RequestMerchantStatement | Full daily statements are available on the day following the business day requested. The remote system may request a statement for any day in the past. The requested date may not be the current date or any future date. | |
| RetrieveMerchantStatement | Where no postback option has been configured, the remote system will need to call the RetrieveMerchantStatement method to fetch the statement requested (RequestMerchantStatement or RequestInterimMerchantStatement) | |
| RequestTransactionTypes | Allows a remote system to submit a request for a list of the Netcash transaction types returned in a statement download. | |
| RetrieveTransactionTypes | By submitting the File token returned in the request, this service returns a sample statement showing transaction codes and ids with the associated GL codes for statement mapping. | |
| RequestFileUploadReport | By submitting the File token returned in the request, this service returns the load report for the batch submitted. | |
| RequestCombinedUploadReportForDate | Allows a remote system to extract all the load reports relating to a specified service key for a specified date. | |
| RequestCreditDataReport | By submitting the File token returned in the request, this service returns the Base64 encoded PDF Risk report for the batch submitted (BatchFileUpload) | |
| RequestAVSReport | By submitting the File token returned in the request, this service returns the Base64 encoded PDF Account verification report for the batch submitted (BatchFileUpload) | |
| RequestPayNowInvoice | By submitting the File token returned in the request, this service returns the Pay Now invoice detail for the batch submitted (BatchFileUpload) | |
| RequestDebitBatchUnauthorised | Allows a remote system to request all unauthorized batches uploaded for a specified Debit Order service key and receive an immediate response. | |
| RetrieveBatchStatus | Allows a remote system to request the last 10 batches uploaded for a specified service key and receive an immediate response. | |
| RetrieveUnauthorisedBatches | Allows a remote system to request all unauthorized batches uploaded for a specified service key and receive an immediate response. | |
| RequestBatchAuthorise | Allows a remote system to authorize batches retrieved by RetrieveUnauthorisedBatches. | |
| RetrieveMandateData | By submitting the File token returned in the request, this service returns a tab-delimited file of all the electronic mandates registered against the service key submitted. The service is used to synchronize the status of electronic mandates between the remote system and the Netcash database. | |
| RetrieveMandatePDF | Allows a remote system to retrieve a list of links to the signed electronic mandate PDF files which were requested using the BatchFileUpload method and RequestMandatePDF instruction | |
|
|
||
NIWS_VALIDATIONhttps://ws.netcash.co.za/NIWS/NIWS_Validation.svc
|
||
| GetBankList | Returns a list of supported bank names | |
| GetBankListWithDefaultBranchCode | Returns a list of supported banks, including default branch codes if the bank has one | |
| GetBranchList | Returns a list of branches for a specified bank and branch name | |
| GetBranchListBySuburb | Returns a list of branches for a specified bank and suburb name | |
| ValidateBankAccount | Allows a remote system to check a bank account number, branch code, and account type | |
| ValidateBranchCode | Allows a remote system to check a bank branch code | |
| ValidateId | Allows a remote system to check a South African identity number | |
|
|
||
Partner
|
||
| BatchFileUpload (partner site) | Instructions: Rebate; Registration | |
| RequestFileUploadReport | By submitting the File token returned in the request, this service returns the load report for the batch submitted. | |
| RequestAccountStatus | Request the current status of an account uploaded via the BatchFileUpLoad Registration instruction | |
| RetrieveAccountStatus | By submitting the File token returned in the request, this service returns the status of the account number submitted | |
| ValidateServiceKey | Check a range of Service key/Service Id combinations for a specified Netcash account to ensure that the key is valid | |
| ValidateComplianceStatus | Check an account number for debit order compliance status | |
|
|
||
CDN |
Netcash Tokenisation GUI | This specification is relevant to Netcash customers who want to tokenize credit card details through a GUI interface. It applies to all data required to invoke the GUI and deal with the response from the interface. The idea behind this GUI is to lower the PCI requirement to a Self-Assessment where the merchant must fill in questionnaire A to be compliant |
|
|
||
CCE Service |
AddCard | The Netcash vault web service is provided for the secure storage of credit card numbers in terms of the Payment Card Industry Data Security Standard |
|
|
||
| NetConnector | NetConnector is designed to allow Netcash system data to be presented in real-time within a remote application with HTML content | |
List of BatchFileUpload instructions
Submit any of these instructions in the header record (H) of a NIF file
| Service key | Instruction | |
|
|
||
| Account service key | ValidateAcc (Validate bank account details) | |
| validate (Validate South African Identity number) | ||
|
|
||
| Creditor Payments service key | Update (Update Creditors Masterfile) | |
| Realtime (Submit Creditor’s batch for Same day processing) | ||
| DatedPayments (Submit Creditors batch for Dated processing) | ||
| CompactRealtime (Submit Creditors batch for Same day processing in compact format) | ||
|
|
||
| Salary Payments service key | Update (Update Employee Masterfile) | |
| PaySalaries (Submit Salary batch for Same day processing) | ||
| DatedSalaries (Submit Salary batch for Dated processing) | ||
| CompactPaySalaries (Submit Salary batch for Same day processing in compact format) | ||
|
|
||
| Debit Order service key | Update (Update Debit order Masterfile) | |
| TwoDay (Submit Debit order batch for Two-day processing) | ||
| SameDay (Submit Debit order batch for Same day processing) | ||
| CompactTwoDay (Submit Debit order batch for Two-day processing in compact format) | ||
| CompactSameDay (Submit Debit order batch for Same day processing in compact format) | ||
| DebiCheck (Submit DebiCheck batch for processing) | ||
| Mandates (Submit batch of electronic mandates) | ||
| MandateStatus (Request mandate status) | ||
| MandateToMasterfile (Submit a batch of mandate references to be updated to the Debit order Masterfile) | ||
| RequestMandatePDF (Submit a batch of mandate references for links to the signed mandate PDF document) | ||
|
|
||
| Pay Now service key | Invoice (Submit a batch of invoices) | |
|
|
||
| Risk Reports service key | CD11 (Transunion Credit Check) | |
| CD12 (Experian Consumer Credit Check) | ||
| CD13 (XDS Consumer Credit Check) | ||
| CD14 (ID number verification) | ||
| CD16 (Transunion Mini Company Report) | ||
| CD23 (Businesses Linked To Consumer) | ||
| CD31 (CIPC Business Report with principal clearance) | ||
| CD32 (CIPC Business Report) | ||
| CD35 (Bank account verification AVS) | ||
| CD37 (ID number verification (XML response)) | ||
Netcash Glossary
Refer to the glossary for terminology used by Netcash in our Technical Documentation
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