Before you start

Please download the suggested API integration process flow document and use it as a reference when developing.
Kindly adhere to the Netcash brand guidelines when developing.

 

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 your implementation.

 

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 get you started.

Overview

Allows a remote system to request the configured parameters on an existing DebiCheck authentication template set up in the Netcash system.

Technical Information

RequestPresentatioDebiCheckAuthenticationCurrentStatus is an online, synchronous web service that returns the current status for a given Contract reference.

From your application call:

Input

Service Method Parameters
NIWS/niws_nif.svc DebiCheckRetrieveMandateTemplateDetail Debit Order Service Key
DebiCheck Template ID


Call this method for
Debi Check Mandate Template:

Key Field name Mandatory Type
242 DebiCheck mandate template ID AN ID of pre-defined DebiCheck mandate template EG: NCDCT000000001

 

XML Request

<DebiCheckRetrieveMandateTemplateDetail>
  <MethodParameters>
    <ServiceKey>3a9be0d4-XXXX-4c2b-XXXX-05bf64cac464</ServiceKey>
    <DebiCheckMandateTemplateId>NCDCT000000030</DebiCheckMandateTemplateId>
  </MethodParameters>
</DebiCheckRetrieveMandateTemplateDetail>

 

XML Response

<DebiCheckRetrieveMandateTemplateDetail>
  <MethodParameters>
    <DebiCheckMandateTemplateDetail>
      <AdjustmentAmount>0.0000</AdjustmentAmount>
      <AdjustmentCategory>N</AdjustmentCategory>
      <AdjustmentRuleIndicator>Y</AdjustmentRuleIndicator>
      <AdjustmentType>AMNT</AdjustmentType>
      <AuthenticationType>BATCH</AuthenticationType>
      <CollectionFrequency>MNTH</CollectionFrequency>
      <CollectionFrequencyDayCode>MNTH_01</CollectionFrequencyDayCode>
      <DebitEntryClassCode>0036</DebitEntryClassCode>
      <DebitValueType>USAGE BASED</DebitValueType>
      <DebtorAuthCode>Batch (TT2)</DebtorAuthCode>
      <DebtorAuthenticationRequired>0227</DebtorAuthenticationRequired>
      <InitiationDayOptions attr0="StringArray" isNull="false">
        <StringArray0>MNTH_01</StringArray0>
        <StringArray1>MNTH_30</StringArray1>
        <StringArray2>MNTH_31</StringArray2>
      </InitiationDayOptions>
      <InstallmentOccurrence>RCUR</InstallmentOccurrence>
      <RMS>False</RMS>
      <TemplateId>NCDCT000000030</TemplateId>
      <TemplateName>DC Auth live test Usag</TemplateName>
      <TrackingDayCode>01 Day tracking</TrackingDayCode>
      <TrackingIndicator>Y</TrackingIndicator>
      <ErrorCode>000</ErrorCode>
    </DebiCheckMandateTemplateDetail>
  </MethodParameters>
</DebiCheckRetrieveMandateTemplateDetail>

 

Output

  • Adjustment amount
  • Adjustment category
  • Adjustment rule indicator
  • Adjustment type
  • Authentication type
  • Collection frequency
  • Collection frequency day code (see codes here)
  • Debit entry class code
  • Debit value type
  • Debtor auth code (TT2 | TT1 )
  • Debtor authentication required
  • Initiation day options array
  • Instalment occurrence
  • RMS (Yes/No)
  • Template Id
  • Template name
  • Tracking day code
  • Tracking indicator
  • Error code

Error Codes:

Code Description
100 Authentication
202 Item Not Found
200 General
000 Success

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.