mcjb

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/

Class	Method	HTTP request	Description
MobileMoneyApi.DefaultApi	accountsAccountIdAccountnameGet	GET /accounts/{accountId}/accountname	View Account Name
MobileMoneyApi.DefaultApi	accountsAccountIdBalanceGet	GET /accounts/{accountId}/balance	View Account Balance
MobileMoneyApi.DefaultApi	accountsAccountIdBillsBillReferencePaymentsPost	POST /accounts/{accountId}/bills/{billReference}/payments	Create A Bill Payment
MobileMoneyApi.DefaultApi	accountsAccountIdBillsGet	GET /accounts/{accountId}/bills	View Account Bills
MobileMoneyApi.DefaultApi	accountsAccountIdDebitmandatesDebitMandateReferenceGet	GET /accounts/{accountId}/debitmandates/{debitMandateReference}	View A Debit Mandate
MobileMoneyApi.DefaultApi	accountsAccountIdDebitmandatesDebitMandateReferencePatch	PATCH /accounts/{accountId}/debitmandates/{debitMandateReference}	Update A Debit Mandate
MobileMoneyApi.DefaultApi	accountsAccountIdDebitmandatesPost	POST /accounts/{accountId}/debitmandates	Create A Debit Mandate
MobileMoneyApi.DefaultApi	accountsAccountIdLinksLinkReferenceGet	GET /accounts/{accountId}/links/{linkReference}	View A Link
MobileMoneyApi.DefaultApi	accountsAccountIdLinksLinkReferencePatch	PATCH /accounts/{accountId}/links/{linkReference}	Update A Link
MobileMoneyApi.DefaultApi	accountsAccountIdLinksPost	POST /accounts/{accountId}/links	Create A Link
MobileMoneyApi.DefaultApi	accountsAccountIdStatemententriesGet	GET /accounts/{accountId}/statemententries	View Account Statements
MobileMoneyApi.DefaultApi	accountsAccountIdStatusGet	GET /accounts/{accountId}/status	View Account Status
MobileMoneyApi.DefaultApi	accountsAccountIdTransactionsGet	GET /accounts/{accountId}/transactions	View Account Specific Transaction
MobileMoneyApi.DefaultApi	accountsMsisdnMsisdnAccountnameGet	GET /accounts/msisdn/{msisdn}/accountname	View Account Name
MobileMoneyApi.DefaultApi	accountsMsisdnMsisdnBalanceGet	GET /accounts/msisdn/{msisdn}/balance	View Account Balance
MobileMoneyApi.DefaultApi	accountsMsisdnMsisdnBillsBillReferencePaymentsPost	POST /accounts/msisdn/{msisdn}/bills/{billReference}/payments	Create A Bill Payment
MobileMoneyApi.DefaultApi	accountsMsisdnMsisdnBillsGet	GET /accounts/msisdn/{msisdn}/bills	View Account Bills
MobileMoneyApi.DefaultApi	accountsMsisdnMsisdnDebitmandatesDebitMandateReferenceGet	GET /accounts/msisdn/{msisdn}/debitmandates/{debitMandateReference}	View A Debit Mandate
MobileMoneyApi.DefaultApi	accountsMsisdnMsisdnDebitmandatesDebitMandateReferencePatch	PATCH /accounts/msisdn/{msisdn}/debitmandates/{debitMandateReference}	Update A Debit Mandate
MobileMoneyApi.DefaultApi	accountsMsisdnMsisdnDebitmandatesPost	POST /accounts/msisdn/{msisdn}/debitmandates	Create A Debit Mandate
MobileMoneyApi.DefaultApi	accountsMsisdnMsisdnLinksLinkReferenceGet	GET /accounts/msisdn/{msisdn}/links/{linkReference}	View A Link
MobileMoneyApi.DefaultApi	accountsMsisdnMsisdnLinksLinkReferencePatch	PATCH /accounts/msisdn/{msisdn}/links/{linkReference}	Update A Link
MobileMoneyApi.DefaultApi	accountsMsisdnMsisdnLinksPost	POST /accounts/msisdn/{msisdn}/links	Create A Link
MobileMoneyApi.DefaultApi	accountsMsisdnMsisdnStatemententriesGet	GET /accounts/msisdn/{msisdn}/statemententries	View Account Statements
MobileMoneyApi.DefaultApi	accountsMsisdnMsisdnStatusGet	GET /accounts/msisdn/{msisdn}/status	View Account Status
MobileMoneyApi.DefaultApi	accountsMsisdnMsisdnTransactionsGet	GET /accounts/msisdn/{msisdn}/transactions	View Account Specific Transaction
MobileMoneyApi.DefaultApi	batchtransactionsBatchIdCompletionsGet	GET /batchtransactions/{batchId}/completions	View Batch Completions
MobileMoneyApi.DefaultApi	batchtransactionsBatchIdGet	GET /batchtransactions/{batchId}	View A Transaction Batch
MobileMoneyApi.DefaultApi	batchtransactionsBatchIdPatch	PATCH /batchtransactions/{batchId}	Update A Transaction Batch
MobileMoneyApi.DefaultApi	batchtransactionsBatchIdRejectionsGet	GET /batchtransactions/{batchId}/rejections	View Batch Rejections
MobileMoneyApi.DefaultApi	batchtransactionsPost	POST /batchtransactions	Create A Transaction Batch
MobileMoneyApi.DefaultApi	billsBillReferencePaymentsPost	POST /bills/{billReference}/payments	Create A Bill Payment
MobileMoneyApi.DefaultApi	heartbeatGet	GET /heartbeat	Check API availability
MobileMoneyApi.DefaultApi	quotationsPost	POST /quotations	Create A New Quotation
MobileMoneyApi.DefaultApi	quotationsQuotationReferenceGet	GET /quotations/{quotationReference}	View A Quotation
MobileMoneyApi.DefaultApi	quotationsQuotationReferencePatch	PATCH /quotations/{quotationReference}	Update A Quotation
MobileMoneyApi.DefaultApi	requeststatesServerCorrelationIdGet	GET /requeststates/{serverCorrelationId}	View A Request State
MobileMoneyApi.DefaultApi	requeststatesServerCorrelationIdPatch	PATCH /requeststates/{serverCorrelationId}	Update A Request State
MobileMoneyApi.DefaultApi	responsesClientCorrelationIdGet	GET /responses/{clientCorrelationId}	View A Response
MobileMoneyApi.DefaultApi	statemententriesTransactionReferenceGet	GET /statemententries/{transactionReference}	View Specific Statement
MobileMoneyApi.DefaultApi	transactionsPost	POST /transactions	Create A Transaction
MobileMoneyApi.DefaultApi	transactionsTransactionReferenceGet	GET /transactions/{transactionReference}	View A Transaction
MobileMoneyApi.DefaultApi	transactionsTransactionReferenceReversalsPost	POST /transactions/{transactionReference}/reversals	Create A Reversal

Documentation for Models

• MobileMoneyApi.AccountBalance
• MobileMoneyApi.AccountIdentifierBase
• MobileMoneyApi.AccountName
• MobileMoneyApi.AccountStatus
• MobileMoneyApi.AccountStatusEnum
• MobileMoneyApi.Accountcategory
• MobileMoneyApi.Accountid
• MobileMoneyApi.Accountrank
• MobileMoneyApi.Address
• MobileMoneyApi.Bankaccountno
• MobileMoneyApi.BaseBatchTransaction
• MobileMoneyApi.BaseDebitMandate
• MobileMoneyApi.BaseQuotation
• MobileMoneyApi.BaseReversal
• MobileMoneyApi.BaseTransaction
• MobileMoneyApi.BatchCompletion
• MobileMoneyApi.BatchRejection
• MobileMoneyApi.BatchStatusEnum
• MobileMoneyApi.Bill
• MobileMoneyApi.BillPayment
• MobileMoneyApi.CountriesEnum
• MobileMoneyApi.CurrenciesEnum
• MobileMoneyApi.DeliveryMethodEnum
• MobileMoneyApi.Error
• MobileMoneyApi.ErrorCategoryEnum
• MobileMoneyApi.ErrorCodeEnum
• MobileMoneyApi.FrequencyTypeEnum
• MobileMoneyApi.GenderEnum
• MobileMoneyApi.Heartbeat
• MobileMoneyApi.Iban
• MobileMoneyApi.IdDocument
• MobileMoneyApi.IdTypeEnum
• MobileMoneyApi.Identityalias
• MobileMoneyApi.InternationalTransfer
• MobileMoneyApi.InternationalTransferResponse
• MobileMoneyApi.Kyc
• MobileMoneyApi.Link
• MobileMoneyApi.LinkModeEnum
• MobileMoneyApi.LinkStatusEnum
• MobileMoneyApi.Linkref
• MobileMoneyApi.MandateStatusEnum
• MobileMoneyApi.Metadata
• MobileMoneyApi.Msisdn
• MobileMoneyApi.Name
• MobileMoneyApi.NotificationMethodEnum
• MobileMoneyApi.Organisationid
• MobileMoneyApi.Patch
• MobileMoneyApi.PatchOpEnum
• MobileMoneyApi.QuotationStatusEnum
• MobileMoneyApi.Quote
• MobileMoneyApi.RequestBatchTransaction
• MobileMoneyApi.RequestDebitMandate
• MobileMoneyApi.RequestQuotation
• MobileMoneyApi.RequestReversal
• MobileMoneyApi.RequestState
• MobileMoneyApi.RequestStateStatusEnum
• MobileMoneyApi.RequestTransaction
• MobileMoneyApi.Response
• MobileMoneyApi.ResponseBatchTransaction
• MobileMoneyApi.ResponseDebitMandate
• MobileMoneyApi.ResponseLink
• MobileMoneyApi.ResponseQuotation
• MobileMoneyApi.ResponseReversal
• MobileMoneyApi.ResponseTransaction
• MobileMoneyApi.ServiceStatusEnum
• MobileMoneyApi.Sortcode
• MobileMoneyApi.StatementEntry
• MobileMoneyApi.SupplementaryBillReference
• MobileMoneyApi.Swiftbic
• MobileMoneyApi.TransactionTypeEnum
• MobileMoneyApi.Username
• MobileMoneyApi.Walletid

Documentation for Authorization

All endpoints do not require authorization.