Coder Social home page Coder Social logo

ipayout-node's Introduction

ipayout-node

npm version

A node.js module for interacting with iPayout eWallet API.

Full iPayout Documentation: https://www.i-payout.com/API/Default.aspx

I created this as an abstraction to the iPayout API making it easier to send and receive requests without having to worry about the nitty gritty.

Installation

	npm install ipayout-node

Usage

  • Require ipayout-node in your project:

    var ipayout = require('ipayout-node')({
      MerchantGUID: 'Your merchant GUID',
      MerchantPassword: 'Your Merchant Password',
      sandbox: true //On production don't include this key
    });
  • Follow this simple format for all API endpoints.

    • Every .run(fn, data) request requires a function name eg. eWallet_RegisterUser and the required data.
ipayout
  .run('eWallet_RegisterUser', userData)
  .then(function(response) {
    //success
  }).catch(function(err) {
    //failed
  });

Full Example

var ipayout = require('ipayout-node')({
    MerchantGUID: 'Your merchant GUID',
    MerchantPassword: 'Your Merchant Password',
    sandbox: true //On production don't include this key
  });
    
    
var userData = {
	'FirstName': 'John',
	'LastName': 'Smith',
	'UserName': 'JohnSmith',
	'EmailAddress': '[email protected]',
	'DateOfBirth': '1/1/1970',
	'Address1': '1234 W 87th St',
	'City': 'San Francisco',
	'State': 'California',
	'Country2xFormat': 'US',
	'ZipCode': '90210',
	'PreferredLanguage': 'EN'
}

ipayout
  .run('eWallet_RegisterUser', userData)
  .then(function(data) {
		console.log(data);	
	  /*	
      { response: 
        { 
          m_Code: 0,
          m_Text: 'OK',
          LogTransactionID: 0,
          TransactionRefID: 11111,
          ACHTransactionID: 0,
          ProcessorTransactionRefNumber: '',
          CustomerFeeAmount: 0,
          CurrencyCode: null 
        }
      }
    */
	}).catch(function(err) {
    //handle error
  });

Notes

Things to keep in mind:

  • Please read in full the integration guides provided by iPayout at https://www.i-payout.com/API/Default.aspx, they're relatively short and straight to the point so no excuse not to read them.

  • ipayout-node validates data given to .run() and only known keys are actually sent inside the request

    • Keys must be in the exact format iPayout expects them to be eg. 'UserName' capitalized.
  • Dates, such as DateOfBirth currently only support string dates (No date objects) eg."1/1/1970".

Contribution

I accept Pull-Requests! There are many, many ways to make this abstraction better this is very primitive/preliminary stuff at the moment.

Feel free to add and improve as you wish.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.