B2C-Funds-Transfer-nodejs

/**
 * 
 * sample code to showcase all the request in transfer service.
 * 
 * For any difficulty, contact any of the contributors for help.
 *
 */
var app = require('./src/index.js');

/**
 * Initiating entity code:
 * This is unique to a each merchant.
 * When you are ready to move to production,
 * you will be provided with your initiatingEntityCode
 */
var initiatingEntityCode = "XXT";

/**
 * @clientId:
 * @clientSecret:
 * These are for test environment.
 * var clientId = "IKIA2EFBE1EF63D1BBE2AF6E59100B98E1D3043F477A";
 * var clientSecret = "uAk0Amg6NQwQPcnb9BTJzxvMS6Vz22octQglQ1rfrMA=";
 * var transfer = new FundTransfer({clientId: clientId, clientSecret: clientSecret, environment: "SANDBOX"})
 */

/**
 * @clientId:
 * @clientSecret:
 * These are for the sandbox environment.
 */
var clientId = "IKIA6570778A3484D6F33BC7E4165ADCA6CF06B2860A";
var clientSecret = "DXfUwpuIvMAKN84kv38uspqGOsStgFS0oZMjU7bPwpU=";

var Interswitch = require('interswitch');
var TransferRequestBuilder = app.TransferRequestBuilder;
var FundTransfer = app.FundTransfer;
var Constant = app.Constant;


/**
 * Create a funds transfer object.
 * e.g FundsTransfer transfer = new FundsTransfer({clientId: clientId, clientSecret: clientSecret, environment: "SANDBOX"});
 * 
 * With this object you can
 * 
 * 1. Get all supported banks on our platform.
 * 
 * e.g var bankResponse = transfer.fetchBanks();
 * 
 * If successful, it returns a list of all banks. Otherwise it
 * throws returns an error object or throws an exception.
 * 
 * 2. Account Validation
 * 
 * e.g var validationResponse = transfer.validateAccount(request);// validate account
 * 
 * This is used to validate an account number against a source bank.
 * If successful, you know for sure the bank account number is valid.
 * Otherwise, it is probably okay to still go on with the transaction.
 * 
 * 3. Funds Transfer.
 * 
 * e.g var response = transfer.send(request); // send transfer request
 * 
 * This api, is used to initiate a funds transfer from a sender to a receiver.
 * The sample code is clear and concise and states the mandatory and optional fields.
 * 
 * 
 * 
 */
var transfer = new FundTransfer({clientId: clientId, clientSecret: clientSecret, environment: "SANDBOX"});
//var transfer = new FundTransfer({clientId: clientId, clientSecret: clientSecret, environment: "PRODUCTION"});
//var transfer = new FundTransfer({clientId: clientId, clientSecret: clientSecret});


transfer.fetchBanks(function(err, response){
    if(err) {
        //fetch banks was not successful
        return;
    }
    else {
        console.log("bank response "+JSON.stringify(response.body));
        if(bankResponse) {

            var bankResponse = JSON.parse(response.body).banks;

            var aBank = bankResponse[0];
            var cbnCode = aBank.cbnCode; // Central bank code
            var bankName = aBank.bankName; // bank name:
            var bankCode = aBank.bankCode; // bankcode in alphabetical form: UBA, GTB, FBN
            console.log(cbnCode+" "+bankName+" "+bankCode);
        }
        var request = new TransferRequestBuilder(initiatingEntityCode)
            .amount("100000") // mandatory, minor denomination
            .channel(Constant.LOCATION) // mandatory: ATM-1, POS-2, WEB-3, MOBILE-4, KIOSK-5, PCPOS-6, LOCATION-7, DIRECT DEBIT-8
            .destinationBankCode(cbnCode)/* mandatory:  To be gotten from the get all banks code (transfer.fetchBanks())*/
            .toAccountNumber("0114951936") // mandatory
            .requestRef("60360575603527")// mandatory
            .senderPhoneNumber("07036913492") // optional
            .senderEmail("[email protected]") // optional
            .senderLastName("Desmond") // optional
            .senderOtherNames("Samuel") // optional
            .receiverPhoneNumber("07036913492") // optional
            .receiverEmail("[email protected]") // optional
            .receiverLastName("Desmond") // optional
            .receiverOtherNames("Samuel") // optional
            .fee("10000")// optional (minor denomination)
            .build();
        
        var validationResponse = transfer.validateAccount(request, function(err, name){
            if(err) {
                //name validation was not successful
            }
            else {
                var accountName = name;
                console.log("account name "+name);
            }
        });// validate account

        var response = transfer.send(request, function(err, response){
            if(err) {
                //an error occured wihle doing transfer
                console.log(err);
            }
            else {
                if(! response.errors) {

                    var mac = response.mac;
                    var transactionDate = response.transactionDate;
                    var responseCode = response.responseCode;
                    console.log(mac+" "+transactionDate+" "+responseCode);
                }
                else {

                    //transfer not successful
                    console.log(JSON.stringify(response));
                }
            }

        });



    }
});//end of fetchBanks

Installation

$ npm install interswitch-funds-transfer

Features

• Get All Supported Banks
• Account Validation
• Funds Transfer

Running sample app

cd B2C-Funds-Transfer-nodejs
node AppDriver.js