Skip to content

Latest commit

 

History

History

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
README.md
README.md
 
 

README.md

Table of Contents

getBalance

Returns the balance

Examples

// get payout by txhash
paymentModule.getBalance()
 .then(balance => {
     console.log(balance)
   })
 .catch(err => {
   console.log(err)
 })
//example balance:
15

Returns number balance

createServer

Creates and returns a express server.

Parameters

  • app object an express application.
  • options object an options object. (optional, default {})
    • options.websockets Boolean websockets.
    • options.dashboard Boolean dashboard at /iotapay.
    • options.api Boolean api at /iotapay/api.

Examples

// creates a simple server
var paymentModule = require('iota-payment')
var app = require('express')()

let server = paymentModule.createServer(app, {api: true})

// Start server with iota-payment api on '/iotapay/api'
server.listen(3000, function () {
   console.log(`Server started on http://localhost:3000 `)
})

Returns object an http server

on

This method attaches an event listener. Possible events: -payments: 'paymentCreated', 'paymentPending', 'paymentIncoming', 'paymentSuccess' -payouts: 'payoutCreated', 'payoutSent'

Parameters

  • event object event name
  • fnc function the function which will be called

Examples

const paymentModule = require('iota-payment')

//Create an event handler which is called, when a payment was successfull
let onPaymentSuccess = function (payment) {
    console.log('payment success!', payment);
}

//Assign the event handler to an event:
paymentModule.on('paymentSuccess', onPaymentSuccess);

createPayment

Creates and returns a payment.

Parameters

  • paymentInput object data for the payment
    • paymentInput.value number? iota value
    • paymentInput.timeUntilConfirmation number? time in seconds until the payment is confirmed, independent of the received amount
    • paymentInput.data any? additional data

Examples

// create a payment with the value option
paymentModule.payment.createPayment({value: 1, data: { "test": "123" }})
 .then(payment => {
   console.log(payment)
 })
 .catch(err => {
   console.log(err)
 })
//example payment:
{ data: '',
payed: false,
txInfo: null,
type: 'value',
value: 1,
address:
 'IDEAVKKGLZUCAZJEWOUXVCUYGPSINKJR9UVBEOXRNIOBJFAKUN9GVBDGVEVOOK9HVMMMFMDLZ9G9YFHPWULQWCXYVW',
index: 49,
id: '1575750004195'}
// create a payment with the timeUntilConfirmation option
paymentModule.payment.createPayment({timeUntilConfirmation: 180, data: { "test": "123" }})
 .then(payment => {
   console.log(payment)
 })
 .catch(err => {
   console.log(err)
 })
//example payment:
{ data: { test: '123' },
payed: false,
txInfo: null,
type: 'time',
confirmationTime: 1575750870,
address:
 'BQGQONEUNQYDDEUFDZIJDTVTFUBSIQECBLPU9BNNDVPMXMKFCWYODBGSPHA9TYCFFSYGUH9OIZYDIGBMCXHRBEIIAX',
index: 50,
id: '1575750690816' }

Returns object payment

getPayments

Returns all payments

Examples

// get payments
paymentModule.payment.getPayments()
 .then(payments => {
   console.log(payments)
 })
 .catch(err => {
   console.log(err)
 })
//example payments:
[ { address:
  'CLHNILYEPUQYJWRSGPQGA9BVVKHFHQMDM9ENNSGAHJXJIOLMBARZNHKWZZVGXSSQITOHPD9JXQGVQJJJBKMVRFWSNW',
 index: 10,
 value: '0',
 data: 'test',
 payed: true,
 id: '1570466750915',
 lastTime: 1570466754629 },
{ address:
  'CLTDMWYNTKMPSISD9CBLH9MGATUZQXDALPZQBMHPJQLTKDTWDKFRJQYDKUCPYQFTFPNJBEIHHJRBKQMXXHNSUYEXJC',
 index: 12,
 value: 1,
 payed: false,
 id: '1570564499942' } ]

Returns Array<Object> payments

getOpenPayments

Returns all open (not payed and not too old) payments

Examples

// get open payments
paymentModule.payment.getPayments()
 .then(payments => {
   console.log(payments)
 })
 .catch(err => {
   console.log(err)
 })
//example payments:
[ { address:
  'QXHAEPJSEIUAMMOUWDGYJD9MPPIGBYOPAQSPOZK9VZSGDVVV9SUJEYVXYRFL9KRRBWSDNIFGBDLH9DBADGABSCFTFD',
 index: 11,
 value: 1,
 data: { test: '123' },
 payed: false,
 id: '1570554460662' },
{ address:
  'CLTDMWYNTKMPSISD9CBLH9MGATUZQXDALPZQBMHPJQLTKDTWDKFRJQYDKUCPYQFTFPNJBEIHHJRBKQMXXHNSUYEXJC',
 index: 12,
 value: 1,
 payed: false,
 id: '1570564499942' } ]

Returns Array<Object> open payments

getPaidPayments

Returns all paid (not open and not too old) payments

Examples

// get open payments
paymentModule.payment.getPaidPayments()
 .then(payments => {
   console.log(payments)
 })
 .catch(err => {
   console.log(err)
 })
//example payments:
[ { address:
  'QXHAEPJSEIUAMMOUWDGYJD9MPPIGBYOPAQSPOZK9VZSGDVVV9SUJEYVXYRFL9KRRBWSDNIFGBDLH9DBADGABSCFTFD',
 index: 11,
 value: 1,
 data: { test: '123' },
 payed: true,
 id: '1570554460662' },
{ address:
  'CLTDMWYNTKMPSISD9CBLH9MGATUZQXDALPZQBMHPJQLTKDTWDKFRJQYDKUCPYQFTFPNJBEIHHJRBKQMXXHNSUYEXJC',
 index: 12,
 value: 1,
 payed: true,
 id: '1570564499942' } ]

Returns Array<Object> paid payments

getPaymentByID

Returns payment by id

Parameters

  • id

Examples

// get payment by id
paymentModule.payment.getPaymentByID('1570564499942')
 .then(payment => {
   console.log(payment)
 })
 .catch(err => {
   console.log(err)
 })
//example payment:
{ address:
  'CLTDMWYNTKMPSISD9CBLH9MGATUZQXDALPZQBMHPJQLTKDTWDKFRJQYDKUCPYQFTFPNJBEIHHJRBKQMXXHNSUYEXJC',
 index: 12,
 value: 1,
 payed: false,
 id: '1570564499942' }

Returns Object payment

send

Creates and returns a payout.

Parameters

  • payoutData object data for the payout
    • payoutData.address address 90 trytes iota address (with checksum)
    • payoutData.amount number amount of iotas
    • payoutData.message string? message which will be send with the transaction
    • payoutData.tag string? tryte tag
    • payoutData.data any? additional data, is only stored locally
    • payoutData.startIndex number? custom start index to search for inputaddresses
    • payoutData.endIndex number? custom end index to search for inputaddresses

Examples

// create a payout
let payoutObject = {
  //required
  address: 'HW99PKRDWBUCCWLEQDONQXW9AXQHZAABYEKWSEFYAUIQWWCLVHAUJEQAZJACAGPZBZSQJIOUXRYYEXWZCXXOAJMZVY',
  value: 1,
  //optional
  message: 'Example message',
  tag: 'TRYTETAG',
  data: {test: 27},
  //indexes for input addresses, only required in special cases
  // startIndex: 0,
  // endIndex: 1
}
paymentModule.payout.send(payoutObject)
 .then(payout => {
   console.log(payout)
 })
 .catch(err => {
   console.log(err)
 })
//example payout:
{ address:
 'HW99PKRDWBUCCWLEQDONQXW9AXQHZAABYEKWSEFYAUIQWWCLVHAUJEQAZJACAGPZBZSQJIOUXRYYEXWZCXXOAJMZVY',
value: 1,
message: 'Example message',
tag: 'TRYTETAG',
data: {test: 27},
payed: false,
id: '1570619992125' }

Returns object payout

getPayouts

Returns all payouts

Examples

// get payouts
paymentModule.payout.getPayouts()
 .then(payouts => {
   console.log(payouts)
 })
 .catch(err => {
   console.log(err)
 })
//example payouts:
[
 {
   "address": "USKSGFKPWVXD9EUOJXWNLVWG9FDTIPGBUYB9BQNMMUWIEOMFNDCCUKCJMEPRICBHZNRAIZFGNPK9GCGBYQAEWNJRMC",
   "value": 1,
   "message": "Example message",
   "payed": true,
   "id": "1570616325073",
   "txhash": "XKLLL9B9AUN9EASCAQAQHEYDLLEUDDUCOTJVNTJUSZVTNWUTDPHZUFUJAHFZJOSQYYEPJSWRDXDJ99999"
 },
 {
   "address": "HW99PKRDWBUCCWLEQDONQXW9AXQHZAABYEKWSEFYAUIQWWCLVHAUJEQAZJACAGPZBZSQJIOUXRYYEXWZCXXOAJMZVY",
   "value": 1,
   "message": "Example message",
   "payed": false,
   "id": "1570616561382"
 }
]

Returns Array<Object> payouts

getOpenpayouts

Returns open payouts

Examples

// get open payouts
paymentModule.payout.getOpenpayouts()
 .then(payouts => {
   console.log(payouts)
 })
 .catch(err => {
   console.log(err)
 })
//example payouts:
[
 {
   "address": "HW99PKRDWBUCCWLEQDONQXW9AXQHZAABYEKWSEFYAUIQWWCLVHAUJEQAZJACAGPZBZSQJIOUXRYYEXWZCXXOAJMZVY",
   "value": 1,
   "message": "Example message",
   "payed": false,
   "id": "1570616561382"
 }
]

Returns Array<Object> open payouts

getPayoutByID

Returns payout by id

Parameters

  • id

Examples

// get payout by id
paymentModule.payout.getPayoutByID('1570611186704')
 .then(payout => {
   console.log(payout)
 })
 .catch(err => {
   console.log(err)
 })
//example payout:
{ address:
 'USKSGFKPWVXD9EUOJXWNLVWG9FDTIPGBUYB9BQNMMUWIEOMFNDCCUKCJMEPRICBHZNRAIZFGNPK9GCGBYQAEWNJRMC',
value: 1,
message: 'Example message',
payed: false,
id: '1570611186704' }

Returns Object payment

getPayoutByTxhash

Returns payout by txhash

Parameters

  • txhash

Examples

// get payout by txhash
paymentModule.payout.getPayoutByTxhash('XKLLL9B9AUN9EASCAQAQHEYDLLEUDDUCOTJVNTJUSZVTNWUTDPHZUFUJAHFZJOSQYYEPJSWRDXDJ99999')
 .then(payout => {
  console.log(payout)
 })
 .catch(err => {
    console.log(err)
  })
//example payout:
{ address:
 'USKSGFKPWVXD9EUOJXWNLVWG9FDTIPGBUYB9BQNMMUWIEOMFNDCCUKCJMEPRICBHZNRAIZFGNPK9GCGBYQAEWNJRMC',
value: 1,
message: 'Example message',
payed: true,
id: '1570616325073',
txhash:
 'XKLLL9B9AUN9EASCAQAQHEYDLLEUDDUCOTJVNTJUSZVTNWUTDPHZUFUJAHFZJOSQYYEPJSWRDXDJ99999' }

Returns Object payment

WebSockets with socket.io

backend: https://github.com/machineeconomy/iota-payment/blob/master/examples/06_websockets.js

frontend: https://github.com/machineeconomy/iota-payment/blob/master/examples/06_websocket.html