v1

latestOpenAPI 3.1.02026-08-04490133.8 KB

Mobile Money Collection

This is for the momo collection for Kenya, Rwanda, Uganda and Ghana. The OTP object in the payload is an optional field, it's only needed when your business account isn't whitelisted for verifying phone numbers before collections, using the collection OTP endpoint. If you have a system in place to verify phone numbers in your app then reach out to us to whitelist your account so you can proceed to integrate this collection API without the need for a phone number verification endpoint(OTP collection)

post/collections/momo

Request body

phonestring required

Phone number in international format

amountinteger required

Amount as a number

countrystring required

The country you are collecting from. Options are UG, KE, GH, RW, CM, CI, TZ

currencystring required

Currency you're collecting. Options are UGX, KES, GHS, RWF

customerstring json

An optional JSON object with customer information e.g. '{"email":"john@example.com"}'

transactionRefstring

Optional unique alphanumeric string set by the client

redirectUrlstring

This is required when your collection country is GH and currency is GHS. This is necessary so after phone number verification, it redirects the user back to your system after successful collection

Response

200

codeinteger

successboolean

Example response

{
  "code": 200,
  "data": {
    "transactionId": "BE31650891443685",
    "transactionRef": "ADR234526534",
    "type": "collection",
    "currency": "UGX",
    "amount": "2000",
    "customer": {
      "email": "john@example.com"
    },
    "status": "pending",
    "createdAt": "2022-04-25T12:57:41.444Z",
    "updatedAt": "2022-04-25T12:57:41.445Z"
  },
  "success": true
}