Currently set to Index
Currently set to Follow

Overview

The Netcash Lead Status file is generated on request via the NIWS_partner web service.

The file contains the remote account number supplied when the lead was logged, the number of the Netcash account which was opened when the lead was logged, the current status of the account as well as any detail which is captured for the account on the Netcash system.

A unique Lead Generator Service Key (LGK) is required to use this service. Use the default Lead Generator Service Key 97f3a99c-1887-41e9-8351-015718fd8d5d or contact our Solutions Architect at Netcash for more information.

The remote system supplies the Lead Generator Service Key and the Netcash Account Number, which was used to register the original lead and polls to retrieve the lead status file generated by the Netcash system.

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.

Web Service Methods

The list of Netcash web service methods can be found here

Access

NIWS_PARTNER is an asynchronous web service which exposes multiple methods. The method BatchFileUpload allows an external system to submit a batch file of leads to the Netcash system

Endpoint url:

https://ws.netcash.co.za/niws/niws_partner.svc

Methods:

public string RequestAccountStatus(string LeadGeneratorKey, string AccountNumber)

Returns either

  • 100
  • 200
  • 300
  • FileToken

public string RetrieveAccountStatus (string LeadGeneratorKey, string FileToken)

Returns either

  • 200
  • FILE NOT READY
  • Lead Status File

Response

The web service is asynchronous.

The remote system calls the RequestAccountStatus method, which returns a file token.

The remote system then calls the RetrieveAccountStatus method using the file token returned in the previous call to retrieve the account status data.

If a postback URL has been supplied, the load report will be returned to the URL as an HTTP post.

Web service validation

The NIWS web service performs initial validation on the incoming web service method call. If the validation fails, the service will return an error code.

Code Description
100 Authentication failure. Ensure that the Lead generator key in the method call is correct
200 General code exception. Please contact Netcash Technical Support.
300 Account not found

Lead status file format

The file is a tab-delimited text file.

The file contains the latest data for the requested account, as it exists in the Netcash database.

File header and footer records bind the file.

 

File header

Occurs once at the start of the file

Field Description A/AN Field
1 Record identifier A FH
2 File date stamp N CCYYMMDDHHMMSSS
3 Lead generator key AN The GUID key assigned by Netcash
4 Sage account number AN The account number of the Sage software
5 Netcash account number N11 The number of the linked Netcash account
6 Account status N 0 – Inactive opportunity
1 – Lead opportunity
2 – Active opportunity
10 – Busy registering
11 – Registration complete
12 – Registration verification
20 – Active pending
21 – Active
22 – Suspended
30 – Closed
31 – Unused account

Account detail

Field Name Type Value
1 Trading name AN Account trading name
2 Registration number AN Registration number
3 Registered name AN Account registered name
4 VAT number AN VAT registration number
5 Legal entity N2 1 = Registered company (Pty Ltd)
2 = Close corporation
3 = Section 21 company
4 = Non-profit organisation
5 = Trust
6 = Co-operative
7 = Sole proprietor
8 = Partnership
9 = Educational institution
10 = Unknown
11 = Association
12 = Incorporation
6 Company web address AN50 The “//:” and “.” symbols are allowed in this field
7 Phone number N11 Include dialing codes EG: 27117822349
8 Fax number N11 Include dialing codes EG: 27117822349
9 Physical address line 1 AN50
10 Physical address line 2 AN50
11 Physical suburb AN50
12 Physical city AN50
13 Physical code N4
14 Physical province N1 1 = Western Cape
2 = Gauteng
3 = Eastern Cape
4 = Free State
5 = KwaZulu Natal
6 = Limpopo
7 = Mpumalanga
8 = Northern Cape
9 = North West
15 Postal address line 1 AN50
16 Postal address line 2 AN50
17 Postal suburb AN50
19 Postal city AN50
20 Postal code N4
21 Postal province N1 1 = Western Cape
2 = Gauteng
3 = Eastern Cape
4 = Free State
5 = KwaZulu Natal
6 = Limpopo
7 = Mpumalanga
8 = Northern Cape
9 = North West
22 Account user ID N13 Primary account user details
23 Account user surname A15 Primary account user details
24 Account user first name A10 Primary account user details
25 Account user title N1 1 = Mr
2 = Mrs
3 = Ms
4 = Miss
5 = Dr
6 = Prof
26 Designation A25 Director, Member, Trustee, Sole proprietor, etc
27 Job description A25 Manager, Owner, Bookkeeper, etc.
28 Email address AN50
29 Telephone number N11 Include dialing codes EG: 27117822349
30 Mobile number N11 Include dialing codes EG: 27117822349
31 Bank account holder AN50 The name linked to the bank account
32 Bank account type N1 1 = Current / Checking
2 = Savings
3 = Transmission
33 Bank account branch N6 The branch code of the homing account. This field MUST be 6 digits. Pre-fill with zeroes if less than 6.
34 Bank account number N11 The homing bank account number.
35 Extra 1 AN50 User-defined data received in upload file
36 Extra 2 AN50 User-defined data received in upload file
37 Extra 3 AN50 User-defined data received in upload file

File Footer

Occursonce at the end of the file

Field Name Type Value
1 Record identifier A FF
2 End of file indicator AN #END#

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