node-payiota

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 10 Open GitHub ↗

This is the Payiota Payment Gateway

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# payiota

[![Version](https://img.shields.io/npm/v/payiota.svg)](https://www.npmjs.com/package/payiota) [![Downloads](https://img.shields.io/npm/dt/payiota.svg)](https://www.npmjs.com/package/payiota)

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

## :cloud: Installation

```sh
$ npm i --save payiota
```

## :clipboard: Example

```js
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)
})
```

## :question: Get Help

There are few ways to get help:

1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). 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. :bug:

## :memo: 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.

## :yum: How to contribute
Have an idea? Found a bug? See [how to contribute][contributing].

## :scroll: License

[license]: http://showalicense.com/?fullname=Andy%20Lisac%20%3Candy.lisac%40gmail.com%3E&year=2017#license-mit
[website]:
[contributing]: /CONTRIBUTING.md
[docs]: /DOCUMENTATION.md

node-payiota

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README