# 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](https://github.com/swagger-api/swagger-codegen) project: - API version: 0.14 - Package version: 0.14 - Build package: io.swagger.codegen.languages.JavascriptClientCodegen ## Installation ### For [Node.js](https://nodejs.org/) #### npm To publish the library as a [npm](https://www.npmjs.com/), please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages). Then install it via: ```shell 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: ```shell npm install YOUR_USERNAME/mobile_money_api --save ``` ### For browser The library also works in the browser environment via npm and [browserify](http://browserify.org/). 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): ```shell browserify main.js > bundle.js ``` Then include *bundle.js* in the HTML pages. ## Getting Started Please follow the [installation](#installation) instruction and execute the following JS code: ```javascript 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**](docs/DefaultApi.md#accountsAccountIdAccountnameGet) | **GET** /accounts/{accountId}/accountname | View Account Name *MobileMoneyApi.DefaultApi* | [**accountsAccountIdBalanceGet**](docs/DefaultApi.md#accountsAccountIdBalanceGet) | **GET** /accounts/{accountId}/balance | View Account Balance *MobileMoneyApi.DefaultApi* | [**accountsAccountIdBillsBillReferencePaymentsPost**](docs/DefaultApi.md#accountsAccountIdBillsBillReferencePaymentsPost) | **POST** /accounts/{accountId}/bills/{billReference}/payments | Create A Bill Payment *MobileMoneyApi.DefaultApi* | [**accountsAccountIdBillsGet**](docs/DefaultApi.md#accountsAccountIdBillsGet) | **GET** /accounts/{accountId}/bills | View Account Bills *MobileMoneyApi.DefaultApi* | [**accountsAccountIdDebitmandatesDebitMandateReferenceGet**](docs/DefaultApi.md#accountsAccountIdDebitmandatesDebitMandateReferenceGet) | **GET** /accounts/{accountId}/debitmandates/{debitMandateReference} | View A Debit Mandate *MobileMoneyApi.DefaultApi* | [**accountsAccountIdDebitmandatesDebitMandateReferencePatch**](docs/DefaultApi.md#accountsAccountIdDebitmandatesDebitMandateReferencePatch) | **PATCH** /accounts/{accountId}/debitmandates/{debitMandateReference} | Update A Debit Mandate *MobileMoneyApi.DefaultApi* | [**accountsAccountIdDebitmandatesPost**](docs/DefaultApi.md#accountsAccountIdDebitmandatesPost) | **POST** /accounts/{accountId}/debitmandates | Create A Debit Mandate *MobileMoneyApi.DefaultApi* | [**accountsAccountIdLinksLinkReferenceGet**](docs/DefaultApi.md#accountsAccountIdLinksLinkReferenceGet) | **GET** /accounts/{accountId}/links/{linkReference} | View A Link *MobileMoneyApi.DefaultApi* | [**accountsAccountIdLinksLinkReferencePatch**](docs/DefaultApi.md#accountsAccountIdLinksLinkReferencePatch) | **PATCH** /accounts/{accountId}/links/{linkReference} | Update A Link *MobileMoneyApi.DefaultApi* | [**accountsAccountIdLinksPost**](docs/DefaultApi.md#accountsAccountIdLinksPost) | **POST** /accounts/{accountId}/links | Create A Link *MobileMoneyApi.DefaultApi* | [**accountsAccountIdStatemententriesGet**](docs/DefaultApi.md#accountsAccountIdStatemententriesGet) | **GET** /accounts/{accountId}/statemententries | View Account Statements *MobileMoneyApi.DefaultApi* | [**accountsAccountIdStatusGet**](docs/DefaultApi.md#accountsAccountIdStatusGet) | **GET** /accounts/{accountId}/status | View Account Status *MobileMoneyApi.DefaultApi* | [**accountsAccountIdTransactionsGet**](docs/DefaultApi.md#accountsAccountIdTransactionsGet) | **GET** /accounts/{accountId}/transactions | View Account Specific Transaction *MobileMoneyApi.DefaultApi* | [**accountsMsisdnMsisdnAccountnameGet**](docs/DefaultApi.md#accountsMsisdnMsisdnAccountnameGet) | **GET** /accounts/msisdn/{msisdn}/accountname | View Account Name *MobileMoneyApi.DefaultApi* | [**accountsMsisdnMsisdnBalanceGet**](docs/DefaultApi.md#accountsMsisdnMsisdnBalanceGet) | **GET** /accounts/msisdn/{msisdn}/balance | View Account Balance *MobileMoneyApi.DefaultApi* | [**accountsMsisdnMsisdnBillsBillReferencePaymentsPost**](docs/DefaultApi.md#accountsMsisdnMsisdnBillsBillReferencePaymentsPost) | **POST** /accounts/msisdn/{msisdn}/bills/{billReference}/payments | Create A Bill Payment *MobileMoneyApi.DefaultApi* | [**accountsMsisdnMsisdnBillsGet**](docs/DefaultApi.md#accountsMsisdnMsisdnBillsGet) | **GET** /accounts/msisdn/{msisdn}/bills | View Account Bills *MobileMoneyApi.DefaultApi* | [**accountsMsisdnMsisdnDebitmandatesDebitMandateReferenceGet**](docs/DefaultApi.md#accountsMsisdnMsisdnDebitmandatesDebitMandateReferenceGet) | **GET** /accounts/msisdn/{msisdn}/debitmandates/{debitMandateReference} | View A Debit Mandate *MobileMoneyApi.DefaultApi* | [**accountsMsisdnMsisdnDebitmandatesDebitMandateReferencePatch**](docs/DefaultApi.md#accountsMsisdnMsisdnDebitmandatesDebitMandateReferencePatch) | **PATCH** /accounts/msisdn/{msisdn}/debitmandates/{debitMandateReference} | Update A Debit Mandate *MobileMoneyApi.DefaultApi* | [**accountsMsisdnMsisdnDebitmandatesPost**](docs/DefaultApi.md#accountsMsisdnMsisdnDebitmandatesPost) | **POST** /accounts/msisdn/{msisdn}/debitmandates | Create A Debit Mandate *MobileMoneyApi.DefaultApi* | [**accountsMsisdnMsisdnLinksLinkReferenceGet**](docs/DefaultApi.md#accountsMsisdnMsisdnLinksLinkReferenceGet) | **GET** /accounts/msisdn/{msisdn}/links/{linkReference} | View A Link *MobileMoneyApi.DefaultApi* | [**accountsMsisdnMsisdnLinksLinkReferencePatch**](docs/DefaultApi.md#accountsMsisdnMsisdnLinksLinkReferencePatch) | **PATCH** /accounts/msisdn/{msisdn}/links/{linkReference} | Update A Link *MobileMoneyApi.DefaultApi* | [**accountsMsisdnMsisdnLinksPost**](docs/DefaultApi.md#accountsMsisdnMsisdnLinksPost) | **POST** /accounts/msisdn/{msisdn}/links | Create A Link *MobileMoneyApi.DefaultApi* | [**accountsMsisdnMsisdnStatemententriesGet**](docs/DefaultApi.md#accountsMsisdnMsisdnStatemententriesGet) | **GET** /accounts/msisdn/{msisdn}/statemententries | View Account Statements *MobileMoneyApi.DefaultApi* | [**accountsMsisdnMsisdnStatusGet**](docs/DefaultApi.md#accountsMsisdnMsisdnStatusGet) | **GET** /accounts/msisdn/{msisdn}/status | View Account Status *MobileMoneyApi.DefaultApi* | [**accountsMsisdnMsisdnTransactionsGet**](docs/DefaultApi.md#accountsMsisdnMsisdnTransactionsGet) | **GET** /accounts/msisdn/{msisdn}/transactions | View Account Specific Transaction *MobileMoneyApi.DefaultApi* | [**batchtransactionsBatchIdCompletionsGet**](docs/DefaultApi.md#batchtransactionsBatchIdCompletionsGet) | **GET** /batchtransactions/{batchId}/completions | View Batch Completions *MobileMoneyApi.DefaultApi* | [**batchtransactionsBatchIdGet**](docs/DefaultApi.md#batchtransactionsBatchIdGet) | **GET** /batchtransactions/{batchId} | View A Transaction Batch *MobileMoneyApi.DefaultApi* | [**batchtransactionsBatchIdPatch**](docs/DefaultApi.md#batchtransactionsBatchIdPatch) | **PATCH** /batchtransactions/{batchId} | Update A Transaction Batch *MobileMoneyApi.DefaultApi* | [**batchtransactionsBatchIdRejectionsGet**](docs/DefaultApi.md#batchtransactionsBatchIdRejectionsGet) | **GET** /batchtransactions/{batchId}/rejections | View Batch Rejections *MobileMoneyApi.DefaultApi* | [**batchtransactionsPost**](docs/DefaultApi.md#batchtransactionsPost) | **POST** /batchtransactions | Create A Transaction Batch *MobileMoneyApi.DefaultApi* | [**billsBillReferencePaymentsPost**](docs/DefaultApi.md#billsBillReferencePaymentsPost) | **POST** /bills/{billReference}/payments | Create A Bill Payment *MobileMoneyApi.DefaultApi* | [**heartbeatGet**](docs/DefaultApi.md#heartbeatGet) | **GET** /heartbeat | Check API availability *MobileMoneyApi.DefaultApi* | [**quotationsPost**](docs/DefaultApi.md#quotationsPost) | **POST** /quotations | Create A New Quotation *MobileMoneyApi.DefaultApi* | [**quotationsQuotationReferenceGet**](docs/DefaultApi.md#quotationsQuotationReferenceGet) | **GET** /quotations/{quotationReference} | View A Quotation *MobileMoneyApi.DefaultApi* | [**quotationsQuotationReferencePatch**](docs/DefaultApi.md#quotationsQuotationReferencePatch) | **PATCH** /quotations/{quotationReference} | Update A Quotation *MobileMoneyApi.DefaultApi* | [**requeststatesServerCorrelationIdGet**](docs/DefaultApi.md#requeststatesServerCorrelationIdGet) | **GET** /requeststates/{serverCorrelationId} | View A Request State *MobileMoneyApi.DefaultApi* | [**requeststatesServerCorrelationIdPatch**](docs/DefaultApi.md#requeststatesServerCorrelationIdPatch) | **PATCH** /requeststates/{serverCorrelationId} | Update A Request State *MobileMoneyApi.DefaultApi* | [**responsesClientCorrelationIdGet**](docs/DefaultApi.md#responsesClientCorrelationIdGet) | **GET** /responses/{clientCorrelationId} | View A Response *MobileMoneyApi.DefaultApi* | [**statemententriesTransactionReferenceGet**](docs/DefaultApi.md#statemententriesTransactionReferenceGet) | **GET** /statemententries/{transactionReference} | View Specific Statement *MobileMoneyApi.DefaultApi* | [**transactionsPost**](docs/DefaultApi.md#transactionsPost) | **POST** /transactions | Create A Transaction *MobileMoneyApi.DefaultApi* | [**transactionsTransactionReferenceGet**](docs/DefaultApi.md#transactionsTransactionReferenceGet) | **GET** /transactions/{transactionReference} | View A Transaction *MobileMoneyApi.DefaultApi* | [**transactionsTransactionReferenceReversalsPost**](docs/DefaultApi.md#transactionsTransactionReferenceReversalsPost) | **POST** /transactions/{transactionReference}/reversals | Create A Reversal ## Documentation for Models - [MobileMoneyApi.AccountBalance](docs/AccountBalance.md) - [MobileMoneyApi.AccountIdentifierBase](docs/AccountIdentifierBase.md) - [MobileMoneyApi.AccountName](docs/AccountName.md) - [MobileMoneyApi.AccountStatus](docs/AccountStatus.md) - [MobileMoneyApi.AccountStatusEnum](docs/AccountStatusEnum.md) - [MobileMoneyApi.Accountcategory](docs/Accountcategory.md) - [MobileMoneyApi.Accountid](docs/Accountid.md) - [MobileMoneyApi.Accountrank](docs/Accountrank.md) - [MobileMoneyApi.Address](docs/Address.md) - [MobileMoneyApi.Bankaccountno](docs/Bankaccountno.md) - [MobileMoneyApi.BaseBatchTransaction](docs/BaseBatchTransaction.md) - [MobileMoneyApi.BaseDebitMandate](docs/BaseDebitMandate.md) - [MobileMoneyApi.BaseQuotation](docs/BaseQuotation.md) - [MobileMoneyApi.BaseReversal](docs/BaseReversal.md) - [MobileMoneyApi.BaseTransaction](docs/BaseTransaction.md) - [MobileMoneyApi.BatchCompletion](docs/BatchCompletion.md) - [MobileMoneyApi.BatchRejection](docs/BatchRejection.md) - [MobileMoneyApi.BatchStatusEnum](docs/BatchStatusEnum.md) - [MobileMoneyApi.Bill](docs/Bill.md) - [MobileMoneyApi.BillPayment](docs/BillPayment.md) - [MobileMoneyApi.CountriesEnum](docs/CountriesEnum.md) - [MobileMoneyApi.CurrenciesEnum](docs/CurrenciesEnum.md) - [MobileMoneyApi.DeliveryMethodEnum](docs/DeliveryMethodEnum.md) - [MobileMoneyApi.Error](docs/Error.md) - [MobileMoneyApi.ErrorCategoryEnum](docs/ErrorCategoryEnum.md) - [MobileMoneyApi.ErrorCodeEnum](docs/ErrorCodeEnum.md) - [MobileMoneyApi.FrequencyTypeEnum](docs/FrequencyTypeEnum.md) - [MobileMoneyApi.GenderEnum](docs/GenderEnum.md) - [MobileMoneyApi.Heartbeat](docs/Heartbeat.md) - [MobileMoneyApi.Iban](docs/Iban.md) - [MobileMoneyApi.IdDocument](docs/IdDocument.md) - [MobileMoneyApi.IdTypeEnum](docs/IdTypeEnum.md) - [MobileMoneyApi.Identityalias](docs/Identityalias.md) - [MobileMoneyApi.InternationalTransfer](docs/InternationalTransfer.md) - [MobileMoneyApi.InternationalTransferResponse](docs/InternationalTransferResponse.md) - [MobileMoneyApi.Kyc](docs/Kyc.md) - [MobileMoneyApi.Link](docs/Link.md) - [MobileMoneyApi.LinkModeEnum](docs/LinkModeEnum.md) - [MobileMoneyApi.LinkStatusEnum](docs/LinkStatusEnum.md) - [MobileMoneyApi.Linkref](docs/Linkref.md) - [MobileMoneyApi.MandateStatusEnum](docs/MandateStatusEnum.md) - [MobileMoneyApi.Metadata](docs/Metadata.md) - [MobileMoneyApi.Msisdn](docs/Msisdn.md) - [MobileMoneyApi.Name](docs/Name.md) - [MobileMoneyApi.NotificationMethodEnum](docs/NotificationMethodEnum.md) - [MobileMoneyApi.Organisationid](docs/Organisationid.md) - [MobileMoneyApi.Patch](docs/Patch.md) - [MobileMoneyApi.PatchOpEnum](docs/PatchOpEnum.md) - [MobileMoneyApi.QuotationStatusEnum](docs/QuotationStatusEnum.md) - [MobileMoneyApi.Quote](docs/Quote.md) - [MobileMoneyApi.RequestBatchTransaction](docs/RequestBatchTransaction.md) - [MobileMoneyApi.RequestDebitMandate](docs/RequestDebitMandate.md) - [MobileMoneyApi.RequestQuotation](docs/RequestQuotation.md) - [MobileMoneyApi.RequestReversal](docs/RequestReversal.md) - [MobileMoneyApi.RequestState](docs/RequestState.md) - [MobileMoneyApi.RequestStateStatusEnum](docs/RequestStateStatusEnum.md) - [MobileMoneyApi.RequestTransaction](docs/RequestTransaction.md) - [MobileMoneyApi.Response](docs/Response.md) - [MobileMoneyApi.ResponseBatchTransaction](docs/ResponseBatchTransaction.md) - [MobileMoneyApi.ResponseDebitMandate](docs/ResponseDebitMandate.md) - [MobileMoneyApi.ResponseLink](docs/ResponseLink.md) - [MobileMoneyApi.ResponseQuotation](docs/ResponseQuotation.md) - [MobileMoneyApi.ResponseReversal](docs/ResponseReversal.md) - [MobileMoneyApi.ResponseTransaction](docs/ResponseTransaction.md) - [MobileMoneyApi.ServiceStatusEnum](docs/ServiceStatusEnum.md) - [MobileMoneyApi.Sortcode](docs/Sortcode.md) - [MobileMoneyApi.StatementEntry](docs/StatementEntry.md) - [MobileMoneyApi.SupplementaryBillReference](docs/SupplementaryBillReference.md) - [MobileMoneyApi.Swiftbic](docs/Swiftbic.md) - [MobileMoneyApi.TransactionTypeEnum](docs/TransactionTypeEnum.md) - [MobileMoneyApi.Username](docs/Username.md) - [MobileMoneyApi.Walletid](docs/Walletid.md) ## Documentation for Authorization All endpoints do not require authorization.