transfer_money

0.0.1 • Public • Published

transfer_money

TransferMoney - JavaScript client for transfer_money An API depicting the working of EKO platform This SDK is automatically generated by the Swagger Codegen project:

  • API version: 0.0.1
  • Package version: 0.0.1
  • Build package: io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install transfer_money --save
Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your transfer_money from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('transfer_money') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/transfer_money then install it via:

    npm install YOUR_USERNAME/transfer_money --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var TransferMoney = require('transfer_money');

var defaultClient = TransferMoney.ApiClient.instance;

// Configure API key authorization: developer_key
var developer_key = defaultClient.authentications['developer_key'];
developer_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//developer_key.apiKeyPrefix['developer_key'] = "Token"

var api = new TransferMoney.BanksApi()

var bankCode = "bankCode_example"; // {String} 

var initiatorId = 789; // {Number} 

var developerKey = "developerKey_example"; // {String} Your unique API key that will authenticate your request

var opts = { 
  'ifsc': "ifsc_example", // {String} 
  'secretKey': "secretKey_example", // {String} refer to authentication section
  'secretKeyTimestamp': "secretKeyTimestamp_example" // {String} refer to authentication section
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.banksGet(bankCode, initiatorId, developerKey, opts, callback);

Documentation for API Endpoints

All URIs are relative to https://staging.eko.in:25004/ekoapi/v1

Class Method HTTP request Description
TransferMoney.BanksApi banksGet GET /banks Get Bank Details
TransferMoney.BanksApi banksIdTypeidAccountsidPost POST /banks/id_type::id/accounts/:id Verify Bank Account Details
TransferMoney.BanksApi panVerifyPost POST /pan/verify PAN verification
TransferMoney.CustomersApi customersCustomerIdTypecustomerIdGet GET /customers/{customer_id_type}:{customer_id} Get Customer Information
TransferMoney.CustomersApi customersCustomerIdTypecustomerIdOtpPut PUT /customers/{customer_id_type}:{customer_id}/otp Resend Otp
TransferMoney.CustomersApi customersCustomerIdTypecustomerIdPut PUT /customers/{customer_id_type}:{customer_id} Create Customer
TransferMoney.CustomersApi customersVerificationOtpotpPut PUT /customers/verification/otp:{otp} Verify Customer Identity
TransferMoney.RecipientsApi customersCustomerIdTypecustomerIdRecipientsGet GET /customers/{customer_id_type}:{customer_id}/recipients Get List of Recipients
TransferMoney.RecipientsApi customersCustomerIdTypecustomerIdRecipientsRecipientIdidGet GET /customers/{customer_id_type}:{customer_id}/recipients/recipient_id:{id} Get Recipient Details
TransferMoney.RecipientsApi customerscustomerIdTypecustomerIdRecipientsrecipientsIdTypeidPut PUT /customers/:customer_id_type::customer_id/recipients/:recipients_id_type::id Add Recipient
TransferMoney.TransactionsApi transactionsPost POST /transactions Initiate Transaction
TransferMoney.TransactionsApi transactionsidGet GET /transactions/:id Get Transaction Status
TransferMoney.TransactionsApi transactionsidRefundOtpPost POST /transactions/:id/refund/otp Resend Refund OTP
TransferMoney.TransactionsApi transactionsidRefundPost POST /transactions/:id/refund Refund

Documentation for Models

Documentation for Authorization

developer_key

  • Type: API key
  • API key parameter name: developer_key
  • Location: HTTP header

Readme

Keywords

none

Package Sidebar

Install

npm i transfer_money

Weekly Downloads

1

Version

0.0.1

License

Unlicense

Unpacked Size

354 kB

Total Files

104

Last publish

Collaborators

  • shivam07