Table of Contents

• About the Project
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

PayPI makes API creators' lives easier by handling API keys, user accounts, payments and more. API users have one account to access all APIs using PayPI.

We worry about API authentication and payments so you can focus on making awesome APIs! This library enables you to interact with PayPI from a NodeJS project.

Getting Started

See full documentation here

1. Install PayPI:

Install paypi from npm or yarn:

yarn add paypi

npm install paypi

Then import it, create an instance with your private key and use it to authenticate and make charges against users:

import PayPI from "paypi";
import express from "express";

const app = express();
const port = 3000;
const paypi = new PayPI("<YOUR API SECRET>");

app.get("/", async (req, res) => {
  const subscriberSecret = req.get("Authentication");
  const user = await paypi.authenticate(subscriberSecret);

  // Do some processing, fetch response data, etc

  // Once request is going to go through, charge the user using a ChargeID.
  await user.makeCharge("cid-R4tfSt4");
  await user.makeCharge("cid-U7dhaf3", 34); // Dynamic charges need to be given unitsUsed.

  res.send("Hello World!");
});

app.listen(port, () => {
  console.log(`Example app listening at http://localhost:${port}`);
});

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

All contributions are welcome. Please follow this workflow:

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

All rights reserved.

Contact

Alex - [email protected]
Tom - [email protected]

Project Link: https://github.com/paypi/paypi-node

Acknowledgements

• Img Shields
• Choose an Open Source License