The table below describes the Web service endpoints and methods Netcash offers via our API

Click here for a list of potential response codes when using these endpoints

 

Endpoint Method Explanation

NIF

 https://ws.netcash.co.za/NIWS/NIWS_NIF.svc
AccountFundsRelease Request a specific amount or available balance to be paid from a Netcash account to the bank account linked to the Netcash account. Inserts a release funds instruction for the Action date requested.
AccountFundsTransfer Inter account transfer between two Netcash accounts in the same group ( primary or sub-accounts).
AddMandate Allows a remote system to create a synchronous electronic mandate to be signed in the same session.
AVSRealtimeQuery Live / real-time Bank Account Verification. (AVS)
BatchFileUpload Allows a remote system to upload a NIF file with a choice of instructions.
See ** List of BatchFileUpload instructions below
DebiCheckAuthenticate Submit a DebiCheck mandate for authentication.
DebiCheckAuthenticationCurrentStatus Returns the status of a single DebiCheck authentication.
DebiCheckAmendAuthentication Make changes to an existing authentication without having the account holder need to re-authenticate. A notification of the change will be sent informing the account holder of the change.
DebiCheckCancelAuthentication Request cancellation of a single Authenticated DebiCheck mandate.
DebiCheckRetrieveMandateTemplate Obtain all details of a DebiCheck template on a specific Netcash account.
GetAvailableBalance Request the current and available balance of the Netcash account.
GetDebitLimits Request Debit order line and daily limits on a Netcash account.
GetPaymentLimits RequestPayment line and batch limits on a Netcash account.
GetPublicRecipients Displays a list of public recipients for creditor payments
IsValidServiceKey Indicates whether the service key is valid for an instruction.
NetcashTransfer Allows transfer of amounts from one Netcash account to another 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 1 on the service key.
Debit orders and Payments services only.
RequestInterimMerchantStatement Interim statements are made available every 15 minutes on the current business day.
RequestMerchantStatement Full daily statements are available on the day following the business day requested.
Any date in the past can be requested.
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 Submit a request for a list of the Netcash transaction types returned in a statement download.
RetrieveTransactionTypes* / MerchantStatementSourceStatus By submitting the File token returned in the request, this service returns a sample statement showing transaction codes and ID’s 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)
RequestPresentationDate Similar to RequestActionDate but checks Presentation Date – the cut-off date for the batch to be submitted to Netcash for processing.
RequestDebitBatchUnauthorised Request all unauthorised batches uploaded for a specified Debit Order service key and receive an immediate response.
RetrieveBatchStatus Request the last 10 batches uploaded for a specified service key and receive an immediate response.
RetrieveUnauthorisedBatches Request all unauthorised batches uploaded for a service key and receive an immediate response.
RequestBatchAuthorise Authorise batches retrieved by RetrieveUnauthorisedBatches.
RequestMandateData Request a dump of all the electronic mandates on the Netcash system for a Debit order service key.
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 synchronise 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.
RetrieveProofOfPayment Allows a remote system to request a Salary Payment Notification or Creditor Payment Notification as a base64 encoded string.

Validation

 https://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 where applicable.
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.
GetDebiCheckParticipatingBanks Returns a list of banks that process DebiCheck transactions.
GetPublicRecipients Returns a list of the valid Public Recipients that can be paid using the Netcash Creditor Payment service.
ValidateBankAccount Validate a bank account number, branch code, and account type.
ValidateBranchCode Validate a branch code.
ValidateId Validate a South African identity number.

Partner

 https://ws.netcash.co.za/NIWS/NIWS_Partner.svc
(NOTE: niws_partner service uses SOAP 1.2. with WS-* addressing. See example)
BatchFileUpload Rebate / Registration – register a new account.
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 Validate a range of Service key/Service Id combinations for a Netcash account.
ValidateComplianceStatus Check a Netcash account for Debit order compliance status.

Pay Now Service

 https://ws.netcash.co.za/PayNow/PayNow.svc
CreateInvoice Create a New Invoice.
DeleteSubscription Delete an existing Pay Now subscription
RequestCreditCardRefund Request a credit card transaction to be refunded.
RequestMOTOLive Upload tokenized credit card/s for collection.
UpdateSubscriptions Edit details of an existing subscription.

Push Notifications
CreateOrUpdatePNSHandle
DeletePNSHandle
RetrievePNSHandle

CDN
Netcash Tokenisation GUI This specification is relevant to Netcash customers who want to tokenise 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.

CCE
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

Batch File Upload 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).
ValidateId (Validate South African Identity number).
Rebate (Submit a batch of Rebates to be credited to existing Netcash Merchant accounts).
NetcashTransfer (Submit a batch of transfers for payment to Netcash accounts (third-party payments).
Creditor Payments service key Update (Update Creditors Masterfile)
Realtime (Submit Creditors batch for Same day processing)
DatedPayments (Submit Creditors batch for Dated processing)
RTCPayments (Submit Creditors batch for RealTime payment)
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)
RTCSalaries (Submit Salary batch for RealTime payment)
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 a batch of electronic mandates)
MandateStatus (Request mandate status)
MandateToMasterfile (Submit a batch of mandate references to be updated to the Debit order masterfile)
DebiCheckAuthentication (Submit a batch of DebiCheck mandates for authentication)
DebiCheckCancel (Submit a batch of authenticated DebiCheck mandates for cancellation)
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 Consumer 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 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 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.