1.0.0 • Published 7 years ago

mobile_money_api v1.0.0

Weekly downloads
-
License
ISC
Repository
-
Last release
7 years ago

mobile_money_api

MobileMoneyApi - JavaScript client for mobile_money_api This document defines the RESTful endpoints provided by the GSMA Mobile Money API This SDK is automatically generated by the Swagger Codegen project:

  • API version: 0.14
  • Package version: 0.14
  • 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 mobile_money_api --save

git

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

    npm install YOUR_USERNAME/mobile_money_api --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.

Getting Started

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

var MobileMoneyApi = require('mobile_money_api');

var api = new MobileMoneyApi.DefaultApi()

var _date = "_date_example"; // {String} Header parameter to indicate the date and time that the message was originated

var accountId = "accountId_example"; // {String} Path variable to uniquely identify an account


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.accountsAccountIdAccountnameGet(_date, accountId, , callback);

Documentation for API Endpoints

All URIs are relative to https://https://api-2445581837643.staging.apicast.io:443/

ClassMethodHTTP requestDescription
MobileMoneyApi.DefaultApiaccountsAccountIdAccountnameGetGET /accounts/{accountId}/accountnameView Account Name
MobileMoneyApi.DefaultApiaccountsAccountIdBalanceGetGET /accounts/{accountId}/balanceView Account Balance
MobileMoneyApi.DefaultApiaccountsAccountIdBillsBillReferencePaymentsPostPOST /accounts/{accountId}/bills/{billReference}/paymentsCreate A Bill Payment
MobileMoneyApi.DefaultApiaccountsAccountIdBillsGetGET /accounts/{accountId}/billsView Account Bills
MobileMoneyApi.DefaultApiaccountsAccountIdDebitmandatesDebitMandateReferenceGetGET /accounts/{accountId}/debitmandates/{debitMandateReference}View A Debit Mandate
MobileMoneyApi.DefaultApiaccountsAccountIdDebitmandatesDebitMandateReferencePatchPATCH /accounts/{accountId}/debitmandates/{debitMandateReference}Update A Debit Mandate
MobileMoneyApi.DefaultApiaccountsAccountIdDebitmandatesPostPOST /accounts/{accountId}/debitmandatesCreate A Debit Mandate
MobileMoneyApi.DefaultApiaccountsAccountIdLinksLinkReferenceGetGET /accounts/{accountId}/links/{linkReference}View A Link
MobileMoneyApi.DefaultApiaccountsAccountIdLinksLinkReferencePatchPATCH /accounts/{accountId}/links/{linkReference}Update A Link
MobileMoneyApi.DefaultApiaccountsAccountIdLinksPostPOST /accounts/{accountId}/linksCreate A Link
MobileMoneyApi.DefaultApiaccountsAccountIdStatemententriesGetGET /accounts/{accountId}/statemententriesView Account Statements
MobileMoneyApi.DefaultApiaccountsAccountIdStatusGetGET /accounts/{accountId}/statusView Account Status
MobileMoneyApi.DefaultApiaccountsAccountIdTransactionsGetGET /accounts/{accountId}/transactionsView Account Specific Transaction
MobileMoneyApi.DefaultApiaccountsMsisdnMsisdnAccountnameGetGET /accounts/msisdn/{msisdn}/accountnameView Account Name
MobileMoneyApi.DefaultApiaccountsMsisdnMsisdnBalanceGetGET /accounts/msisdn/{msisdn}/balanceView Account Balance
MobileMoneyApi.DefaultApiaccountsMsisdnMsisdnBillsBillReferencePaymentsPostPOST /accounts/msisdn/{msisdn}/bills/{billReference}/paymentsCreate A Bill Payment
MobileMoneyApi.DefaultApiaccountsMsisdnMsisdnBillsGetGET /accounts/msisdn/{msisdn}/billsView Account Bills
MobileMoneyApi.DefaultApiaccountsMsisdnMsisdnDebitmandatesDebitMandateReferenceGetGET /accounts/msisdn/{msisdn}/debitmandates/{debitMandateReference}View A Debit Mandate
MobileMoneyApi.DefaultApiaccountsMsisdnMsisdnDebitmandatesDebitMandateReferencePatchPATCH /accounts/msisdn/{msisdn}/debitmandates/{debitMandateReference}Update A Debit Mandate
MobileMoneyApi.DefaultApiaccountsMsisdnMsisdnDebitmandatesPostPOST /accounts/msisdn/{msisdn}/debitmandatesCreate A Debit Mandate
MobileMoneyApi.DefaultApiaccountsMsisdnMsisdnLinksLinkReferenceGetGET /accounts/msisdn/{msisdn}/links/{linkReference}View A Link
MobileMoneyApi.DefaultApiaccountsMsisdnMsisdnLinksLinkReferencePatchPATCH /accounts/msisdn/{msisdn}/links/{linkReference}Update A Link
MobileMoneyApi.DefaultApiaccountsMsisdnMsisdnLinksPostPOST /accounts/msisdn/{msisdn}/linksCreate A Link
MobileMoneyApi.DefaultApiaccountsMsisdnMsisdnStatemententriesGetGET /accounts/msisdn/{msisdn}/statemententriesView Account Statements
MobileMoneyApi.DefaultApiaccountsMsisdnMsisdnStatusGetGET /accounts/msisdn/{msisdn}/statusView Account Status
MobileMoneyApi.DefaultApiaccountsMsisdnMsisdnTransactionsGetGET /accounts/msisdn/{msisdn}/transactionsView Account Specific Transaction
MobileMoneyApi.DefaultApibatchtransactionsBatchIdCompletionsGetGET /batchtransactions/{batchId}/completionsView Batch Completions
MobileMoneyApi.DefaultApibatchtransactionsBatchIdGetGET /batchtransactions/{batchId}View A Transaction Batch
MobileMoneyApi.DefaultApibatchtransactionsBatchIdPatchPATCH /batchtransactions/{batchId}Update A Transaction Batch
MobileMoneyApi.DefaultApibatchtransactionsBatchIdRejectionsGetGET /batchtransactions/{batchId}/rejectionsView Batch Rejections
MobileMoneyApi.DefaultApibatchtransactionsPostPOST /batchtransactionsCreate A Transaction Batch
MobileMoneyApi.DefaultApibillsBillReferencePaymentsPostPOST /bills/{billReference}/paymentsCreate A Bill Payment
MobileMoneyApi.DefaultApiheartbeatGetGET /heartbeatCheck API availability
MobileMoneyApi.DefaultApiquotationsPostPOST /quotationsCreate A New Quotation
MobileMoneyApi.DefaultApiquotationsQuotationReferenceGetGET /quotations/{quotationReference}View A Quotation
MobileMoneyApi.DefaultApiquotationsQuotationReferencePatchPATCH /quotations/{quotationReference}Update A Quotation
MobileMoneyApi.DefaultApirequeststatesServerCorrelationIdGetGET /requeststates/{serverCorrelationId}View A Request State
MobileMoneyApi.DefaultApirequeststatesServerCorrelationIdPatchPATCH /requeststates/{serverCorrelationId}Update A Request State
MobileMoneyApi.DefaultApiresponsesClientCorrelationIdGetGET /responses/{clientCorrelationId}View A Response
MobileMoneyApi.DefaultApistatemententriesTransactionReferenceGetGET /statemententries/{transactionReference}View Specific Statement
MobileMoneyApi.DefaultApitransactionsPostPOST /transactionsCreate A Transaction
MobileMoneyApi.DefaultApitransactionsTransactionReferenceGetGET /transactions/{transactionReference}View A Transaction
MobileMoneyApi.DefaultApitransactionsTransactionReferenceReversalsPostPOST /transactions/{transactionReference}/reversalsCreate A Reversal

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.

package
express
@everything-registry/sub-chunk-2185@zalastax/nolb-mobi
1.0.0

7 years ago