MTN MoMo API Client for Node JS.
Add the library to your project
npm install mtn-momoTo get sandbox credentials; install the package globally and run the momo-sandbox command or install the package locally to your project and run momo-sandbox with the npx command.
## Within a project
npm install --save momoapi-node
npx momo-sandbox --host example.com --primary-key 23e2r2er2342blahblah
## Globally
npm install --global momoapi-node
momo-sandbox --host example.com --primary-key 23e2r2er2342blahblahThe collections client can be created with the following paramaters;
baseUrl: An optional base url to the MTN Momo API. By default the staging base url will be usedenvironment: Optional enviroment, either "sandbox" or "production". Sandbox by defaulthost: The domain where you webhooks urls are hosted;subscriptionKey: Find this on the MTN Momo API dashboarduserId: For production, find your Collections User ID on MTN Momo API dashboard. For sandbox, use the one generated with themomo-sandboxcommand for sandboxuserSecret: For production, find your Collections User Secret on MTN Momo API dashboard. For sandbox, use the one generated with themomo-sandboxcommand for sandbox
You can create a collections client with the following;
const momo = require("mtn-momo");
const collections = new momo.Collections({
baseUrl: "the api base url",
userSecret: "your api secret",
userId: "your api user id",
subscriptionKey: "your primary or secondary key",
environment: "sandbox" or "production",
callbackHost: "your callback host"
});requestToPay(request: PaymentRequest): Promise<string>
This method inititates a payment. The user can then authorise to it with their PIN. It returns a promise that resolves the transaction id. You can use the transaction id to check the transaction status, check the nmethod below.
-
getTransactionStatus(transactionId: string): Promise<Transaction> -
getAccountBalance(): Promise<AccountBalance>
// Request to pay
collections
.requestToPay({
amount: "50",
currency: "EUR",
externalId: "123456",
payer: {
partyIdType: "MSISDN",
partyId: "256774290781"
},
payerMessage: "testing",
payeeNote: "hello"
})
.then(transactionId => {
console.log({ transactionId });
// Get transaction status
return collections.getTransactionStatus(transactionId);
})
.then(transactionStatus => {
console.log({ transactionStatus });
// Get account balance
return collections.getAccountBalance();
})
.then(accountBalance => console.log({ accountBalance }))
.catch(error => {
if (error.response && error.response.data) {
console.log(error.response.data);
}
console.log(error.message);
});Clone this repository and compile
git clone git@github.com:sparkplug/momoapi-node.git
cd momoapi-node
npm install
npm run compile
npm link # to test and develop cli tooling in development