mastercard_track_search_api

MastercardTrackSearchApi - JavaScript client for mastercard_track_search_api All functionality related to the search service This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen For more information, please visit https://developer.mastercard.com/support

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 mastercard_track_search_api --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 mastercard_track_search_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

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

    npm install GIT_USER_ID/GIT_REPO_ID --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 MastercardTrackSearchApi = require('mastercard_track_search_api');


var api = new MastercardTrackSearchApi.TrackSearchApi()
var bulkSearchId = f66ae13b-6a11-41ab-bc9a-47948767d6fb; // {String} Unique UUID assigned to bulk request.
var opts = {
  'searchRequestId': 9202f222, // {String} An identifier for a specific search request.
  'offset': 0, // {Number} Starting row of results started at.
  'limit': 25 // {Number} Limit sets the number of results you would like to see.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBulkSearchResults(bulkSearchId, opts, callback);

Documentation for API Endpoints

All URIs are relative to https://sandbox.api.mastercard.com/track/search

Class	Method	HTTP request	Description
MastercardTrackSearchApi.TrackSearchApi	getBulkSearchResults	GET /bulk-searches/{bulk_search_id}/results	Retrieve bulk request result
MastercardTrackSearchApi.TrackSearchApi	getBulkSearchStatus	GET /bulk-searches/{bulk_search_id}	Retrieve bulk request metadata
MastercardTrackSearchApi.TrackSearchApi	submitBulkSearch	POST /bulk-searches	Create a bulk request

Documentation for Models

• MastercardTrackSearchApi.BpsDetails
• MastercardTrackSearchApi.BulkSearchResult
• MastercardTrackSearchApi.BulkSearchResults
• MastercardTrackSearchApi.BulkSearchStatus
• MastercardTrackSearchApi.BusinessAddress
• MastercardTrackSearchApi.CardProcessingHistory
• MastercardTrackSearchApi.EntityDetails
• MastercardTrackSearchApi.Error
• MastercardTrackSearchApi.ErrorList
• MastercardTrackSearchApi.ErrorWrapper
• MastercardTrackSearchApi.NewBulkSearch
• MastercardTrackSearchApi.NewBulkSearchResult
• MastercardTrackSearchApi.OrganisationIdentification
• MastercardTrackSearchApi.RequesterInformation
• MastercardTrackSearchApi.RequesterOrganisationIdentification
• MastercardTrackSearchApi.RequestingBusinessAddress
• MastercardTrackSearchApi.SearchError
• MastercardTrackSearchApi.SearchRequestEntity
• MastercardTrackSearchApi.SearchResult
• MastercardTrackSearchApi.SearchResults

Documentation for Authorization

All endpoints do not require authorization.