Payment Rails NodeJS SDK

A native NodeJS SDK for the Payment Rails API

For more information about the API as well as NodeJS code samples check out the full API documentation

Installation

For NodeJS

Getting Started

// A simple NodeJS application using the Payment Rails SDK
var PaymentRails = require('paymentrails');

var callback = function (error, data, response) {

    if (error) {
        console.error(error);
    } else {
        console.log('API called successfully. Returned data: ' + data);
    }
};
PaymentRails.Configuration.prototype.setApiKey('access-code');
PaymentRails.Configuration.prototype.setApiSecret('secret-code');
PaymentRails.Recipient.get('R-GbGnYCbmsSm6xHnYVyGW7J', callback);

Documentation for API Endpoint Methods

All URIs are relative to https://api.paymentrails.com/v1

Class	Method	HTTP request
*Recipient	get	GET /recipient/
*Recipient	post	POST /recipient/
*Recipient	patch	PATCH /recipient/
*Recipient	delete	DELETE /recipient/
*Recipient	query	GET /recipient/
*RecipientAccounts	get	GET /recipient/<recipient_id>/accounts/recipientAccountId
*RecipientAccounts	post	POST /recipient/<recipient_id>/accounts
*RecipientAccounts	patch	PATCH /recipient/<recipient_id>/accounts/recipientAccountId
*Batch	get	GET /batch/
*Batch	post	POST /batch/
*Batch	patch	PATCH /batch/
*Batch	delete	DELETE /batch/
*Batch	query	GET /batch/
*Batch	generateQuote	POST /batch/
*Batch	processBatch	POST /batch/
*Batch	summary	GET /batch/
*Payment	get	GET /payments/
*Payment	post	POST /batch/<batch_id>/payments
*Payment	patch	PATCH /batch/<batch_id>/payments
*Payment	delete	DELETE /batch/<batch_id>/payments
*Payment	query	GET /payments/
*Balances	get	GET /balances/

Documentation for Authorization

merchantKey

• Type: Authorization
• Authorization parts: Access code, Secret code
• Location: HTTP header