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

Data Holder - PNZ - Comprehensive Customer 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.

Getting Started #

1. Account Setup #

  1. Reach out to your Wych account manager to initiate the onboarding process.
  2. Submit the necessary business documentation for verification and approval.
  3. Receive your personalized login credentials and API keys to access the platform.

2. Platform Access #

Use the provided credentials to log in to the platform at nz.partner.wych.app.

Configuration Steps #

1. Connect to Your Systems #

  • Utilize the API documentation to integrate your internal data sources with the Wych Data Holder Platform.
  • Access your admin app console to retrieve your credentials, which include:
    • Partner ID: Identifies your business.
    • App ID: Identifies your app.
    • API Key: Used as the x-api-key header in API requests.
    • Client ID: Unique identifier for API client authentication.
    • Client Secret: secret key used for API client authentication.

consent panel

  • The API is available at nz.api.wych.io/.
  • To access the API, authenticate with your client ID and secret via the token endpoint found in the openid-configuration. The request is sent as a POST in x-www-form-urlencoded form containing:
    • client_Id & client_secret
    • grant_type of client_credentials

Consent journeys involve three parties:

  • Bank: The data holder.
  • Customer: The consenter.
  • TPP: The third-party participant, or the data recipient.

consent journey

The Wych platform facilitates the management of consent by the customer, the compliant sharing of customer data by the bank, and the retrieval of data by the TPP. The consent journey begins with the TPP initiating the process. The customer is directed to the Wych Consent service, which redirects them to the Data Holder’s customer authentication system using OpenID Connect (OIDC). Once the customer completes consent at the Data Holder, they return to the Wych Consent service to finalize the flow, choosing accounts to share or initiating payments.

For this flow to work, Wych requires two sets of information:

  1. for the Authentication to work we require connection details.
  2. If using client_assertion_jwt we also require client details.

Required Information for Connection #

  • Client ID: A unique identifier for the client application provided by the OIDC provider.
  • Client Secret: A secret key that authenticates your client, ideally client_assertion_jwt.
  • Redirect URI: The URI where the OIDC provider will send users after authorization (for flows requiring user interaction).
  • Scopes: Specify the required scopes, such as openid, profile, email, etc., that define the level of access the Wych application requires.
  • Response Type: Defines the type of response expected, such as code, id_token, or token.
  • Grant Type: Specifies the OIDC flow, such as authorization_code, client_credentials.

Required Information for Client #

  • Secret Resolution: Either the client secret or the JSON Web Key Set (JWKS) URL if using client assertion JWT
  • Valid Redirect URIs: URIs that are accepted in the initial auth request

Expected Responses #

Upon a successful connection, the following is typically returned:

  • ID Token: A JWT that includes claims about the authenticated user, like sub (subject identifier), name, email, etc.
  • Access Token: Used to access the resources associated with the user’s account. Its scope depends on the requested permissions.
  • Refresh Token (if applicable): Allows the client to obtain a new access token without re-authentication.
  • Discovery Document: If accessed directly, it provides OIDC server metadata such as authorization endpoint, token endpoint, and supported scopes, grants, and claims.

Log in to the Wych Data Holder Platform using your credentials.

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.

2. Third-Party Onboarding #

  1. Access the Third-Party Management module from the platform dashboard.
  2. Register new third parties by entering their business details, contact information, and API credentials.
  3. Assign specific permissions accountand/or payment and validate the integration.
  4. Approve the onboarding request and monitor progress via the dashboard.

3. Customer Support #

  1. Navigate to the Support Center from the help menu on the platform dashboard.
  2. Submit a support ticket by providing a detailed description of your issue or request.
  3. Monitor the status of existing tickets directly from the support interface.
  4. Utilize the live chat feature for immediate assistance during business hours.

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.

↑