↓Skip to main content
  1. Data Holder - Guides/
  2. Data Holder - PNZ - Guides/

Data Holder - PNZ - User Guide

Table of Contents

Wych Data Holder Platform: Payments New Zealand #

Welcome to the Wych Data Holder Platform. This guide outlines how to harness the platform’s features to ensure compliance with Payments NZ standards, streamline your account setup, and optimize data sharing. With its user-friendly interface and robust capabilities, the Wych Data Holder Platform ensures compliance with the Payments New Zealand version 2.3 standard while delivering seamless integration, operational efficiency, and enhanced data security.

Key Features #

  • Regulatory Compliance: Fully adheres to version 2.3 of the Payments New Zealand Banking Data standards, enabling secure, transparent, and efficient data sharing.
  • API-First Design: Integrates effortlessly into your existing infrastructure, saving time and resources.
  • Enterprise-Grade Security: Implements robust measures to safeguard sensitive customer data from breaches or unauthorized access.
  • Deployment Flexibility: Re-use your existing APIs and infrastructure to align with Payments New Zealand version 2.3+ standards, ensuring rapid and efficient integration, tailored to your organizational needs.
  • Advanced Monitoring Tools: Leverage real-time dashboards and alerts to manage and oversee data sharing activities effectively.

Step-By-Step Walkthroughs #

  1. Navigate to the Consent Management section from the main dashboard.
  2. Create or modify consent templates by specifying data types, user permissions, and retention policies.
  3. Save your configurations and test them using simulated scenarios or sample data.

Third-Party Onboarding #

How to Set Up and Manage a Business and Application

Create a Business Workspace #

To set up a new business workspace navigate to the your workspace. If this is your first business you will arrive directly to the workspace, if not you will be presented with a list of existing workspaces. You can select create to begin.

Step 1.1: Create Business Type

Then follow these steps:

  1. Select the Business Type
    At the top of the form, choose the applicable business category:

    • AU Business (for Australian businesses)
    • NZ Business (for New Zealand businesses)
    • International (for businesses outside Australia and New Zealand)

    Step 1.1: Select Business Type

  2. Fill Out Business Information
    Populate the required fields under the “Business Information” section:

    • NZBN (New Zealand Business Number): Enter your business’s NZBN (e.g., 123412341234).
    • Legal Name: Input the full legal name of the business (e.g., Test Business Limited).
    • Registered Address: Provide the official registered address (e.g., 123 main street, one town).

    Step 1.2: Fill Business Information

  3. Fill Out Displayed Information
    Under the “Displayed Information” section:

    • Trading Name: Enter the business’s trading name (e.g., Test Business).
    • Website: Input the business website URL (e.g., www.example.com).

    Step 1.3: Displayed Information

  4. Review and Save
    Double-check the information for accuracy, then click create proceed to save and continue to the next step in your workspace setup.

    Step 1.4: Save Workspace

Create an Application for the Business #

Once a business workspace is created, you can set up an application associated with that business.

  1. Navigate to the Application Setup Page

    • Choose the appropriate tab (e.g., Recipient or Dataholder) based on the application’s purpose.
    • Ensure you’re in the Recipient tab for creating a recipient application.

    Step 2.1: Navigate to Application Setup

  2. Fill Out Application Details
    Populate the required fields:

    • Application Name: Provide a unique and descriptive name for the application.
    • Application Purpose: Enter a brief description of the application’s purpose or functionality.
    • Product URL: Add the URL that links to the product or service (if applicable).

    Step 2.3: Create Application

  3. Review and Save

    • Once all fields are completed, ensure all details are correct before finalizing the creation of the application.
    • Click the Create button at the bottom of the form.

    Step 2.4: Review and Save

Managing a Business Workspace #

Finding a Business #

  1. Navigate to the Workspaces page from the left-side menu.

  2. Use the search bar at the top of the page to search by:

    • Business legal name
    • Trading name
    • Country
    • Business number

  3. Filter the workspaces using the categories dropdown (e.g., “All Categories”).

  4. Once you locate the business, click its name (e.g., “Test Business Limited”) to view its details.

    Find and Select a Business

Viewing Business Details #

  1. After selecting a business, the Business Details panel is displayed.

  2. This panel includes:

    • Legal Name: The registered legal name of the business.
    • Trading Name: The operational name of the business.
    • Business Number: e.g., NZBN, ABN, or another identifier.
    • Registered Address: The official registered business address.
    • URL: Website link for the business.

    Business Details View

Editing a Business #

  1. From the Business Details page, locate the edit icon in the top right of the “Business Details” section.

  2. Click the edit icon to modify the following fields:

    • Legal Name
    • Trading Name
    • Registered Address
    • Business Number
    • URL

  3. Save your changes by clicking the Save button.

    Edit Business Details

Managing an App #

Finding an App #

  1. Navigate to the selected business’s Apps by selecting the menu item below overview in the left hand menu.

  2. In the App List, search for an app by:

    • Name
    • Type (e.g., Recipient or Dataholder)
    • Status (e.g., Active)

  3. You can also use the categories dropdown and search bar for filtering.

    Find and Select an App

Viewing App Details #

  1. Once an app is selected, the App Details page is displayed, including:

    • App Name
    • External ID
    • Success Redirect URL
    • Partner ID
    • App ID
    • API Key
    • Client ID
    • Client Secret

  2. Useful links such as API Docs and Product Guide are also available.

    App Details View

Editing an App #

  1. On the App Details page, locate the edit icon next to the fields you wish to modify (e.g., App Name or Success Redirect URL).

  2. Update the necessary fields and click Save to apply the changes.

  3. Confirm the updates by verifying the details in the overview.

    Edit App Details

Client Management #

Finding a Client for an App #

  1. Navigate to the Clients tab from the left-side menu.

  2. Use the search bar at the top of the screen to search by:

    • Client ID
    • Client Name

  3. Filter clients using the categories dropdown (e.g., “All Categories”).

    Tip: Use the client id or name filters to quickly find your results.

    Find a client

Creating a New Client #

To create a new client:

  1. Access the Clients Tab

    • Navigate to the Clients tab in the left-hand menu.

  2. Initiate Client Creation

    • Click the Create button on the right-hand side of the screen.

    Create Client Button

  3. Select Client Type

    • Choose between the two client types available:
      • JWT (JSON Web Token): Select if using token-based authentication.
      • Secret: Select if using a client secret for authentication.

    Select Client Type

  4. Fill Out Client Details

    • Enter the following required information:
      • Secret: Provide a secure secret key (for Secret type).
      • Client Name: Input a descriptive name for the client.

    Fill Out Client Details
    Fill Out Client Details

  5. Assign Client Access Permissions

    • Select the appropriate permissions for the client by toggling the options under Client Access sample client permissions include:
      • App Administration
      • Account Administration
      • User Administration
      • Connection Administration
      • Dataholder Administration
      • Insight Administration
      • Read Users
      • Read Accounts
      • Read Balances
      • Read Transactions
      • Read Connections
      • Read Dataholder Configuration
      • Read Insights

    Note: Enable only the permissions required for the client to minimize unnecessary access.

    Assign Permissions

  6. Finalize and Save

    • Review the provided details for accuracy.
    • Click the Create button at the bottom of the form to finalize the setup.

    Create Client Confirmation

Managing Existing Clients #

Viewing Client Details #

  1. From the Clients tab, locate the desired client using the search bar or filters.

  2. Click on the client’s name to view its details, such as:

    • Client ID
    • Client Type
    • Client Secret Type
    • Assigned Permissions

    Tip: Use the details page to quickly review or update client information.

Editing a Client #

  1. Open the client details page by selecting a client.
  2. Locate the edit icon next to the field you want to modify.
  3. Make the necessary changes and click Save to apply.

For any questions, contact Wych support via email or refer to the documentation links provided in the Contact Support section.

Additional Information #

  1. User Roles

Contact Support #

For any queries or assistance, please reach out to our support team:

Thank you for selecting the Wych Data Holder Platform. We are committed to helping you achieve seamless data sharing and compliance with Payments NZ version 2.3 standards, supported by unmatched innovation and customer service.