/collections/mobile-money

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

This endpoint allows you to request a payment from customers by using their phone number enabled for mobile money.

At the point of payment, the customer is required to authorize the payment on their mobile phones. The status of the collection request would be pay-offline.
Once you get this status, you should notify the customer to complete the authorization process on their mobile phones and then listen for webhook notification or requery the collection request status endpoint at interval.

Response Schema:

{
    "status": boolean,
    "message": string,
    "data": {
	    "id": string,
	    "initiatedAt": date-time,
	    "completedAt": date-time | null,
	    "amount": string,
	    "fee": string | null,
	    "bearer": "merchant" | "customer",
	    "currency": string,
	    "reference": string,
	    "lencoReference": string,
	    "type": "mobile-money",
	    "status": "pending" | "successful" | "failed" | "pay-offline",
	    "source": "api",
	    "reasonForFailure": string | null,
	    "settlementStatus": "pending" | "settled" | null,
	    "settlement": null,
	    "mobileMoneyDetails": {
	        "country": string,
	        "phone": string,
	        "operator": string,
	        "accountName": string | null,
	        "operatorTransactionId": string | null,
	    } | null,
	    "bankAccountDetails": null,
	    "cardDetails": null,
	}
}

📘

You can use any of the accounts listed here to test mobile money collections in the sandbox environment

Body Params
double
required
string
required

Unique reference. Only -, ., _ and alphanumeric characters allowed

string
required
string
enum
required

For Zambia, either airtel, or mtn
For Malawi, either airtel, or tnm

Allowed:
string
enum

Optional. Either zm (Zambia), or mw (Malawi)

Allowed:
string
enum
Defaults to merchant

Optional. Decide who will bear the fee. Either merchant (you), or customer (your customer)

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json