payiota

A Node.js wrapper around the Payiota.me API.

☁️ Installation

$ npm i --save payiota

📋 Example

const PayiotaAPI = require("payiota");

const payiota = new PayiotaAPI("your api key")

// Create an invoice
payiota.buy({
    // You will have to take care
    // of encrypting this on your side
    // if you are concerned about security
	
    // Buy $42
    price: 42,
    custom: "some metadata",

}).then(res => {
    console.log("transaction created", res)
}).catch(err => {
    console.error(err)
})

// Update
payiota.buy({
    verification: verificationKey,
    address: "the address"
}).then(res => {
    console.log("new price of in IOTA's ", res)
}).catch(err => {
    console.error(err)
})

❓ Get Help

There are few ways to get help:

1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
2. For bug reports and feature requests, open issues. 🐛

📝 Documentation

Payiota(key)

A Node.js wrapper around the Payiota.me API.

Params

• String key: The Payiota API key.

buy(options)

Creates an invoice (address/price pair).

Params

• Object options: An object containing the following fields:
  • price (Number): The price in usd
  • custom (String): A custom string metadata about the transaction.
  • action (String): The transaction action. Use update for invoices for a later date.
  • address (String): The address of saved invoice.

Return

• Promise A promise resolving with the reponse from Payiota.me.

😋 How to contribute

Have an idea? Found a bug? See [how to contribute][contributing].

📜 License

MIT © [Andy Lisac][website]

[website]: [contributing]: /CONTRIBUTING.md [docs]: /DOCUMENTATION.md