Transaction Summaries v1

AVAILABLE IN

Download

Download Postman collection Download Swagger

Available endpoints

GET v1/customers/customers/{customerId}/transactions-summaries

Header parameters

transactionId string

Client generated Id to include for tracing requests, so that the API can easily trace the HTTP request all the way from a client to MTN's backend processes (via our proxies). Each time a request is made to an MTN API the client should include a unique request reference in the HTTP Header. The value must be between 5 and 20 characters, and consist of ASCII letters, digits, or the characters +, /, =, and -. Invalid or blank IDs will be ignored and replaced with generated ones. MTN may use this to detect duplicate transactions from the client, but this functionality is not always guaranteed, so clients must make their own efforts to prevent duplicate transactions. MTN will also log the transactionId in order to assist with debugging and to correlate transactions processed by the API to requests from the client.

Content-Type application/json

Auth parameters

apikey x-api-key

Query parameters

startDate string

An optional parameter, together with endDate, allows developers to specify a time range by which to query customer data on. If you want to request data for 2 months, then start date will need to be set to 2 months prior to today, and endDate to todays date. If this is not set, the date range will be defaulted to 6 months

endDate string

200OK

requestId string

The requestId that was used by the client

dateRange string

The date range used by the client, to request customer data for a specific time period

data

marketingFlag boolean

Flag set for this partner, or should this should be an object, of flags per partner

lendingFlag boolean

This should be an object, of flags per partner

momo

withdrawals

lastWithdrawalsDate string

the

maxWithdrawals-6months string

the

quantities

numberOfWithdrawals-1months string

the

numberOfWithdrawals-3months string

the

numberOfWithdrawals-6months string

the

amounts

totalWithdrawalsAmounts-1months string

the

totalWithdrawalsAmounts-3months string

the

totalWithdrawalsAmounts-6months string

the

acceptors

numberOfAcceptors-1months string

the

numberOfAcceptors-3months string

the

numberOfAcceptors-6months string

the

deposits

lastDepositsDate string

the

maxDeposits-6months string

the

quantities

numberOfDeposits-1months string

the

numberOfDeposits-3months string

the

numberOfDeposits-6months string

the

amounts

amountOfDeposits-1months string

the

amountOfDeposits-3months string

the

amountOfDeposits-6months string

the

acceptors

numberOfAcceptors-1months string

the

numberOfAcceptors-3months string

the

numberOfAcceptors-6months string

the

billPayments

lastBillPaymentsDate string

the

maxBillPayments-6months string

the

quantities

numberOfBillPayments-1months string

the

numberOfBillPayments-3months string

the

numberOfBillPayments-6months string

the

amounts

amountOfBillPayments-1months string

the

amountOfBillPayments-3months string

the

amountOfBillPayments-6months string

the

acceptors

numberOfAcceptors-1months string

the

numberOfAcceptors-3months string

the

numberOfAcceptors-6months string

the

send

lastSendDate string

the

maxSend-6months string

the

quantities

numberOfSend-1months string

the

numberOfSend-3months string

the

numberOfSend-6months string

the

amounts

amountOfSend-1months string

the

amountOfSend-3months string

the

amountOfSend-6months string

the

acceptors

numberOfAcceptors-1months string

the

numberOfAcceptors-3months string

the

numberOfAcceptors-6months string

the

received

lastReceivedDate string

the

time-periods

1-months

totalReceived string

the

totalAcceptors string

the

quantityReceived string

the

3-months

totalReceived string

the

totalAcceptors string

the

quantityReceived string

the

6-months

totalReceived string

the

totalAcceptors string

the

quantityReceived string

the

maxReceived string

the

transfers

lastTransfersDate string

the

time-periods

1-months

totalTransfers string

the

totalAcceptors string

the

quantityTransfers string

the

3-months

totalTransfers string

the

totalAcceptors string

the

quantityTransfers string

the

6-months

totalTransfers string

totalAcceptors string

the

quantityTransfers string

the

maxTransfers string

the

gsm

activity

daysSinceLastActive string

Number of days since last activity

topupMethod string

Method used to topup airtime (and data?). Should this be a enum, of known types?

time-periods

1-months

numberOfActiveDays string

the

numberOfTimesBlocked string

Number of times blocked (post-  paid), for the last 1 month

airtimeUtilisation string

the

daysAirtimeBalanceBelow string

Days Airtime Below XX, based on UMD, for the last 1 month

topupAmount string

Network Topup Amount, for the last 1 month

averageTopupAmount string

the

totalOutboundCalls string

Number of outbound calls, for the last 1 month

distinctOutboundCalls string

Number of Number of distinct outbound B-Parties , for the last 1 month

totalInboundCalls string

Number of inbound calls, for the last 1 month

distinctInboundCalls string

Number of distinct inbound B-Parties , for the last 1 month

dataUsage string

Data usage in MB, for the last 1 month

lastDataBundlePurchaseDate string

Date of last data bundle purchase (any data bundle), for the last 1 month

daysDataBalanceBelow string

Days bundle balance less then 2MB, for the last 1 month

averageDataBundleSize string

Average bundle size purchased, for the last 1 month

me2u

me2uNumberAirtimeReceived string

Number of MTN Me2U airtime received, for the last 1 month

me2uAmountAirtimeReceived string

Amount of MTN Me2U airtime received, for the last 1 month

3-months

numberOfActiveDays string

the

numberOfTimesBlocked string

Number of times blocked (post-paid), for the last 1 month

airtimeUtilisation string

the

daysAirtimeBalanceBelow string

Days Airtime Below XX, based on UMD, for the last 1 month

topupAmount string

Network Topup Amount, for the last 3 months

averageTopupAmount string

the

totalOutboundCalls string

Number of outbound calls, for the last 1 month

distinctOutboundCalls string

Number of Number of distinct outbound B-Parties , for the last 1 month

totalInboundCalls string

Number of inbound calls, for the last 1 month

distinctInboundCalls string

Number of distinct inbound B-Parties , for the last 1 month

dataUsage string

Data usage in MB, for the last 1 month

lastDataBundlePurchaseDate string

Date of last data bundle purchase (any data bundle), for the last 1 month

daysDataBalanceBelow string

Days bundle balance less then 2MB, for the last 1 month

averageDataBundleSize string

Average bundle size purchased, for the last 1 month

me2u

me2uNumberAirtimeReceived string

Number of MTN Me2U airtime received, for the last 1 month

me2uAmountAirtimeReceived string

Amount of MTN Me2U airtime received, for the last 1 month

6-months

numberOfActiveDays string

the

numberOfTimesBlocked string

Number of times blocked (post-paid), for the last 1 month

airtimeUtilisation string

the

daysAirtimeBalanceBelow string

Days Airtime Below XX, based on UMD, for the last 1 month

topupAmount string

Network Topup Amount, for the last 6 months

averageTopupAmount string

the

totalOutboundCalls string

Number of outbound calls, for the last 1 month

distinctOutboundCalls string

Number of Number of distinct outbound B-Parties , for the last 1 month

totalInboundCalls string

Number of inbound calls, for the last 1 month

distinctInboundCalls string

Number of distinct inbound B-Parties , for the last 1 month

dataUsage string

Data usage in MB, for the last 1 month

lastDataBundlePurchaseDate string

Date of last data bundle purchase (any data bundle), for the last 1 month

daysDataBalanceBelow string

Days bundle balance less then 2MB, for the last 1 month

averageDataBundleSize string

Average bundle size purchased, for the last 1 month

me2u

me2uNumberAirtimeReceived string

Number of MTN Me2U airtime received, for the last 1 month

me2uAmountAirtimeReceived string

Amount of MTN Me2U airtime received, for the last 1 month

momo-loans

time-periods

1-months

numberOfLoans string

Number of loans, for the last 1 month

3-months

numberOfLoans string

Number of loans, for the last 1 month

6-months

numberOfLoans string

Number of loans, for the last 1 month

totalLoansAmount string

tTotal loan amount

firstLoansDate string

First loan date

lastLoansDate string

Last loan date

numberOverdue string

Number of loans overdue

totalTerm string

Total loan term

maxTerm string

Maximum loan term

lastOverdueDate string

Last time loan was overdue

{
    "requestId": [],
    "dateRange": [],
    "data": []
}

Check out some of our other products.

MTN

Retrieve usage history, OOB usage charge and recharge history details for a particular subscriber MSISDN

+ 3 more

View

MTN

View the product

View

MTN

Manages customer rewards for various services

View