channel_connector_apis

ChannelConnectorApis - JavaScript client for channel_connector_apis No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 1.0.0
• Generator version: 7.6.0
• Build package: org.openapitools.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 channel_connector_apis --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 channel_connector_apis 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 ChannelConnectorApis = require('channel_connector_apis');


var api = new ChannelConnectorApis.CollectionApiControllerApi()
var platformTenantId = "platformTenantId_example"; // {String} 
var xCorrelationID = "xCorrelationID_example"; // {String} 
var collectionRequestDTO = new ChannelConnectorApis.CollectionRequestDTO(); // {CollectionRequestDTO} 
var opts = {
  'xPaymentScheme': "xPaymentScheme_example" // {String} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.collection(platformTenantId, xCorrelationID, collectionRequestDTO, opts, callback);

Documentation for API Endpoints

All URIs are relative to http://localhost:8444

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- ChannelConnectorApis.CollectionApiControllerApi | collection | POST /channel/collection | ChannelConnectorApis.GsmaDepositApiControllerApi | gsmadeposit | POST /channel/gsma/deposit | ChannelConnectorApis.GsmaTransactionApiControllerApi | gsmatransaction | POST /channel/gsma/transaction | ChannelConnectorApis.GsmaTransferApiControllerApi | gsmatransfer | POST /channel/gsma/transfer | ChannelConnectorApis.IndexApiControllerApi | index | GET / | ChannelConnectorApis.JobApiControllerApi | job | POST /channel/job/resolve | ChannelConnectorApis.PartyRegistrationApiControllerApi | partyRegistration | POST /channel/partyRegistration | ChannelConnectorApis.TransactionApiControllerApi | transaction | POST /channel/transactionRequest | ChannelConnectorApis.TransactionApiControllerApi | transactionResolve | POST /channel/transaction/{transactionId}/resolve | ChannelConnectorApis.TransferApiControllerApi | transfer | POST /channel/transfer | ChannelConnectorApis.TransferApiControllerApi | transferId | GET /channel/transfer/{transactionId} | ChannelConnectorApis.TxnStateApiControllerApi | txnState | GET /channel/txnState/{X-CorrelationID} | ChannelConnectorApis.ValidationApiControllerApi | validation | POST /accounts/validate/{primaryIdentifierName}/{primaryIdentifierVal} | ChannelConnectorApis.WorkflowApiControllerApi | workflow | POST /channel/workflow/resolve | ChannelConnectorApis.WorkflowApiControllerApi | workflowKey | POST /channel/workflow/{workflowInstanceKey}/cancel |

Documentation for Models

• ChannelConnectorApis.Amount
• ChannelConnectorApis.CollectionRequestDTO
• ChannelConnectorApis.ComplexName
• ChannelConnectorApis.CustomData
• ChannelConnectorApis.ErrorDTO
• ChannelConnectorApis.ErrorDetailsDto
• ChannelConnectorApis.ErrorParameter
• ChannelConnectorApis.Extension
• ChannelConnectorApis.ExtensionList
• ChannelConnectorApis.Fee
• ChannelConnectorApis.GSMATransaction
• ChannelConnectorApis.GeoCode
• ChannelConnectorApis.GsmaParty
• ChannelConnectorApis.GsmaTransfer
• ChannelConnectorApis.IdDocument
• ChannelConnectorApis.InternationalTransferInformation
• ChannelConnectorApis.InvalidRequestBodyResponseDto
• ChannelConnectorApis.Kyc
• ChannelConnectorApis.MoneyData
• ChannelConnectorApis.Party
• ChannelConnectorApis.PartyIdInfo
• ChannelConnectorApis.Payer
• ChannelConnectorApis.PersonalInfo
• ChannelConnectorApis.PostalAddress
• ChannelConnectorApis.Refund
• ChannelConnectorApis.RegisterAliasRequestDTO
• ChannelConnectorApis.RequestStateDTO
• ChannelConnectorApis.SubjectName
• ChannelConnectorApis.SuccessfulTransferResponseDto
• ChannelConnectorApis.SuccessfulTxnStateResponseDTO
• ChannelConnectorApis.TransactionChannelRequestDTO
• ChannelConnectorApis.TransactionStatusResponseDTO
• ChannelConnectorApis.TransactionType
• ChannelConnectorApis.ValidationRequestDTO
• ChannelConnectorApis.ValidationResponseDTO

Documentation for Authorization

Endpoints do not require authorization.