Meet npm Pro: unlimited public & private packages + package-based permissions.Learn more »

itransact-node

2.1.0 • Public • Published

iTransact SDK for NodeJS

CircleCI js-standard-style Try Payroc iTransact Node SDK on RunKit

As a quick helper for our NodeJS community to get up and running even faster in your favorite dependency manager, we have created this API / SDK wrapper specifically tailored for NodeJS and Express.

More details at iTransact Developer API

Features

Usage

If there is a platform you would like to see in addition to npm for dependency management, let us know.

NPM Install

Run the following command at the root fo your project

npm install itransact-node

iTransact SDK on NPM

Manual Install

Download the zip, or use git submodules to pull the SDK into your project.

Import Example

Here is an example implementation:

(see /examples for more)

DIY Example without iTransact SDK

DIY Example

Post transaction with iTransact SDK

"use strict";
const itransact = require('itransact-node');
 
// Store these somewhere safe.
const api_username = 'test_user';
const api_key = 'test_key';
 
// You can use your own JSON Model, or use the included models.
const cardData = new itransact.CardDataModel();
cardData.name = 'Greg';
cardData.number = '4111111111111111';
cardData.cvv = '123';
cardData.exp_month = '11';
cardData.exp_year = '2020';
// Note that you can access the json ready object on any custom class model by calling .toJson()
// ex: cardData.toJson(), metaData.toJson(), etc.
 
// MetaData is optional, customer emails will not be sent out without the following.
const metaData = new itransact.MetaDataModel();
metaData.email = "example@test.com"; // Customer's email address for receipt delivery
 
// Address is optional, unless using loopback /sandbox / demo account.
const addressData = new itransact.AddressDataModel();
addressData.postal_code = '84025';
 
const payload = new itransact.TransactionPostPayloadModel();
payload.amount = '1000';
payload.card = cardData;
payload.address = addressData; // Optional
payload.metadata = metaData; // Optional
payload.send_customer_receipt = true; // Optional - default: false
 
let fooCallback = function (response) {
    // Do something with response here
};
 
itransact.post_card_transaction(payload, api_username, api_key, fooCallback);

Signing payload with iTransact SDK (doesn't post transaction)

"use strict";
const itransact = require('itransact-node');
 
// Store this somewhere safe.
const api_key = 'test_key';
 
// You can use your own JSON Model, or use the included models.
const payload = {
    amount: '1000',
    card:{
        name: 'Greg',
        number: '4111111111111111',
        cvv: '123',
        exp_month: '11',
        exp_year: '2020'
    },
    'address': { // Address is optional, unless using loopback /sandbox / demo account.
        'postal_code': '84025'
    },
    'metadata': { // Optional
        'email': 'example@itransact.com'
    },
    'send_customer_receipt': 'true' // Optional - default: false
};
 
// IF you want to just sign the payload
let payloadSignature = itransact.signPayload(api_key, payload);

Note - expected signature changes every time the api_username, api_key, and payload changes in any way. It is only included here for testing.

Demo Account Note - Loopback, Sandbox, and Demo accounts require postal_code, otherwise you will see an error similar to - "ZIP REQUIRED FOR KEYED TRANSACTION"

Example Response

Example successful postResult using the example above will return a 201 with the following fields / value types:

{
  "id": "string",
  "amount": 0,
  "status": "string",
  "settled": "string",
  "instrument": "string",
  "metadata": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "payment_source": {
    "name": "string",
    "default": "string",
    "type": "string",
    "expired": "string",
    "month": "string",
    "year": "string",
    "brand": "string",
    "last_four_digits": "string",
    "sec_code": "string"
  },
  "credits": {
    "amount": 0,
    "state": "string"
  },
  "credited_amount": "string"
}

Check out the files in /examples for other ideas for implementation.

Testing

Unit tests on this project are run using Mocha. You can find each test in the /test folder.

Note: We utilize the npm package dotenv for testing different environments. Once you add these environment variables using your own .env using the .env.default file for reference the tests will function properly. You are also able to add the required variables it to your PATH directly to achieve the same effect

Example .env file:

# Used in unit tests.
ITRANSACT_ENVIRONMENT=production
ITRANSACT_API_USERNAME=your_api_username
ITRANSACT_API_KEY=your_api_key

You can run the following commands from package.json to execute the tests.

npm test
npm test-report
npm test-check-coverage
./node_modules/.bin/mocha --reporter spec

Install

npm i itransact-node

DownloadsWeekly Downloads

3

Version

2.1.0

License

MIT

Unpacked Size

487 kB

Total Files

274

Last publish

Collaborators

  • avatar
  • avatar
  • avatar
  • avatar