{ "info": { "name": "MTN Customer Transaction Summaries API", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Retrieve summary data of a customers transactions", "description": "", "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" } ] }, "method": "Get", "header": { "3": { "key": "transactionId", "name": "transactionId", "value": "", "type": "string", "description": "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." }, "4": { "key": "Content-Type", "name": "Content-Type", "value": "application\/json", "type": "application\/json", "description": "" } }, "url": { "raw": "api.mtn.com\/customers\/{customerId}\/transactions-summaries", "protocol": "https", "host": [ "api", "mtn", "com" ], "path": [ "v1", "customers", "customers", "{customerId}", "transactions-summaries" ], "query": [ { "key": "startDate", "value": "", "required": 0, "type": "string", "description": "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" }, { "key": "endDate", "value": "", "required": 0, "type": "string", "description": "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" } ] } }, "response": [ { "code": 200, "status": "OK", "name": "OK", "schema": { "requestId": { "type": "string", "description": "The requestId that was used by the client" }, "dateRange": { "type": "string", "description": "The date range used by the client, to request customer data for a specific time period" }, "data": { "marketingFlag": { "type": "boolean", "description": "Flag set for this partner, or should this should be an object, of flags per partner" }, "lendingFlag": { "type": "boolean", "description": "This should be an object, of flags per partner" }, "momo": { "withdrawals": { "lastWithdrawalsDate": { "type": "string", "format": "date", "description": "the " }, "maxWithdrawals-6months": { "type": "string", "description": "the " }, "quantities": { "numberOfWithdrawals-1months": { "type": "string", "description": "the " }, "numberOfWithdrawals-3months": { "type": "string", "description": "the " }, "numberOfWithdrawals-6months": { "type": "string", "description": "the " } }, "amounts": { "totalWithdrawalsAmounts-1months": { "type": "string", "description": "the " }, "totalWithdrawalsAmounts-3months": { "type": "string", "description": "the " }, "totalWithdrawalsAmounts-6months": { "type": "string", "description": "the " } }, "acceptors": { "numberOfAcceptors-1months": { "type": "string", "description": "the " }, "numberOfAcceptors-3months": { "type": "string", "description": "the " }, "numberOfAcceptors-6months": { "type": "string", "description": "the " } } }, "deposits": { "lastDepositsDate": { "type": "string", "format": "date", "description": "the ", "example": "2017" }, "maxDeposits-6months": { "type": "string", "description": "the " }, "quantities": { "numberOfDeposits-1months": { "type": "string", "description": "the " }, "numberOfDeposits-3months": { "type": "string", "description": "the " }, "numberOfDeposits-6months": { "type": "string", "description": "the " } }, "amounts": { "amountOfDeposits-1months": { "type": "string", "description": "the " }, "amountOfDeposits-3months": { "type": "string", "description": "the " }, "amountOfDeposits-6months": { "type": "string", "description": "the " } }, "acceptors": { "numberOfAcceptors-1months": { "type": "string", "description": "the " }, "numberOfAcceptors-3months": { "type": "string", "description": "the " }, "numberOfAcceptors-6months": { "type": "string", "description": "the " } } }, "billPayments": { "lastBillPaymentsDate": { "type": "string", "format": "date", "description": "the ", "example": "2017" }, "maxBillPayments-6months": { "type": "string", "description": "the " }, "quantities": { "numberOfBillPayments-1months": { "type": "string", "description": "the " }, "numberOfBillPayments-3months": { "type": "string", "description": "the " }, "numberOfBillPayments-6months": { "type": "string", "description": "the " } }, "amounts": { "amountOfBillPayments-1months": { "type": "string", "description": "the " }, "amountOfBillPayments-3months": { "type": "string", "description": "the " }, "amountOfBillPayments-6months": { "type": "string", "description": "the " } }, "acceptors": { "numberOfAcceptors-1months": { "type": "string", "description": "the " }, "numberOfAcceptors-3months": { "type": "string", "description": "the " }, "numberOfAcceptors-6months": { "type": "string", "description": "the " } } }, "send": { "lastSendDate": { "type": "string", "format": "date", "description": "the ", "example": "2017" }, "maxSend-6months": { "type": "string", "description": "the " }, "quantities": { "numberOfSend-1months": { "type": "string", "description": "the " }, "numberOfSend-3months": { "type": "string", "description": "the " }, "numberOfSend-6months": { "type": "string", "description": "the " } }, "amounts": { "amountOfSend-1months": { "type": "string", "description": "the " }, "amountOfSend-3months": { "type": "string", "description": "the " }, "amountOfSend-6months": { "type": "string", "description": "the " } }, "acceptors": { "numberOfAcceptors-1months": { "type": "string", "description": "the " }, "numberOfAcceptors-3months": { "type": "string", "description": "the " }, "numberOfAcceptors-6months": { "type": "string", "description": "the " } } }, "received": { "lastReceivedDate": { "type": "string", "format": "date", "description": "the ", "example": "2017" }, "time-periods": { "1-months": { "totalReceived": { "type": "string", "description": "the " }, "totalAcceptors": { "type": "string", "description": "the " }, "quantityReceived": { "type": "string", "description": "the " } }, "3-months": { "totalReceived": { "type": "string", "description": "the " }, "totalAcceptors": { "type": "string", "description": "the " }, "quantityReceived": { "type": "string", "description": "the " } }, "6-months": { "totalReceived": { "type": "string", "description": "the " }, "totalAcceptors": { "type": "string", "description": "the " }, "quantityReceived": { "type": "string", "description": "the " }, "maxReceived": { "type": "string", "description": "the " } } } }, "transfers": { "lastTransfersDate": { "type": "string", "format": "date", "description": "the ", "example": "2017" }, "time-periods": { "1-months": { "totalTransfers": { "type": "string", "description": "the " }, "totalAcceptors": { "type": "string", "description": "the " }, "quantityTransfers": { "type": "string", "description": "the " } }, "3-months": { "totalTransfers": { "type": "string", "description": "the " }, "totalAcceptors": { "type": "string", "description": "the " }, "quantityTransfers": { "type": "string", "description": "the " } }, "6-months": { "totalTransfers": { "type": "string" }, "totalAcceptors": { "type": "string", "description": "the " }, "quantityTransfers": { "type": "string", "description": "the " }, "maxTransfers": { "type": "string", "description": "the " } } } } }, "gsm": { "activity": { "daysSinceLastActive": { "type": "string", "description": "Number of days since last activity" }, "topupMethod": { "type": "string", "description": "Method used to topup airtime (and data?). Should this be a enum, of known types?" }, "time-periods": { "1-months": { "numberOfActiveDays": { "type": "string", "description": "the " }, "numberOfTimesBlocked": { "type": "string", "description": "Number of times blocked (post- \uf0fc paid), for the last 1 month" }, "airtimeUtilisation": { "type": "string", "description": "the " }, "daysAirtimeBalanceBelow": { "type": "string", "description": "Days Airtime Below XX, based on UMD, for the last 1 month" }, "topupAmount": { "type": "string", "description": "Network Topup Amount, for the last 1 month" }, "averageTopupAmount": { "type": "string", "description": "the " }, "totalOutboundCalls": { "type": "string", "description": "Number of outbound calls, for the last 1 month " }, "distinctOutboundCalls": { "type": "string", "description": "Number of Number of distinct outbound B-Parties , for the last 1 month " }, "totalInboundCalls": { "type": "string", "description": "Number of inbound calls, for the last 1 month " }, "distinctInboundCalls": { "type": "string", "description": "Number of distinct inbound B-Parties , for the last 1 month " }, "dataUsage": { "type": "string", "description": "Data usage in MB, for the last 1 month " }, "lastDataBundlePurchaseDate": { "type": "string", "description": "Date of last data bundle purchase (any data bundle), for the last 1 month " }, "daysDataBalanceBelow": { "type": "string", "description": "Days bundle balance less then 2MB, for the last 1 month" }, "averageDataBundleSize": { "type": "string", "description": "Average bundle size purchased, for the last 1 month" }, "me2u": { "me2uNumberAirtimeReceived": { "type": "string", "description": "Number of MTN Me2U airtime received, for the last 1 month" }, "me2uAmountAirtimeReceived": { "type": "string", "description": "Amount of MTN Me2U airtime received, for the last 1 month" } } }, "3-months": { "numberOfActiveDays": { "type": "string", "description": "the " }, "numberOfTimesBlocked": { "type": "string", "description": "Number of times blocked (post-paid), for the last 1 month" }, "airtimeUtilisation": { "type": "string", "description": "the " }, "daysAirtimeBalanceBelow": { "type": "string", "description": "Days Airtime Below XX, based on UMD, for the last 1 month" }, "topupAmount": { "type": "string", "description": "Network Topup Amount, for the last 3 months " }, "averageTopupAmount": { "type": "string", "description": "the " }, "totalOutboundCalls": { "type": "string", "description": "Number of outbound calls, for the last 1 month " }, "distinctOutboundCalls": { "type": "string", "description": "Number of Number of distinct outbound B-Parties , for the last 1 month " }, "totalInboundCalls": { "type": "string", "description": "Number of inbound calls, for the last 1 month " }, "distinctInboundCalls": { "type": "string", "description": "Number of distinct inbound B-Parties , for the last 1 month " }, "dataUsage": { "type": "string", "description": "Data usage in MB, for the last 1 month " }, "lastDataBundlePurchaseDate": { "type": "string", "description": "Date of last data bundle purchase (any data bundle), for the last 1 month " }, "daysDataBalanceBelow": { "type": "string", "description": "Days bundle balance less then 2MB, for the last 1 month" }, "averageDataBundleSize": { "type": "string", "description": "Average bundle size purchased, for the last 1 month" }, "me2u": { "me2uNumberAirtimeReceived": { "type": "string", "description": "Number of MTN Me2U airtime received, for the last 1 month" }, "me2uAmountAirtimeReceived": { "type": "string", "description": "Amount of MTN Me2U airtime received, for the last 1 month" } } }, "6-months": { "numberOfActiveDays": { "type": "string", "description": "the " }, "numberOfTimesBlocked": { "type": "string", "description": "Number of times blocked (post-paid), for the last 1 month" }, "airtimeUtilisation": { "type": "string", "description": "the " }, "daysAirtimeBalanceBelow": { "type": "string", "description": "Days Airtime Below XX, based on UMD, for the last 1 month" }, "topupAmount": { "type": "string", "description": "Network Topup Amount, for the last 6 months " }, "averageTopupAmount": { "type": "string", "description": "the " }, "totalOutboundCalls": { "type": "string", "description": "Number of outbound calls, for the last 1 month " }, "distinctOutboundCalls": { "type": "string", "description": "Number of Number of distinct outbound B-Parties , for the last 1 month " }, "totalInboundCalls": { "type": "string", "description": "Number of inbound calls, for the last 1 month " }, "distinctInboundCalls": { "type": "string", "description": "Number of distinct inbound B-Parties , for the last 1 month " }, "dataUsage": { "type": "string", "description": "Data usage in MB, for the last 1 month " }, "lastDataBundlePurchaseDate": { "type": "string", "description": "Date of last data bundle purchase (any data bundle), for the last 1 month " }, "daysDataBalanceBelow": { "type": "string", "description": "Days bundle balance less then 2MB, for the last 1 month" }, "averageDataBundleSize": { "type": "string", "description": "Average bundle size purchased, for the last 1 month" }, "me2u": { "me2uNumberAirtimeReceived": { "type": "string", "description": "Number of MTN Me2U airtime received, for the last 1 month" }, "me2uAmountAirtimeReceived": { "type": "string", "description": "Amount of MTN Me2U airtime received, for the last 1 month" } } } } } }, "momo-loans": { "time-periods": { "1-months": { "numberOfLoans": { "type": "string", "description": "Number of loans, for the last 1 month" } }, "3-months": { "numberOfLoans": { "type": "string", "description": "Number of loans, for the last 1 month" } }, "6-months": { "numberOfLoans": { "type": "string", "description": "Number of loans, for the last 1 month" } } }, "totalLoansAmount": { "type": "string", "description": "tTotal loan amount" }, "firstLoansDate": { "type": "string", "format": "date", "description": "First loan date" }, "lastLoansDate": { "type": "string", "format": "date", "description": "Last loan date" }, "numberOverdue": { "type": "string", "description": "Number of loans overdue" }, "totalTerm": { "type": "string", "description": "Total loan term" }, "maxTerm": { "type": "string", "description": "Maximum loan term" }, "lastOverdueDate": { "type": "string", "format": "date", "description": "Last time loan was overdue" } } } }, "body": "{\"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\"}}}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] } ] } ] }