Financial Habits

METHOD: POST

RESOURCE URL

{base-url}/api/v1/request/customer-insights/derived-attributes

Request body description

Field	Field name	Data type	Max length	Required	Description
1	identificationType	String	10	True	Either 'bvn' or 'phone'
2	yearMonth	String	7	True	The month and year in yyyy-MM

Response message description

Field	Field name	Data type	Description
1	responseCode	String	Response code of the request
2	responseMessage	String	Response mesaage of the request
3	data	Object	Response data containing the records of spending behaviour and pattern assigned to the identification Number and the date range

Sample Request

{
    "phone":"2347030393164",
    "yearMonth":"2024-07"
}

_Sample Response

{
    "responseCode": "00",
    "responseMessage": "Successful",
    "data": {
        "ageGroup": "Millennial",
        "spendingHabit": {
            "behaviouralCategory": "Shopper",
            "peakTransactionDay": "Saturday",
            "peakDayFrequency": 1,
            "peakPeriod": "Morning"
        },
        "percentDebitToPercentCreditMonthly": "100.0 %",
        "topSpendLocations": [
            "PAYCOM NIGERIA LIMITED JAYPAUL HOUSELANG",
            "TEAMAPT LIMITED LA LANG",
            "BAXI---------- IMO--RRN719915229889 LANG"
        ],
        "topInflowSource": [
            "PAYCOM NIGERIA LIMITED JAYPAUL HOUSELANG",
            "TEAMAPT LIMITED LA LANG",
            "BAXI---------- IMO--RRN719915229889 LANG"
        ]
    }
}