MOBILE MONEY CASH
CHECKOUT API
API DOCUMENTATION
NOVEMBER 13, 2021
RONFORD DIGITAL LIMITED
VERSION 1.0
Document Version
Amendments in this document include issues cleared and changes applied.
Version Date Issued Description
Version 1.0 13 November 2021 Initial Draft
INDEX
Table of Contents
Introduction .....................................................................................................................3
API Implementation ..........................................................................................................4
Account Validation................................................................................................................... 4
Cash Out Request..................................................................................................................... 4
Final Result Callback ................................................................................................................ 5
Mobile Money Cash Out API
Documentation
Introduction
NCBA Uganda has integrated to Airtel Money and MTN Money for wallet to bank and Bank
to wallet services. The bank aims at using these integrations to offer more value-added
services to its customers. One of these services is to enable bank customers make cash
withdrawals at NCBA Bank ATMs from their Airtel Money and MTN Money wallets.
This document is meant to describe how integrate with the bank’s mobile money gateway for
cash out services from different bank channels with focus on branches and ATMS.
API Implementation
This defines the expected integrations from channels initiating cash out and the eventual
callback to complete a transaction.
Account Validation
This service will be used to make a call from SPG to fetch details of a bank account through
CM.
Method Post
Endpoint https://localhost/momowebapi/cashout/validate
Type REST, application/json
Request Template {
"RequestId":"12345667",
"Mobile":"25677123456",
"Service":"AM",
"ChannelId":4
}
Response Template {
"RequestId":"12345667",
"Status":"Valid",
"Name":"John Doe"
}
Request Parameters
Parameter Data Type Required Description
RequestId Guid String YES Request identifier
Mobile String YES Mobile Number to Validate
Service String YES Service identifier, for this case we have
1. AM – Airtel Money
2. MM – MTN Monet
ChannelId Integer YES Assigned channel id for the channel
originating the validation request.
Response Parameters
Parameter Data Type Required Description
RequestId Guid String YES Request identifier
Status String YES Indicates whether the account is valid
or not
Name String YES Registered name of the mobile number
Cash Out Request
This service will be used to initiate a cash out request. Request will be sent from channel to
Momo Service. Momo service will respond with an acknowledgment
Method Post
Endpoint https://localhost/momowebapi/cashout/request
Type REST, application/json
Request Template {
"RequestId":"12345667",
"Mobile":"25677123456",
"Service":"AM",
"Amount":90000,
"ChannelId":4,
"CallbackUrl":"[Channel CallbackUrl]"
}
Response Template {
"RequestId":"12345667",
"Status":"PENDING"
}
Request Parameters
Parameter Data Type Required Description
RequestID Guid String YES Request identifier
Mobile String YES Mobile Number to cash out from
Service String YES Service identifier, for this case we have
1. AM – Airtel Money
2. MM – MTN Monet
Amount String YES Amount to cash out
ChannelId Integer YES Assigned channel id for the channel
originating the validation request.
CallBackUrl string YES The channel url to post final result to
Response Parameters
Parameter Data Type Required Description
RequestId Guid String YES Request identifier
Status String YES Indicates whether the merchant has
been registered or not. The results can
be:
COMPLETED – Cash out request has
been completed
PENDING – Cash out request is
pending
FAILED – Cash out request failed
Final Result Callback
This service is triggered from the MOMO service after the MNO responds with a status of on
the push Request.
Method Post
Endpoint To be provided by channel
Type REST, application/json
Request Template {
"RequestId":"GuidString",
"MNO_ID":"123456789",
"Amount":"string",
"Status":"COMPLETED”
}
Response Template {
"RequestId":"GuidString",
"Status":"200"
}
Request Parameters
Parameter Data Type Required Description
RequestId Guid String YES Request identifier
MNO_ID String YES MNO transaction reference
DebitCurrency String YES Currency code of the debit account.
Debit accounts will be either a
customer account or internal account
linked to the payment mode in use
Amount String YES Amount to cash out
Status String YES Indicates whether the merchant has
been registered or not. The results can
be:
COMPLETED – Cash out request has
been completed
PENDING – Cash out request is
pending
FAILED – Cash out request failed
Response Parameters
Parameter Data Type Required Description
RequestId Guid String YES Request identifier
Status String YES Indicates whether the merchant has
been registered or not. The results can
be:
COMPLETED – Transaction posted
successfully
FAILED – Transaction failed to post
