### Synchronous Web Service Request Example (C#) Source: https://api.netcash.co.za/netcash-programmers-guide-v2 Demonstrates how to make a synchronous web service call to Netcash using C#. This method expects an immediate response within the same session. It's suitable for single requests. ```csharp public string BatchFileUpload(string ServiceKey, string File) { // Implementation details for calling the web service // This is a placeholder for the actual method signature. return ""; } ``` -------------------------------- ### Handle Postback Responses - ASHX Source: https://api.netcash.co.za/netcash-programmers-guide-v2 Example of an ASHX handler for receiving asynchronous postback responses from Netcash services. It should process POST form data. ```ashx public class YourHandler : IHttpHandler { public void ProcessRequest (HttpContext context) { // Process POST data here context.Response.ContentType = "text/plain"; context.Response.Write("OK"); } public bool IsReusable { get { return false; } } } ``` -------------------------------- ### Handle Postback Responses - PHP Source: https://api.netcash.co.za/netcash-programmers-guide-v2 Example of a PHP page for receiving asynchronous postback responses from Netcash services. It should process POST form data. ```php ``` -------------------------------- ### Asynchronous Web Service Response Handling (Polling) Source: https://api.netcash.co.za/netcash-programmers-guide-v2 Illustrates the concept of polling for responses from asynchronous Netcash web services. When a postback URL is not provided, the system must poll the Netcash queue using a file token to retrieve results. This example outlines the expected response when data is not yet ready. ```text If the load report or response file is not yet available, the web service returns "FILE NOT READY" ``` -------------------------------- ### Handle Postback Responses - ASPX Source: https://api.netcash.co.za/netcash-programmers-guide-v2 Example of an ASPX page handler for receiving asynchronous postback responses from Netcash services. It should process POST form data. ```aspx <%@ Page Language="C#" AutoEventWireup="true" CodeFile="YourHandler.aspx.cs" Inherits="YourHandler" %> ``` -------------------------------- ### GET /NIWS/polling_queue Source: https://api.netcash.co.za/netcash-programmers-guide-v2 Retrieves the result of an asynchronous request using a file token when no postback URL is provided. ```APIDOC ## GET /NIWS/polling_queue ### Description Polls the Netcash queue to retrieve the load report or response file associated with a previously submitted file token. ### Method GET ### Parameters #### Query Parameters - **FileToken** (string) - Required - The GUID returned by the initial asynchronous request. ### Response #### Success Response (200) - **Data** (string) - The processed response file or load report. #### Error Response (200) - **Message** (string) - Returns "FILE NOT READY" if the processing is still in progress. ``` -------------------------------- ### POST /NIWS/niws_nif.svc Source: https://api.netcash.co.za/netcash-programmers-guide-v2 The NIWS_NIF entry point supports asynchronous file uploads, allowing multiple transactions to be processed in a single call. It requires a postback URL or polling to retrieve results. ```APIDOC ## POST /NIWS/niws_nif.svc ### Description Submits a Netcash Integration File (NIF) for asynchronous processing. The service returns a file token (GUID) which is used to poll for results or identify the postback response. ### Method POST ### Endpoint https://ws.netcash.co.za/NIWS/niws_nif.svc ### Parameters #### Request Body - **ServiceKey** (string) - Required - The unique key for authenticating the calling application. - **File** (string) - Required - The tab-delimited NIF formatted string containing transaction data. ### Request Example BatchFileUpload("YOUR_SERVICE_KEY", "TAB_DELIMITED_FILE_CONTENT") ### Response #### Success Response (200) - **FileToken** (string) - A GUID used to uniquely identify the report for polling. #### Response Example "550e8400-e29b-41d4-a716-446655440000" ``` -------------------------------- ### Retrieve Upload Report - C# Source: https://api.netcash.co.za/netcash-programmers-guide-v2 Retrieves the upload load report using the file token. This method requires a valid service key and file token. ```csharp public string RequestFileUploadReport(string ServiceKey, string FileToken) ``` -------------------------------- ### Payment and Subscription Reference Fields Source: https://api.netcash.co.za/netcash-programmers-guide-v2 Details the fields used for payment references, Pay Now transaction configuration, and subscription scheduling. ```APIDOC ## POST /api/payments/process ### Description Processes a payment request including optional subscription details, split payment logic, and notification settings. ### Method POST ### Parameters #### Request Body - **253** (AN50) - Required - Unique Pay Now reference (p2). - **255** (A1) - Optional - Send SMS for Pay Now Invoice (Y/N). - **259** (N1) - Optional - Subscription indicator (0=None, 1=Subscription). - **262** (N8) - Optional - Subscription start date (CCYYMMDD). - **264** (N1) - Optional - Split payment indicator (0=No, 1=Yes). ### Request Example { "253": "TXN123456789", "255": "Y", "259": 1, "262": "20231201" } ### Response #### Success Response (200) - **status** (string) - Indicates successful processing of the payment request. ``` -------------------------------- ### Retrieve Credit Data Report - C# Source: https://api.netcash.co.za/netcash-programmers-guide-v2 Retrieves the base64 encoded PDF credit data report using the file token. Requires a valid service key and file token. ```csharp public string RequestCreditDataReport(string ServiceKey, string FileToken) ``` -------------------------------- ### Retrieve AVS Report - C# Source: https://api.netcash.co.za/netcash-programmers-guide-v2 Retrieves the AVS (Address Verification System) report as a string array using the file token. Requires a valid service key and file token. ```csharp public string RequestAVSReport(string ServiceKey, string FileToken) ``` -------------------------------- ### Handle File Structural Error Response Source: https://api.netcash.co.za/netcash-programmers-guide-v2 Displays the format of a response when a file is rejected due to structural issues, such as a malformed header record. ```text ###BEGIN My Test Batch UNSUCCESSFUL 03:45 PM ###ERROR File is malformed, header record could not be identified ###END 03:45 PM ``` -------------------------------- ### NIWS_NIF - Postback Response Handling Source: https://api.netcash.co.za/netcash-programmers-guide-v2 Details on how Netcash sends responses back to a provided postback URL for asynchronous services. ```APIDOC ## Handling Postback Responses ### Description When a postback URL is provided during an asynchronous service call, Netcash will POST the transaction results to that URL. This section describes the parameters sent and the expected response from the receiving system. ### Endpoint [Your provided Postback URL] ### Method POST ### Parameters (POST data) | Entry Point | Polling Id | File (Format) | Account Reference | |--------------------|------------|-----------------|-------------------| | `uploadreport` | string | tab delimited | No | | `creditdatareport` | string | base64 encoded | Yes | | `avsdatareport` | string | tab delimited | No | ### Expected Response from Client To acknowledge successful receipt of the postback data, the receiving system must respond with `OK` to the URL. If `OK` is not received, Netcash will retry the postback. ### Retry Mechanism - First two retries: Immediate. - Subsequent retries: 30-second delay. - Further retries: 10-minute intervals, up to a maximum of 10 retries. **Note:** Even with a postback URL, reports are still available via the polling queue using the file token. ``` -------------------------------- ### Services Source: https://api.netcash.co.za/netcash-programmers-guide-v2 Defines fields for selecting various services offered by Netcash. ```APIDOC ## Services ### Description Allows selection of various Netcash services, such as debit order collections, creditor payments, and more. ### Parameters #### Request Body - **debit_order_collections** (N1) - Optional - Numeric, 1 digit. (0: not requested, 1: requested). - **creditor_payments** (N1) - Optional - Numeric, 1 digit. (0: not requested, 1: requested). - **salary_payments** (N1) - Optional - Numeric, 1 digit. (0: not requested, 1: requested). - **risk_reports** (N1) - Optional - Numeric, 1 digit. (0: not requested, 1: requested). - **pay_now** (N1) - Optional - Numeric, 1 digit. (0: not requested, 1: requested). - **resubmit_unpaids_via_pay_now** (N1) - Optional - Numeric, 1 digit. (0: not requested, 1: requested). Note: This field cannot be used for Masterpass or Visa checkout as no token is returned for those transactions. ### Response #### Success Response (200) - **field_id** (string) - Description of the field. #### Response Example ```json { "message": "Service selections updated." } ``` ``` -------------------------------- ### Electronic Mandate Information Source: https://api.netcash.co.za/netcash-programmers-guide-v2 Configuration fields for setting up electronic mandates, including debit frequency, agreement dates, and AVS settings. ```APIDOC ## Electronic Mandate Information ### Description Settings for configuring electronic mandates, including scheduling, cancellation policies, and automated signature requests. ### Parameters - **530** (N1) - Required - Debit frequency (1-7) - **532** (AN4) - Required - Commencement day options (e.g., 05/15/25/LDOM) - **535** (AN50) - Required - Agreement reference number - **538** (N1) - Required - Request AVS (0/1) - **540** (N1) - Required - Send mandate for signature (0/1) ### Request Example { "530": 1, "532": "01/15/LDOM", "535": "REF12345", "538": 1, "540": 1 } ``` -------------------------------- ### Default Status Source: https://api.netcash.co.za/netcash-programmers-guide-v2 Defines fields for setting a default status for an account. ```APIDOC ## Default Status ### Description Allows setting a default action, type, and effective date for an account. ### Parameters #### Request Body - **default_action** (A1) - Required - Alphanumeric, 1 character. (A: Add, R: Remove, U: Update). - **default_type** (string) - Optional - Type of default. - **effective_date** (N8) - Required - Numeric, 8 digits in CCYYMMDD format. The date from which the default status is effective. - **account_number** (AN13) - Required - Alphanumeric, up to 13 characters. The account number that was defaulted. - **amount_owed** (N10) - Optional - Numeric, up to 10 digits. The default amount in cents. ### Response #### Success Response (200) - **field_id** (string) - Description of the field. #### Response Example ```json { "message": "Default status set successfully." } ``` ``` -------------------------------- ### Credit Data (Risk) Source: https://api.netcash.co.za/netcash-programmers-guide-v2 Defines fields for credit data and risk assessment. ```APIDOC ## Credit Data (Risk) ### Description Captures the reason code for credit enquiries, which is required by credit bureaus. ### Parameters #### Request Body - **reason_code** (N2) - Required - Numeric, 2 digits. The reason for which an enquiry was requested. (See table below for codes). ### Response #### Success Response (200) - **field_id** (string) - Description of the field. #### Response Example ```json { "message": "Credit data processed." } ``` ``` -------------------------------- ### Handle System Error Response Source: https://api.netcash.co.za/netcash-programmers-guide-v2 Displays the format of a response when a system error occurs during the parsing process, requiring contact with support. ```text ###BEGIN My Test Batch UNSUCCESSFUL 03:45 PM ###ERROR A system error has occurred. Contact Netcash (ZA) support ###END 03:45 PM ``` -------------------------------- ### Contact Details Source: https://api.netcash.co.za/netcash-programmers-guide-v2 Defines the fields for capturing contact phone numbers. ```APIDOC ## Contact Details ### Description Captures primary contact phone numbers for the account. ### Parameters #### Request Body - **phone_number** (N11) - Required - Numeric, 11 digits. Include dialing codes (e.g., 27117822349). - **fax_number** (N11) - Optional - Numeric, 11 digits. Include dialing codes (e.g., 27117822349). ### Response #### Success Response (200) - **field_id** (string) - Description of the field. #### Response Example ```json { "message": "Contact details updated." } ``` ``` -------------------------------- ### Address Details Source: https://api.netcash.co.za/netcash-programmers-guide-v2 Defines the fields related to physical and postal addresses. ```APIDOC ## Address Details ### Description Provides fields for capturing both physical and postal address information. ### Parameters #### Request Body - **physical_address_line_1** (AN50) - Required - Minimum 2, Maximum 50 characters. - **physical_address_line_2** (AN50) - Optional - Minimum 2, Maximum 50 characters. - **physical_address_line_3** (AN50) - Optional - Minimum 2, Maximum 50 characters. - **physical_suburb** (AN50) - Required - Minimum 2, Maximum 50 characters. - **physical_city** (AN50) - Required - Minimum 2, Maximum 50 characters. - **physical_postal_code** (N4) - Required - Numeric, 4 digits. - **physical_province** (N1) - Required - Numeric, 1 digit. (1: Western Cape, 2: Gauteng, 3: Eastern Cape, 4: Free State, 5: KwaZulu Natal, 6: Limpopo, 7: Mpumalanga, 8: Northern Cape, 9: North West) - **postal_address_line_1** (AN50) - Required - Minimum 2, Maximum 50 characters. - **postal_address_line_2** (AN50) - Optional - Minimum 2, Maximum 50 characters. - **postal_address_line_3** (AN50) - Optional - Minimum 2, Maximum 50 characters. - **postal_suburb** (AN50) - Required - Minimum 2, Maximum 50 characters. - **postal_city** (AN50) - Required - Minimum 2, Maximum 50 characters. - **postal_code** (N4) - Required - Numeric, 4 digits. - **postal_province** (N1) - Required - Numeric, 1 digit. (1: Western Cape, 2: Gauteng, 3: Eastern Cape, 4: Free State, 5: KwaZulu Natal, 6: Limpopo, 7: Mpumalanga, 8: Northern Cape, 9: North West) ### Response #### Success Response (200) - **field_id** (string) - Description of the field. #### Response Example ```json { "message": "Address details processed successfully." } ``` ``` -------------------------------- ### NIWS_NIF - RequestFileUploadReport Source: https://api.netcash.co.za/netcash-programmers-guide-v2 Retrieves the load report for a given file token. This method is part of the asynchronous file upload service. ```APIDOC ## POST /NIWS_NIF/RequestFileUploadReport ### Description Retrieves the load report associated with a file token from the NIWS_NIF service. This is used after an asynchronous file upload. ### Method POST ### Endpoint /NIWS_NIF/RequestFileUploadReport ### Parameters #### Query Parameters - **ServiceKey** (string) - Required - The service key issued by Netcash for authentication. - **FileToken** (string) - Required - The token received after initiating a file upload. ### Request Example ```json { "ServiceKey": "YOUR_SERVICE_KEY", "FileToken": "YOUR_FILE_TOKEN" } ``` ### Response #### Success Response (200) - **string** - A string representing the load report. The format of the report is typically tab-delimited. #### Response Example ``` TransactionID\tStatus\tResponseMessage\n12345\tSUCCESS\tFile processed successfully. ``` ``` -------------------------------- ### NIWS Web Service Validation and Response Source: https://api.netcash.co.za/netcash-programmers-guide-v2 Details on how the NIWS service validates incoming requests and the structure of the resulting tab-delimited load report. ```APIDOC ## NIWS Web Service Validation ### Description The NIWS web service performs initial validation on incoming method calls. If validation fails, specific error codes are returned before file parsing begins. ### Error Codes - **100** - Authentication failure (check service key). - **101** - Date format error (expected CCYYMMDD). - **102** - Parameter error. - **200** - General code exception. ## Load Report Structure ### Description Upon successful validation and parsing, the service returns a tab-delimited load report. ### Header - **Record identifier** (AN8) - ###BEGIN - **Batch name** (AN) - SUCCESSFUL / UNSUCCESSFUL / SUCCESSFUL WITH ERRORS - **Result of upload** (A13) - 100 - **Start time** (AN8) - HH:MM AM/PM ### Data Error Message - **Account reference** (AN58) - Acc Ref :{account reference} - **Line number** (AN) - Line :{line number} - **Error message** (A13) - The error message ### Trailer - **Record identifier** (AN6) - ###END - **End time** (AN8) - HH:MM AM/PM ### Response Example ###BEGIN My Test Batch SUCCESSFUL WITH ERRORS 03:45 PM Acc Ref: EMP001 Line :3 Invalid account number ###END 03:45 PM ``` -------------------------------- ### DebiCheck Entry Class Table Source: https://api.netcash.co.za/netcash-programmers-guide-v2 This table contains the list of Entry class codes for use in field 605. ```APIDOC ## DebiCheck Entry Class Table ### Description This table contains the list of Entry class codes for use in field 605. ### Codes - **0021** = Insurance Premium - **0022** = Pension Fund Contribution - **0023** = Medical Aid Fund Contribution - **0026** = Unit Trust Purchase - **0028** = Charitable or religious contributions - **0031** = H.P. Repayment - **0032** = Account Repayment - **0033** = Loan Repayment (other than Mortgage) - **0034** = Rental-Lease (other than Property) - **0035** = Service Charge (Maintenance of Service Agreements, etc.) - **0036** = Service Charge (Variable Amounts) - **0037** = Value Added Tax (Vat collection) - **0041** = Rent (Property) - **0042** = Bond Repayment ``` -------------------------------- ### DebiCheck Migration Data Fields Source: https://api.netcash.co.za/netcash-programmers-guide-v2 Specifications for fields required during the DebiCheck migration process, defining collection frequency, tracking, and adjustment rules. ```APIDOC ## DebiCheck Migration Fields ### Description Defines the parameters for migrating DebiCheck mandates, including installment occurrence, collection frequency, and adjustment logic. ### Parameters - **601** (A4) - Required - Installment occurrence (OOFF/RCUR) - **602** (N1) - Required - Tracking indicator (0/1) - **603** (N8) - Required - Initiation date (CCYYMMDD) - **604** (N) - Required - Maximum collection amount in cents - **607** (AN) - Required - Collection frequency (e.g., Weekly, MNTH, YEAR) - **613** (A11) - Required - Debit value type (FIXED/VARIABLE/USAGE BASED) ### Request Example { "601": "RCUR", "602": 1, "603": "20231001", "604": 50000, "607": "MNTH" } ``` -------------------------------- ### Data Field Definitions Source: https://api.netcash.co.za/netcash-programmers-guide-v2 Overview of the data structures and field definitions used for Netcash API requests. ```APIDOC ## Data Field Reference ### Description This reference outlines the fields used for client management, consumer/commercial verification, and payment processing within the Netcash system. ### Client Identifiers - **101** (AN22) - Account reference: Unique identifier for the client. - **102** (AN20) - Account name: Display name of the client account. - **103** (N1) - Account active: 0 = Inactive, 1 = Active. ### Consumer Details - **110** (N1) - IsConsumer: 0 = Company, 1 = Individual. - **111** (N13) - ID number: South African identity number. - **117** (N8) - Date of birth: Format CCYYMMDD. ### Commercial Details - **121** (AN) - Trading name: Business name. - **122** (AN) - Registration number: Entity registration number. - **125** (N2) - Legal Entity: Numeric code representing the business structure (e.g., 1 = Pty Ltd). ### Banking Details - **131** (N1) - Banking detail type: 1 = Bank account, 2 = Credit card, 9 = Public beneficiary. #### Bank Account (Field 131=1) - **132** (AN15) - Bank account name - **133** (N1) - Bank account type (1=Current, 2=Savings) - **134** (N6) - Bank account branch code - **136** (N11) - Bank account number #### Credit Card (Field 131=2) - **132** (AN20) - Credit card holder - **133** (N1) - Credit card type (1=MasterCard, 2=Visa) - **136** (AN36) - Credit card token ### Response Example { "field_101": "CLIENT001", "field_103": 1, "field_131": 1, "field_132": "John Doe", "field_136": "12345678901" } ``` -------------------------------- ### NIWS_NIF - RequestCreditDataReport Source: https://api.netcash.co.za/netcash-programmers-guide-v2 Retrieves the Risk Reports in base64 encoded PDF format using a file token. This is part of the asynchronous service. ```APIDOC ## POST /NIWS_NIF/RequestCreditDataReport ### Description Retrieves the Risk Report (Credit Data Report) as a base64 encoded PDF file. This method uses the file token obtained from an initial upload. ### Method POST ### Endpoint /NIWS_NIF/RequestCreditDataReport ### Parameters #### Query Parameters - **ServiceKey** (string) - Required - The service key for authentication. - **FileToken** (string) - Required - The token associated with the uploaded file. ### Request Example ```json { "ServiceKey": "YOUR_SERVICE_KEY", "FileToken": "YOUR_FILE_TOKEN" } ``` ### Response #### Success Response (200) - **string** - A base64 encoded string representing the PDF report. #### Response Example ``` JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PC9UeXBlL0NhdGFsb2cvUGFnZXMgMiAwIFI+PgplbmRvYmoKCjIgMCBvYmoKPDwvVHlwZS9QYWdlcy9Db3VudCAxL0tpZHNbMyAwIFJdPj4KZW5kb2JqCgozIDAgb2JqCjw8L1R5cGUvUGFnZS9NZWRpYUJveCBbMCAwIDYxMiA3OTJdL1Jlc291cmNlczw8L0ZvbnQ8PC9GMSA0IDAgUj4+Pj4vQ29udGVudHMgNSAwIFI+PgplbmRvYmoKCjQgMCBvYmoKPDwvVHlwZS9Gb250L0ZhbWlseS9IZWx2ZXRpY2EvU3VidHlwZS9UeXBlMS9CYXNlRm9udC9IZWx2ZXRpY2E+PgplbmRvYmoKCjUgMCBvYmoKPDwvVHlwZS9QYWdlcy9Db3VudCAxL0tpZHNbMyAwIFJdPj4+CgplbmRvYmoKCjYgMCBvYmoKPDwvVHlwZS9NZXRhZGF0YS9Qcm9kdWNlcihQREYgV2l6YXJkKT4+CgplbmRvYmoKCnhyZWYKMCAxMCAwMDAwMCAwMDAwMCBlbHNlCjAwMDAwMDAwMTUgMDAwMDAgbiAKMDAwMDAwMDA2MiAwMDAwMCBuIAowMDAwMDAwMTEwIDAwMDAwIG4gCjAwMDAwMDAxNjAgMDAwMDAgbiAKMDAwMDAwMDIxMCAwMDAwMCBuIAowMDAwMDAwMjYwIDAwMDAwIG4gCjAwMDAwMDAzMTIgMDAwMDAgbiAKdHJhaWxlcgo8PC9TaXplLzcvUm9vdCAxIDAgUgovSW5mbyA2IDAgUj4+CnN0YXJ0eHJlZgo0MzkKJSVFT0YK ``` ``` -------------------------------- ### Consumer References Source: https://api.netcash.co.za/netcash-programmers-guide-v2 Defines fields for capturing consumer reference phone numbers. ```APIDOC ## Consumer References ### Description Captures phone numbers for consumer references. ### Parameters #### Request Body - **subject_telephone_1** (N11) - Optional - Numeric, 11 digits. Phone number of the first consumer reference. Include dialing codes (e.g., 27117822349). - **subject_telephone_2** (AN) - Optional - Alphanumeric. Phone number of the second consumer reference. Include dialing codes (e.g., 27117822349). ### Response #### Success Response (200) - **field_id** (string) - Description of the field. #### Response Example ```json { "message": "Consumer references updated." } ``` ``` -------------------------------- ### Custom Metadata and Grouping Source: https://api.netcash.co.za/netcash-programmers-guide-v2 Defines fields for grouping entities and attaching custom user-defined data to transactions or masterfile records. ```APIDOC ## PUT /api/masterfile/update ### Description Updates masterfile records with custom user-defined fields and group associations. ### Method PUT ### Parameters #### Request Body - **281** (AN2) - Required - Debit masterfile group ID. - **301** (AN999) - Optional - Extra 1: Custom user-defined data. - **311** (AN50) - Optional - Field 1: Custom data for client master file. ### Request Example { "281": "G1", "301": "Internal_Ref_001", "311": "Custom_Tag_A" } ### Response #### Success Response (200) - **message** (string) - Confirmation of masterfile update. ``` -------------------------------- ### Trade References Source: https://api.netcash.co.za/netcash-programmers-guide-v2 Defines fields for capturing trade reference information for up to three companies. ```APIDOC ## Trade References ### Description Collects details for up to three trade references, including company name, contact person, and phone number. ### Parameters #### Request Body - **trade_name_1** (AN50) - Optional - Alphanumeric, up to 50 characters. Name of the first trade reference company. - **trade_contact_1** (AN50) - Optional - Alphanumeric, up to 50 characters. Name of the contact person at the first trade reference company. - **trade_telephone_1** (N11) - Optional - Numeric, 11 digits. Phone number of the first trade reference company. Include dialing codes (e.g., 27117822349). - **trade_name_2** (AN50) - Optional - Alphanumeric, up to 50 characters. Name of the second trade reference company. - **trade_contact_2** (AN50) - Optional - Alphanumeric, up to 50 characters. Name of the contact person at the second trade reference company. - **trade_telephone_2** (N11) - Optional - Numeric, 11 digits. Phone number of the second trade reference company. Include dialing codes (e.g., 27117822349). - **trade_name_3** (AN50) - Optional - Alphanumeric, up to 50 characters. Name of the third trade reference company. - **trade_contact_3** (AN50) - Optional - Alphanumeric, up to 50 characters. Name of the contact person at the third trade reference company. - **trade_telephone_3** (N11) - Optional - Numeric, 11 digits. Phone number of the third trade reference company. Include dialing codes (e.g., 27117822349). ### Response #### Success Response (200) - **field_id** (string) - Description of the field. #### Response Example ```json { "message": "Trade references updated." } ``` ``` -------------------------------- ### NIWS_NIF - RequestAVSReport Source: https://api.netcash.co.za/netcash-programmers-guide-v2 Retrieves the Account Verification Service (AVS) report as a string array. This is used with asynchronous services. ```APIDOC ## POST /NIWS_NIF/RequestAVSReport ### Description Retrieves the Account Verification Service (AVS) report. The response is returned as a string array, typically tab-delimited. ### Method POST ### Endpoint /NIWS_NIF/RequestAVSReport ### Parameters #### Query Parameters - **ServiceKey** (string) - Required - The service key for authentication. - **FileToken** (string) - Required - The token associated with the uploaded file. ### Request Example ```json { "ServiceKey": "YOUR_SERVICE_KEY", "FileToken": "YOUR_FILE_TOKEN" } ``` ### Response #### Success Response (200) - **string[]** - An array of strings representing the AVS report data, usually tab-delimited. #### Response Example ``` ["Account\tStatus\tReasonCode", "123456789\tMATCH\t00"] ``` ``` -------------------------------- ### DebiCheck Ad Hoc Table Source: https://api.netcash.co.za/netcash-programmers-guide-v2 This table contains the list of Ad Hoc Collection Frequency Codes for use in field 607. ```APIDOC ## DebiCheck Ad Hoc Table ### Description This table contains the list of Ad Hoc Collection Frequency Codes for use in field 607. ### Codes - **ADHO** = Monthly by rule - **01** = Last Monday - **02** = Last Tuesday - **03** = Last Wednesday - **04** = Last Thursday - **05** = Last Friday - **06** = Last Saturday - **07** = First Monday - **08** = First Tuesday - **09** = First Wednesday - **10** = First Thursday - **11** = First Friday - **12** = First Saturday - **13** = Last day - **14** = 2nd Last day ``` -------------------------------- ### DebiCheck Collection Day Codes Source: https://api.netcash.co.za/netcash-programmers-guide-v2 This table contains the list of Collection Day Frequency codes for use in field 250. ```APIDOC ## DebiCheck Collection Day Codes ### Description This table contains the list of Collection Day Frequency codes for use in field 250. ### Codes #### Weekly - **WEEK_01** = Weekly Monday - **WEEK_02** = Weekly Tuesday - **WEEK_03** = Weekly Wednesday - **WEEK_04** = Weekly Thursday - **WEEK_05** = Weekly Friday - **WEEK_06** = Weekly Saturday - **WEEK_07** = Weekly Sunday #### Fortnightly - **FRTN_01** = Fortnightly First Monday - **FRTN_02** = Fortnightly First Tuesday - **FRTN_03** = Fortnightly First Wednesday - **FRTN_04** = Fortnightly First Thursday - **FRTN_05** = Fortnightly First Friday - **FRTN_06** = Fortnightly First Saturday - **FRTN_07** = Fortnightly First Sunday - **FRTN_08** = Fortnightly Second Monday - **FRTN_09** = Fortnightly Second Tuesday - **FRTN_10** = Fortnightly Second Wednesday - **FRTN_11** = Fortnightly Second Thursday - **FRTN_12** = Fortnightly Second Friday - **FRTN_13** = Fortnightly Second Saturday - **FRTN_14** = Fortnightly Second Sunday #### Monthly - **MNTH_01** to **MNTH_31** = Monthly 1 to 31 #### Quarterly - **QURT_01** to **QURT_31** = Quarterly 1 to 31 #### Biannually - **MIAN_01** to **MIAN_31** = Biannually 1 to 31 #### Yearly - **YEAR_01** = Yearly Annual #### Ad-hoc - **ADHO_01** = Ad-hoc Last Monday - **ADHO_02** = Ad-hoc Last Tuesday - **ADHO_03** = Ad-hoc Last Wednesday - **ADHO_04** = Ad-hoc Last Thursday - **ADHO_05** = Ad-hoc Last Friday - **ADHO_06** = Ad-hoc Last Saturday - **ADHO_07** = Ad-hoc First Monday - **ADHO_08** = Ad-hoc First Tuesday - **ADHO_09** = Ad-hoc First Wednesday - **ADHO_10** = Ad-hoc First Thursday - **ADHO_11** = Ad-hoc First Friday - **ADHO_12** = Ad-hoc First Saturday - **ADHO_13** = Ad-hoc Last day - **ADHO_14** = Ad-hoc 2nd last day ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.