Download
Download Postman collection Download SwaggerAvailable endpoints
GET v1/customers/customers/{customerId}/transactions-summaries
200OK
requestId string
The requestId that was used by the clientdateRange string
The date range used by the client, to request customer data for a specific time perioddata
marketingFlag boolean
Flag set for this partner, or should this should be an object, of flags per partnerlendingFlag boolean
This should be an object, of flags per partnermomo
withdrawals
lastWithdrawalsDate string
themaxWithdrawals-6months string
thequantities
numberOfWithdrawals-1months string
thenumberOfWithdrawals-3months string
thenumberOfWithdrawals-6months string
theamounts
totalWithdrawalsAmounts-1months string
thetotalWithdrawalsAmounts-3months string
thetotalWithdrawalsAmounts-6months string
theacceptors
numberOfAcceptors-1months string
thenumberOfAcceptors-3months string
thenumberOfAcceptors-6months string
thedeposits
lastDepositsDate string
themaxDeposits-6months string
thequantities
numberOfDeposits-1months string
thenumberOfDeposits-3months string
thenumberOfDeposits-6months string
theamounts
amountOfDeposits-1months string
theamountOfDeposits-3months string
theamountOfDeposits-6months string
theacceptors
numberOfAcceptors-1months string
thenumberOfAcceptors-3months string
thenumberOfAcceptors-6months string
thebillPayments
lastBillPaymentsDate string
themaxBillPayments-6months string
thequantities
numberOfBillPayments-1months string
thenumberOfBillPayments-3months string
thenumberOfBillPayments-6months string
theamounts
amountOfBillPayments-1months string
theamountOfBillPayments-3months string
theamountOfBillPayments-6months string
theacceptors
numberOfAcceptors-1months string
thenumberOfAcceptors-3months string
thenumberOfAcceptors-6months string
thesend
lastSendDate string
themaxSend-6months string
thequantities
numberOfSend-1months string
thenumberOfSend-3months string
thenumberOfSend-6months string
theamounts
amountOfSend-1months string
theamountOfSend-3months string
theamountOfSend-6months string
theacceptors
numberOfAcceptors-1months string
thenumberOfAcceptors-3months string
thenumberOfAcceptors-6months string
thereceived
lastReceivedDate string
thetime-periods
1-months
totalReceived string
thetotalAcceptors string
thequantityReceived string
the3-months
totalReceived string
thetotalAcceptors string
thequantityReceived string
the6-months
totalReceived string
thetotalAcceptors string
thequantityReceived string
themaxReceived string
thetransfers
lastTransfersDate string
thetime-periods
1-months
totalTransfers string
thetotalAcceptors string
thequantityTransfers string
the3-months
totalTransfers string
thetotalAcceptors string
thequantityTransfers string
the6-months
totalTransfers string
totalAcceptors string
thequantityTransfers string
themaxTransfers string
thegsm
activity
daysSinceLastActive string
Number of days since last activitytopupMethod string
Method used to topup airtime (and data?). Should this be a enum, of known types?time-periods
1-months
numberOfActiveDays string
thenumberOfTimesBlocked string
Number of times blocked (post- paid), for the last 1 monthairtimeUtilisation string
thedaysAirtimeBalanceBelow string
Days Airtime Below XX, based on UMD, for the last 1 monthtopupAmount string
Network Topup Amount, for the last 1 monthaverageTopupAmount string
thetotalOutboundCalls string
Number of outbound calls, for the last 1 monthdistinctOutboundCalls string
Number of Number of distinct outbound B-Parties , for the last 1 monthtotalInboundCalls string
Number of inbound calls, for the last 1 monthdistinctInboundCalls string
Number of distinct inbound B-Parties , for the last 1 monthdataUsage string
Data usage in MB, for the last 1 monthlastDataBundlePurchaseDate string
Date of last data bundle purchase (any data bundle), for the last 1 monthdaysDataBalanceBelow string
Days bundle balance less then 2MB, for the last 1 monthaverageDataBundleSize string
Average bundle size purchased, for the last 1 monthme2u
me2uNumberAirtimeReceived string
Number of MTN Me2U airtime received, for the last 1 monthme2uAmountAirtimeReceived string
Amount of MTN Me2U airtime received, for the last 1 month3-months
numberOfActiveDays string
thenumberOfTimesBlocked string
Number of times blocked (post-paid), for the last 1 monthairtimeUtilisation string
thedaysAirtimeBalanceBelow string
Days Airtime Below XX, based on UMD, for the last 1 monthtopupAmount string
Network Topup Amount, for the last 3 monthsaverageTopupAmount string
thetotalOutboundCalls string
Number of outbound calls, for the last 1 monthdistinctOutboundCalls string
Number of Number of distinct outbound B-Parties , for the last 1 monthtotalInboundCalls string
Number of inbound calls, for the last 1 monthdistinctInboundCalls string
Number of distinct inbound B-Parties , for the last 1 monthdataUsage string
Data usage in MB, for the last 1 monthlastDataBundlePurchaseDate string
Date of last data bundle purchase (any data bundle), for the last 1 monthdaysDataBalanceBelow string
Days bundle balance less then 2MB, for the last 1 monthaverageDataBundleSize string
Average bundle size purchased, for the last 1 monthme2u
me2uNumberAirtimeReceived string
Number of MTN Me2U airtime received, for the last 1 monthme2uAmountAirtimeReceived string
Amount of MTN Me2U airtime received, for the last 1 month6-months
numberOfActiveDays string
thenumberOfTimesBlocked string
Number of times blocked (post-paid), for the last 1 monthairtimeUtilisation string
thedaysAirtimeBalanceBelow string
Days Airtime Below XX, based on UMD, for the last 1 monthtopupAmount string
Network Topup Amount, for the last 6 monthsaverageTopupAmount string
thetotalOutboundCalls string
Number of outbound calls, for the last 1 monthdistinctOutboundCalls string
Number of Number of distinct outbound B-Parties , for the last 1 monthtotalInboundCalls string
Number of inbound calls, for the last 1 monthdistinctInboundCalls string
Number of distinct inbound B-Parties , for the last 1 monthdataUsage string
Data usage in MB, for the last 1 monthlastDataBundlePurchaseDate string
Date of last data bundle purchase (any data bundle), for the last 1 monthdaysDataBalanceBelow string
Days bundle balance less then 2MB, for the last 1 monthaverageDataBundleSize string
Average bundle size purchased, for the last 1 monthme2u
me2uNumberAirtimeReceived string
Number of MTN Me2U airtime received, for the last 1 monthme2uAmountAirtimeReceived string
Amount of MTN Me2U airtime received, for the last 1 monthmomo-loans
time-periods
1-months
numberOfLoans string
Number of loans, for the last 1 month3-months
numberOfLoans string
Number of loans, for the last 1 month6-months
numberOfLoans string
Number of loans, for the last 1 monthtotalLoansAmount string
tTotal loan amountfirstLoansDate string
First loan datelastLoansDate string
Last loan datenumberOverdue string
Number of loans overduetotalTerm string
Total loan termmaxTerm string
Maximum loan termlastOverdueDate string
Last time loan was overdue{
"requestId": "string",
"dateRange": "string",
"data": {
"marketingFlag": true,
"lendingFlag": true,
"momo": {
"withdrawals": {
"lastWithdrawalsDate": "string",
"maxWithdrawals-6months": "string",
"quantities": {
"numberOfWithdrawals-1months": "string",
"numberOfWithdrawals-3months": "string",
"numberOfWithdrawals-6months": "string"
},
"amounts": {
"totalWithdrawalsAmounts-1months": "string",
"totalWithdrawalsAmounts-3months": "string",
"totalWithdrawalsAmounts-6months": "string"
},
"acceptors": {
"numberOfAcceptors-1months": "string",
"numberOfAcceptors-3months": "string",
"numberOfAcceptors-6months": "string"
}
},
"deposits": {
"lastDepositsDate": "string",
"maxDeposits-6months": "string",
"quantities": {
"numberOfDeposits-1months": "string",
"numberOfDeposits-3months": "string",
"numberOfDeposits-6months": "string"
},
"amounts": {
"amountOfDeposits-1months": "string",
"amountOfDeposits-3months": "string",
"amountOfDeposits-6months": "string"
},
"acceptors": {
"numberOfAcceptors-1months": "string",
"numberOfAcceptors-3months": "string",
"numberOfAcceptors-6months": "string"
}
},
"billPayments": {
"lastBillPaymentsDate": "string",
"maxBillPayments-6months": "string",
"quantities": {
"numberOfBillPayments-1months": "string",
"numberOfBillPayments-3months": "string",
"numberOfBillPayments-6months": "string"
},
"amounts": {
"amountOfBillPayments-1months": "string",
"amountOfBillPayments-3months": "string",
"amountOfBillPayments-6months": "string"
},
"acceptors": {
"numberOfAcceptors-1months": "string",
"numberOfAcceptors-3months": "string",
"numberOfAcceptors-6months": "string"
}
},
"send": {
"lastSendDate": "string",
"maxSend-6months": "string",
"quantities": {
"numberOfSend-1months": "string",
"numberOfSend-3months": "string",
"numberOfSend-6months": "string"
},
"amounts": {
"amountOfSend-1months": "string",
"amountOfSend-3months": "string",
"amountOfSend-6months": "string"
},
"acceptors": {
"numberOfAcceptors-1months": "string",
"numberOfAcceptors-3months": "string",
"numberOfAcceptors-6months": "string"
}
},
"received": {
"lastReceivedDate": "string",
"time-periods": {
"1-months": {
"totalReceived": "string",
"totalAcceptors": "string",
"quantityReceived": "string"
},
"3-months": {
"totalReceived": "string",
"totalAcceptors": "string",
"quantityReceived": "string"
},
"6-months": {
"totalReceived": "string",
"totalAcceptors": "string",
"quantityReceived": "string",
"maxReceived": "string"
}
}
},
"transfers": {
"lastTransfersDate": "string",
"time-periods": {
"1-months": {
"totalTransfers": "string",
"totalAcceptors": "string",
"quantityTransfers": "string"
},
"3-months": {
"totalTransfers": "string",
"totalAcceptors": "string",
"quantityTransfers": "string"
},
"6-months": {
"totalTransfers": "string",
"totalAcceptors": "string",
"quantityTransfers": "string",
"maxTransfers": "string"
}
}
}
},
"gsm": {
"activity": {
"daysSinceLastActive": "string",
"topupMethod": "string",
"time-periods": {
"1-months": {
"numberOfActiveDays": "string",
"numberOfTimesBlocked": "string",
"airtimeUtilisation": "string",
"daysAirtimeBalanceBelow": "string",
"topupAmount": "string",
"averageTopupAmount": "string",
"totalOutboundCalls": "string",
"distinctOutboundCalls": "string",
"totalInboundCalls": "string",
"distinctInboundCalls": "string",
"dataUsage": "string",
"lastDataBundlePurchaseDate": "string",
"daysDataBalanceBelow": "string",
"averageDataBundleSize": "string",
"me2u": {
"me2uNumberAirtimeReceived": "string",
"me2uAmountAirtimeReceived": "string"
}
},
"3-months": {
"numberOfActiveDays": "string",
"numberOfTimesBlocked": "string",
"airtimeUtilisation": "string",
"daysAirtimeBalanceBelow": "string",
"topupAmount": "string",
"averageTopupAmount": "string",
"totalOutboundCalls": "string",
"distinctOutboundCalls": "string",
"totalInboundCalls": "string",
"distinctInboundCalls": "string",
"dataUsage": "string",
"lastDataBundlePurchaseDate": "string",
"daysDataBalanceBelow": "string",
"averageDataBundleSize": "string",
"me2u": {
"me2uNumberAirtimeReceived": "string",
"me2uAmountAirtimeReceived": "string"
}
},
"6-months": {
"numberOfActiveDays": "string",
"numberOfTimesBlocked": "string",
"airtimeUtilisation": "string",
"daysAirtimeBalanceBelow": "string",
"topupAmount": "string",
"averageTopupAmount": "string",
"totalOutboundCalls": "string",
"distinctOutboundCalls": "string",
"totalInboundCalls": "string",
"distinctInboundCalls": "string",
"dataUsage": "string",
"lastDataBundlePurchaseDate": "string",
"daysDataBalanceBelow": "string",
"averageDataBundleSize": "string",
"me2u": {
"me2uNumberAirtimeReceived": "string",
"me2uAmountAirtimeReceived": "string"
}
}
}
}
},
"momo-loans": {
"time-periods": {
"1-months": {
"numberOfLoans": "string"
},
"3-months": {
"numberOfLoans": "string"
},
"6-months": {
"numberOfLoans": "string"
}
},
"totalLoansAmount": "string",
"firstLoansDate": "string",
"lastLoansDate": "string",
"numberOverdue": "string",
"totalTerm": "string",
"maxTerm": "string",
"lastOverdueDate": "string"
}
}
}