{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"f4d92da1-ec82-4e8d-80b5-e40676a0a0fe","name":"PNZ API Centre Sandbox","description":"API Centre Sandbox Postman Collection Version: 2.8.0\n\nThis Postman collection is designed to support your development against the [Payments NZ API Centre sandbox](https://developer.apicentre.middleware.co.nz). The sandbox, powered by [Glueware](https://glueware.co.nz), is a dedicated environment that mimics an API Provider, as defined in the [Payments NZ API Centre standards](https://paymentsnz.atlassian.net/wiki/spaces/PaymentsNZAPIStandards/overview).\n\n## Getting Started\n\nBefore you run any Sandbox requests, you will need to do the following:\n\n1. Register an application in the [Sandbox](https://developer.apicentre.middleware.co.nz/)\n    \n2. Set or update the following variables in the collection to reflect this registered application:\n    \n    1. `e_clientId` - The client ID assigned when you registered your client application on the Sandbox Developer Portal. The collection assumes this client has scopes `openid accounts payments` and account access consents permissions (e.g. `ReadOffers`, `ReadScheduledPaymentsBasic`, etc.).\n        \n    2. `e_thirdPartyRedirectUri` - One of the callback URIs registered for your client application. Example: `http://localhost`\n        \n    3. `e_clientKid` - The key ID (KID) for the public key.\n        \n    4. `e_clientPrivateKey` - The private key associated with the public key. (Single line format, no newline/escape characters.) Example: `-----BEGIN RSA PRIVATE KEY-----MIIEpA...5KTA==-----END RSA PRIVATE KEY-----`\n        \n    5. `e_apiVersion` - The PNZ API Centre Standards version you wish to use. Example: `v2.3`\n        \n    6. Note: There are many other variables defined in the collection, but these should already be set-up for the Sandbox or will be set to appropriate values as you run through the collection.\n        \n3. Test your setup by sending the following requests:\n    \n    1. `01.1 - Well-Known OpenID Configuration` to confirm connectivity with the sandbox endpoints.\n        \n    2. `03.1 - Get Customers and Accounts` to confirm your keys are set up correctly. (Most failures at this stage are likely due to a mismatch between what is configured in Postman and what is registered on the Sandbox, or invalid signing keys)\n        \n4. Review the response from `03.1 - Get Customers and Accounts` as this is your set of customers and their accounts for you to use when testing with the sandbox. These customers and accounts are not shared with any other applications.\n    \n\n## Folders\n\nThe collection includes a number of folders.\n\nFolders beginning with `OIDC` include endpoints that are defined in the Open ID Connect suite of standards, on which the PNZ API Centre Security Profile is based.\n\nFolders beginning with `PNZ` include endpoints defined in the PNZ API Centre NZ Banking Data API specification, as well as the Account Information, Payment Initiation and Event Notification APIs.\n\nFolders beginning with `Sandbox` include endpoints that are NOT defined in the PNZ API Centre standards. They are utilities for Third Parties to retrieve and manipulate their test data in the sandbox.\n\n## Variables\n\nThe collection uses three types of variables - collection variables, environment variables and temporary variables. Collection variables are URLs or constants that you should never change. The environment variables are the variables you can personalise for your application. The temporary variables are created as you step through the requests and are cleaned up using the request in the Collection Utilities folder.\n\nNaming conventions for variables are as follows:\n\n`x_variableName`\n\nWhere x is one of\n\n- `c` indicates the variable is a collection variable. You should not have to change these values.\n    \n- `e` indicates the variable is an environment variable. You should set these values for your local instance of postman.\n    \n- `t` indicates the variable is a temporary variable. These values will be set as you run through the collection.\n    \n\ne.g.`c_host`, `e_clientId`, `t_clientCredentialsAccessToken`\n\nTo view the current state of a temporary or environment variable, click on the environment quick look button. To view the current state of a collection variable, edit the collection and click on the Variables tab.\n\n## Getting Help\n\nThis collection is provided by Middleware New Zealand (MWNZ), the provider of the Payments NZ API Centre Sandbox. If you have any questions or issues, please contact us at [apicentre@middleware.co.nz](https://mailto:apicentre@middleware.co.nz).","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"7280292","team":374875,"collectionId":"f4d92da1-ec82-4e8d-80b5-e40676a0a0fe","publishedId":"2sB3QMKUa4","public":true,"publicUrl":"https://postman.apicentre.middleware.co.nz","privateUrl":"https://go.postman.co/documentation/7280292-f4d92da1-ec82-4e8d-80b5-e40676a0a0fe","customColor":{"top-bar":"00a4ea","right-sidebar":"303030","highlight":"00a4ea"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":"PNZ API Centre Open Banking Postman Collection"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"00a4ea"}},{"name":"light","logo":null,"colors":{"top-bar":"00a4ea","right-sidebar":"303030","highlight":"00a4ea"}}]}},"version":"8.10.1","publishDate":"2025-10-12T20:36:19.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"PNZ API Centre Open Banking Postman Collection","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"PNZ API Centre Sandbox","id":"960b49a1-4021-4e1c-abdc-7920936595b3","owner":"7280292","values":[{"key":"e_clientId","value":"","type":"default","enabled":true,"description":"Third Party client identifier (See also RFC6749 §2.2)"},{"key":"e_clientKid","value":"","type":"default","enabled":true,"description":"Third Party signing key id (See also RFC7515 §4.1.4)"},{"key":"e_clientPrivateKey","value":"","type":"default","enabled":true,"description":"Third Party RSA signing key, used for signing JWTs. (See also RFC8017 §3.2)"},{"key":"e_thirdPartyRedirectUri","value":"","type":"default","enabled":true,"description":"The Third Party authorization redirection endpoint (See RFC6749 §3.1.2)"},{"key":"e_consentType","value":"aac","type":"default","description":"The consent type to be used. Can be one of 'aac', 'dpc', or 'epc'. (Only required for Postman runner)"},{"key":"e_authFlow","value":"decoupled","type":"default","description":"The authorization flow to be used. Can be one of 'hybrid', 'decoupled', or 'code' (Only required for Postman runner)"},{"key":"e_scope","value":"openid accounts payments","type":"default","description":"The authorization access token scope to be used for accessing resources"},{"key":"e_loginHintSubjectType","value":"phone","type":"default","description":"The decoupled authorization flow login_hint_token subject type to use"},{"key":"e_thirdPartyEventCallbackUrl","value":"{{c_host}}/private-banking-nz/open-banking-nz/v3.0/callback/event-notifications","type":"default","description":"The Third Party event notification callback endpoint"},{"key":"e_username","value":"user02","type":"default","description":"The default PNZ sandbox user (Used for authenticating to the Sandbox model bank)"},{"key":"e_password","value":"password","type":"default","description":"The default PNZ sandbox user password (Used for authenticating to the Sandbox model bank)"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/9fbdad7f2a0d008e53c9ef6ff3960d79ff0c39440da0cb1342ece950f0aac053","favicon":"https://res.cloudinary.com/postman/image/upload/v1724923755/team/05bb55f633628def40819f94bbc7efad.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"PNZ API Centre Sandbox","value":"7280292-960b49a1-4021-4e1c-abdc-7920936595b3"}],"canonicalUrl":"https://postman.apicentre.middleware.co.nz/view/metadata/2sB3QMKUa4"}