yl-third-party-instantsettlement-api-client

YlThirdPartyInstantsettlementApiClient - JavaScript client for yl-third-party-instantsettlement-api-client Through this API you can can create Instant Settlement transactions with YouLend This SDK is automatically generated by the OpenAPI Generator project:

• API version: v1.0
• Package version: v1.0
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

Then install it via:

npm install yl-third-party-instantsettlement-api-client --save

Finally, you need to build the module:

npm run build

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

To use the link you just defined in your project, switch to the directory you want to use your yl-third-party-onboarding-api-client from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

The library is hosted at a git repository, https://github.com/YouLend/yl-third-party-instantsettlement-api-client.git then install it via:

    npm install https://github.com/YouLend/yl-third-party-instantsettlement-api-client.git --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):

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 YlThirdPartyInstantsettlementApiClient = require('yl-third-party-instantsettlement-api-client');

var defaultClient = YlThirdPartyInstantsettlementApiClient.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new YlThirdPartyInstantsettlementApiClient.InstantSettlementApi()
var opts = {
  'apiVersion': "apiVersion_example" // {String} 
};
api.apiInstantSettlementGet(opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to https://staging.youlendapi.com/instantsettlement

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- YlThirdPartyInstantsettlementApiClient.InstantSettlementApi | apiInstantSettlementGet | GET /api/InstantSettlement | An endpoint for getting your associated Instant Settlements YlThirdPartyInstantsettlementApiClient.InstantSettlementApi | apiInstantSettlementInstantSettlementNumberPost | POST /api/InstantSettlement/{instantSettlementNumber} | Create instant settlement transactions for a specified instant settlement YlThirdPartyInstantsettlementApiClient.InstantSettlementApi | apiInstantSettlementInstantSettlementNumberTransactionsGet | GET /api/InstantSettlement/{instantSettlementNumber}/transactions | An endpoint for viewing the transactions for an Instant Settlement

Documentation for Models

• YlThirdPartyInstantsettlementApiClient.CreateInstantSettlementTransactionModel
• YlThirdPartyInstantsettlementApiClient.InstantSettlementTransactionModel
• YlThirdPartyInstantsettlementApiClient.InstantSettlementView

Documentation for Authorization

oauth2

• Type: OAuth
• Flow: application
• Authorization URL:
• Scopes: N/A