Pnz MCP Server

🚀 PaymentsNZ MCP Server

The PaymentsNZ MCP Server is a crucial component for integrating with specific services, enabling seamless data interaction and authentication.

🚀 Quick Start

📦 Installation

1. Install Node.js version 22 or higher. Check your current version using node --version.
2. Run cd sdk && npm install && cd ../mcp-server && npm install to build the SDK and the server.

💻 Usage Examples

Basic Usage

If you're unfamiliar with how to configure the MCP server to work with Claude Desktop, refer to this tutorial first.

Now, add the following to your Claude Desktop configuration:

{
  "mcpServers": {
    "PaymentsNZ": {
      "command": "node",
      "args": ["[YOUR-PATH-HERE]/paymentsnz-mcp-server/mcp-server/dist/index.js"],
      "env": {
        "ACCOUNT_AND_TRANSACTION_API_SPECIFICATION_LIB_ACCESS_TOKEN": "[YOUR-ACCESS-TOKEN-HERE]"
      }
    }
  }
}

A claude_desktop_config.json file is also provided for reference.

Make sure to set the path to where your MCP server is stored and use the access token you obtained during authentication in the environment variables.

📚 Documentation

How to Obtain an Access Token

1. Visit https://pnz-app.azurewebsites.net/.
2. Navigate to any endpoint, such as https://pnz-app.azurewebsites.net/#/typescript/api-endpoints/statements/get-account-statement.
3. Click GET AUTH TOKEN in the top - right corner of the page and wait for the pop - up to request consent.
4. Enter your username and password and approve all requests.
5. The access token should now be displayed on the authentication interface (see the image below). You can copy it to the environment variables in your claude_desktop_config.json file.

⚠️ Important Note

The access token is valid for no more than an hour. Make sure to use it in time.