Welcome to PayID, the universal payment identifier.
This project is not associated with PayID operated by NPP Australia Ltd. People in Australia are prohibited from using this project. See below for more details.
This is the reference implementation server for PayID, serving the PayID API. It uses TypeScript, a Node.js HTTP server, and a Postgres database.
By default, the server hosts the PayID Protocol, or Public API, on port 8080. It also hosts a second RESTful API on port 8081 for CRUD operations of PayIDs and associated addresses.
If you just want to experiment with PayID, you can easily spin up a local server using npm run devEnvUp which uses our local docker-compose.yml file. If you want to work on the PayID server source code itself, you can spin up a Postgres database to develop against using npm run devDbUp.
To clean up the associated Docker containers, you can run npm run devDown.
By using, reproducing, or distributing this code, you agree to the terms and conditions for use (including the Limitation of Liability) in the Apache License 2.0. If you do not agree, you may not use, reproduce, or distribute the code. This code is not authorised for download in Australia. Any persons located in Australia are expressly prohibited from downloading, using, reproducing or distributing the code. This code is not owned by, or associated with, NPP Australia Limited, and has no sponsorship, affiliation or other connection with the “Pay ID” service operated by NPP Australia Limited in Australia.