Profiles v2

AVAILABLE IN

Ghana

Download

Download Postman collection Download Swagger

Available endpoints

GET v1/customers/customers/{customerId}

Description

Retrieves the customer profile of a MTN customer. The customer profile includes 4 main objects: Location (Country and Operator), Billing Plan and related details, Subscriptions for VAS and Digital Services, Loans details, and Transactions Summaries

Header parameters

Content-Type application/json

Query parameters

propset string
the set of data to be retrieved. There are 2 options - `basic` will retrieve only the structure of the customer profile including the links to each resource, will `full` will retrieve all the data for each resource, which will be en expensive call. If not specified, the default will be `basic`"
200OK
customerId string
locations
data
country string
The country that the customer MSISDN was provisioned in.
operator string
The network operator that the customer MSISDN was provisioned for.
_link
self
href string
plans
data
type string
The billing type of the plan.
status string
The current status of the plan.
startDate string
The date the customer was created/provisioned
endDate string
The date the plan will be deactivated.
balance
data
balanceType string
Identifies the type of balance. A customer plan may have multiple types of balances for different usage, for example, voice, SMS, and game services.
amount string
Amount of balance.
currency string
ISO 4217 three-letter ISO code for the currency.
expiryDate string
Expiry Date of the account.
_link
self
href string
loans
data
_link
self
href string
status string
transactionId string
_link
self
href string
account
data
accountName string
accountId string
description string
Detailed description of account
status string
_links
self
href string
type string
kyc
data
idType string
Legal ID Type
idNumber string
Legal ID Number/Reference
dateOfBirth string
Date of Birth
gender string
Male,Female
firstName string
Name
lastName string
Surname
_link
self
href string
devices
data
devices
deviceId string
an identifier for each device. This will be a unique key per device, the format will be a string
deviceMake string
Make of current device
IMSI string
Last known IMSI. Relates to the SIM used by the MSISDN
IMEI string
Last known IMEI. Unique identifier of Mobile Device used by the MSISDN
timePeriods
unit string
month,days
value string
the value of the timePeriods 'unit' field. E.g. if unit is 'month', then this will represent how many months
numberOfIMSIs string
The number of unique IMSIs that was used by the MSISDN in the last measured period
numberOfIMEIs string
The number of unique IMEI’s that was used by the MSISDN in the last measured period
primaryUCID string
Primary Unique Customer Id
primaryUSID string
Primary Unique Service Id
secondaryUCID string
Secondary Unique Customer Id
secondaryUSID string
Secondary Unique Service Id
_links
self
href string
transactions-summaries
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
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
_links
self
href string
{
    "customerId": "string",
    "locations": {
        "data": {
            "country": "string",
            "operator": "string"
        },
        "_link": {
            "self": {
                "href": "string"
            }
        }
    },
    "plans": {
        "data": {
            "type": "string",
            "status": "string",
            "startDate": "string",
            "endDate": "string",
            "balance": {
                "data": {
                    "balanceType": "string",
                    "amount": "string",
                    "currency": "string",
                    "expiryDate": "string"
                }
            }
        },
        "_link": {
            "self": {
                "href": "string"
            }
        }
    },
    "loans": {
        "data": {
            "_link": {
                "self": {
                    "href": "string"
                }
            },
            "status": "string",
            "transactionId": "string"
        },
        "_link": {
            "self": {
                "href": "string"
            }
        }
    },
    "account": {
        "data": {
            "accountName": "string",
            "accountId": "string",
            "description": "string",
            "status": "string"
        },
        "_links": {
            "self": {
                "href": "string",
                "type": "string"
            }
        }
    },
    "kyc": {
        "data": {
            "idType": "string",
            "idNumber": "string",
            "dateOfBirth": "string",
            "gender": "string",
            "firstName": "string",
            "lastName": "string"
        },
        "_link": {
            "self": {
                "href": "string"
            }
        }
    },
    "devices": {
        "data": {
            "devices": {
                "deviceId": "string",
                "deviceMake": "string",
                "IMSI": "string",
                "IMEI": "string",
                "timePeriods": {
                    "unit": "string",
                    "value": "string"
                },
                "numberOfIMSIs": "string",
                "numberOfIMEIs": "string",
                "primaryUCID": "string",
                "primaryUSID": "string",
                "secondaryUCID": "string",
                "secondaryUSID": "string"
            }
        },
        "_links": {
            "self": {
                "href": "string"
            }
        }
    },
    "transactions-summaries": {
        "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"
                            }
                        }
                    }
                }
            },
            "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"
            }
        }
    },
    "_links": {
        "self": {
            "href": "string"
        }
    }
}
207Multi-Status
400Bad Request
error string
error_description string
{
    "error": "string",
    "error_description": "string"
}
401Unauthorized
error string
error_description string
{
    "error": "string",
    "error_description": "string"
}
403Forbidden
error string
error_description string
{
    "error": "string",
    "error_description": "string"
}
404Not Found
405Method Not Allowed
timestamp string
Error response code
status string
Text explaining the reason for the error
error string
message string
More error details and corrective measures
path string
{
    "timestamp": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
500Internal Server Error
timestamp string
Error response code
status string
Text explaining the reason for the error
error string
message string
More error details and corrective measures
path string
{
    "timestamp": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}