5.1.1 Paydirect Dataset<\/strong><\/h3>\n\n\n\n

Description:  <\/strong>This endpoint enables the caller to get selected purchase information for customers using the paydirect collections channel over a specified period.<\/p>\n\n\n\n

Request Data Description<\/strong><\/p>\n\n\n\n

#<\/td>	Field Name<\/td>	Data Type<\/td>	Max Length \/ Format(s)<\/td>	Required<\/td>	Description<\/td><\/tr>
2<\/td>	start-date<\/td>	Date<\/td>	YYYY-MM-dd,yyyy-MM-dd HH:mm,yyyy-MM-dd HH:mm:ss<\/td>	Yes<\/td>	This field specifies the start date for dataset reports generation.If a time value is added, it uses the time value.Else if no time-value is added, it deafults to T00:00:00<\/td><\/tr>
3<\/td>	end-date<\/td>	Date<\/td>	YYYY-MM-dd,yyyy-MM-dd HH:mm,yyyy-MM-dd HH:mm:ss<\/td>	Yes<\/td>	This field specifies the end date to be used for dataset reports generation.If a time value is added, is uses the time value.Else if no time-value is added, it deafults to T23:59:59:999<\/td><\/tr>
4<\/td>	client-name<\/td>	String<\/td>	<\/td>	Yes<\/td>	This field specifies the name of the client as registered on the paydirect collections channel.<\/td><\/tr>
5<\/td>	page-number<\/td>	integer<\/td>	<\/td>	Yes<\/td>	For Pagination: query parameter for the current page being requested<\/td><\/tr>
6<\/td>	page-size<\/td>	integer<\/td>	<\/td>	Yes<\/td>	For Paginated: query parameter for the number of records to return per page<\/td><\/tr><\/tbody><\/table>\n\n\n\n Endpoint<\/strong><\/p>\n\n\n\n {{baseurl}}\/api\/v1\/request\/collections\/paydirect\/start-date\/{start-date}\/end-date\/{end-date}\/client-name\/{client-name}?page-number=1&page-size=30<\/strong><\/p>\n\n\n\n Sample request call:<\/strong><\/p>\n\n\n\n {{baseurl}}\/api\/v1\/request\/collections\/paydirect\/start-date\/2020-01-01\/end-date\/2020-06-01\/client-name\/Other_Client?page-number=1&page-size=30<\/strong><\/p>\n\n\n\n Headers:<\/strong><\/p>\n\n\n\n HTTP Method:<\/strong> GET<\/strong><\/p>\n\n\n\n Authentication:<\/strong> User Access Token or Client Access Token<\/p>\n\n\n\n Sample Response<\/strong><\/p>\n\n\n\n Description<\/strong><\/p>\n\n\n\n #<\/td> Field Name<\/td> Data Type<\/td> Description<\/td><\/tr> 1<\/td> responseCode<\/td> String<\/td> The code representing the state of the response, it show whether the response was a success or not. NB: “00” is the code for success<\/td><\/tr> 2<\/td> responseMessage<\/td> String<\/td> The description that explains the responseCode from above <\/td><\/tr> 3<\/td> dateRange<\/td> String<\/td> The date range between the start date and end date<\/td><\/tr> 4<\/td> data<\/td> Object<\/td> The section that contains the actual data requested by the request<\/td><\/tr> 5<\/td> count<\/td> String<\/td> The total number of records available for the specified timeframe<\/td><\/tr> 6<\/td> content<\/td> Object<\/td> The list that contains the paginated paydirect records for the timeframe<\/td><\/tr> 7<\/td> paymentDate<\/td> DateTime<\/td> The date and time for which this specific transaction was made<\/td><\/tr> 8<\/td> amount<\/td> Number<\/td> Amount paid for this specific transaction<\/td><\/tr> 9<\/td> productName<\/td> String<\/td> Merchant specified name for this products<\/td><\/tr> 10<\/td> customerName<\/td> String<\/td> Name of client using paydirect to pay merchant<\/td><\/tr> 11<\/td> paymentMethod<\/td> String<\/td> Payment Method used by client to pay merchant<\/td><\/tr> 12<\/td> paymentRef<\/td> String<\/td> Unique reference number generated for this specific transaction<\/td><\/tr> 13<\/td> bankName<\/td> String<\/td> Name of transaction bank<\/td><\/tr><\/tbody><\/table>\n\n\n\n Success sample response<\/strong><\/p>\n\n\n\n Response : { “responseCode”: “00”, “responseMessage”: “Successful”, “dateRange”: “Weekly”, “data”: { “count”: 121988, “content”: [ { “paymentDate”: “2020-08-01 00:00:06.180”, “amount”: “1600.00”, “productName”: “Bet 9Ja”, “customerName”: “ISAAC OBINNA”, “paymentMethod”: “Debit Card”, “paymentRef”: “ACB|MOB|4ACB0001|BJA|010820000006|FJXXRMJB”, “bankName”: “Access Bank Nigeria Plc” }, ….. ] } }<\/td><\/tr><\/tbody><\/table>\n\n\n\n 5.1.2 RetailPay Dataset<\/strong><\/h3>\n\n\n\n Description:  <\/strong>This endpoint enables the caller to get selected purchase information for customers using the retailPay collections channel over a specified period.<\/p>\n\n\n\n Request Data Description<\/strong><\/p>\n\n\n\n #<\/td> Field Name<\/td> Data Type<\/td> Max Length \/ Format(s)<\/td> Required<\/td> Description<\/td><\/tr> 1<\/td> start-date<\/td> Date<\/td> YYYY-MM-dd,yyyy-MM-dd HH:mm,yyyy-MM-dd HH:mm:ss<\/td> Yes<\/td> This field specifies the start date for dataset reports generation.If a time value is added, it uses the time value.Else if no time-value is added, it deafults to T00:00:00<\/td><\/tr> 2<\/td> end-date<\/td> Date<\/td> YYYY-MM-dd,yyyy-MM-dd HH:mm,yyyy-MM-dd HH:mm:ss<\/td> Yes<\/td> This field specifies the end date to be used for dataset reports generation.If a time value is added, is uses the time value.Else if no time-value is added, it deafults to T23:59:59:999<\/td><\/tr> 3<\/td> client-name<\/td> String<\/td> <\/td> Yes<\/td> This field specifies the name of the client as registered on the retailPay collections channel.<\/td><\/tr> 4<\/td> page-number<\/td> integer<\/td> <\/td> Yes<\/td> For Pagination: query parameter for the current page being requested<\/td><\/tr> 5<\/td> page-size<\/td> integer<\/td> <\/td> Yes<\/td> For Paginated: query parameter for the number of records to return per page<\/td><\/tr><\/tbody><\/table>\n\n\n\n Endpoint<\/strong><\/p>\n\n\n\n {{baseurl}}\/api\/v1\/request\/collections\/retailpay\/start-date\/{start-date}\/end-date\/{end-date}\/client-name\/{client-name}?page-number=1&page-size=30<\/strong><\/p>\n\n\n\n Sample request call:<\/strong><\/p>\n\n\n\n {{baseurl}}\/api\/v1\/request\/collections\/retailpay\/start-date\/2020-01-01\/end-date\/2020-06-01\/client-name\/Other_Client?page-number=1&page-size=30<\/strong><\/p>\n\n\n\n Headers:<\/strong><\/p>\n\n\n\n HTTP Method:<\/strong> GET<\/p>\n\n\n\n Authentication:<\/strong> User Access Token or Client Access Token<\/p>\n\n\n\n Sample Response<\/strong><\/p>\n\n\n\n Description<\/strong><\/p>\n\n\n\n #<\/td> Field Name<\/td> Data Type<\/td> Description<\/td><\/tr> 1<\/td> responseCode<\/td> String<\/td> The code representing the state of the response, it show whether the response was a success or not. NB: “00” is the code for success<\/td><\/tr> 2<\/td> responseMessage<\/td> String<\/td> The description that explains the responseCode from above <\/td><\/tr> 3<\/td> dateRange<\/td> String<\/td> The date range between the start date and end date<\/td><\/tr> 4<\/td> data<\/td> Object<\/td> The section that contains the actual data requested by the request<\/td><\/tr> 5<\/td> count<\/td> String<\/td> The total number of records available for the specified timeframe<\/td><\/tr> 6<\/td> content<\/td> Object<\/td> The list that contains the paginated retailPay records for the timeframe<\/td><\/tr> 7<\/td> datePurchased<\/td> DateTime<\/td> The date and time for which this specified purchase was made<\/td><\/tr> 8<\/td> orderPrice<\/td> Number<\/td> Amount paid for this specific order<\/td><\/tr> 9<\/td> productName<\/td> String<\/td> Merchant specified name for this products<\/td><\/tr> 10<\/td> customerCode<\/td> String<\/td> Unique customer code to identify customers<\/td><\/tr> 11<\/td> paymentMethod<\/td> String<\/td> Payment Method used by client to pay merchant<\/td><\/tr> 12<\/td> orderCode<\/td> String<\/td> Unique tracking code generated for this specific order<\/td><\/tr> 13<\/td> productDescription<\/td> String<\/td> Description bout theproduct in the order<\/td><\/tr> 14<\/td> paymentStatus<\/td> Integer<\/td> Integer that reflects the status of the transaction<\/td><\/tr><\/tbody><\/table>\n\n\n\n Success sample response<\/strong><\/p>\n\n\n\n Response : { “responseCode”: “00”, “responseMessage”: “Successful”, “dateRange”: “Weekly”, “data”: { “count”: 220671, “content”: [ { “orderCode”: “2008011347”, “customerCode”: “NULL”, “datePurchased”: “2020-08-01 03:51:20.083”, “paymentMethod”: “DmsCredit”, “paymentStatus”: “2”, “productDescription”: “AIRTEL VTU”, “orderPrice”: “50.00” }, … ] } }<\/td><\/tr><\/tbody><\/table>\n\n\n\n 5.1.3 Webpay Dataset<\/strong><\/h3>\n\n\n\n Description:  <\/strong>This endpoint enables the caller to get selected purchase information for customers using the webPay collections channel over a specified period.<\/p>\n\n\n\n Request Data Description<\/strong><\/p>\n\n\n\n #<\/td> Field Name<\/td> Data Type<\/td> Max Length \/ Format(s)<\/td> Required<\/td> Description<\/td><\/tr> 1<\/td> start-date<\/td> Date<\/td> YYYY-MM-dd,yyyy-MM-dd HH:mm,yyyy-MM-dd HH:mm:ss<\/td> Yes<\/td> This field specifies the start date for dataset reports generation.If a time value is added, it uses the time value.Else if no time-value is added, it deafults to T00:00:00<\/td><\/tr> 2<\/td> end-date<\/td> Date<\/td> YYYY-MM-dd,yyyy-MM-dd HH:mm,yyyy-MM-dd HH:mm:ss<\/td> Yes<\/td> This field specifies the end date to be used for dataset reports generation.If a time value is added, is uses the time value.Else if no time-value is added, it deafults to T23:59:59:999<\/td><\/tr> 3<\/td> client-name<\/td> String<\/td> <\/td> Yes<\/td> This field specifies the name of the client as registered on the webPay collections channel.<\/td><\/tr> 4<\/td> page-number<\/td> integer<\/td> <\/td> Yes<\/td> For Pagination: query parameter for the current page being requested<\/td><\/tr> 5<\/td> page-size<\/td> integer<\/td> <\/td> Yes<\/td> For Paginated: query parameter for the number of records to return per page<\/td><\/tr><\/tbody><\/table>\n\n\n\n Endpoint<\/strong><\/p>\n\n\n\n {{baseurl}}\/api\/v1\/request\/collections\/webpay\/start-date\/{start-date}\/end-date\/{end-date}\/client-name\/{client-name}?page-number=1&page-size=30<\/strong><\/p>\n\n\n\n Sample request call:<\/strong><\/p>\n\n\n\n {{baseurl}}\/api\/v1\/request\/collections\/webpay\/start-date\/2020-01-01 12:13\/end-date\/2020-06-01\/client-name\/Other_Client?page-number=1&page-size=30<\/strong><\/p>\n\n\n\n Headers:<\/strong><\/p>\n\n\n\n HTTP Method:<\/strong> GET<\/p>\n\n\n\n Authentication:<\/strong> User Access Token or Client Access Token<\/p>\n\n\n\n Sample Response<\/strong><\/p>\n\n\n\n Description<\/strong><\/p>\n\n\n\n #<\/td> Field Name<\/td> Data Type<\/td> Description<\/td><\/tr> 1<\/td> responseCode<\/td> String<\/td> The code representing the state of the response, it show whether the response was a success or not. NB: “00” is the code for success<\/td><\/tr> 2<\/td> responseMessage<\/td> String<\/td> The description that explains the responseCode from above <\/td><\/tr> 3<\/td> dateRange<\/td> String<\/td> The date range between the start date and end date<\/td><\/tr> 4<\/td> data<\/td> Object<\/td> The section that contains the actual data requested by the request<\/td><\/tr> 5<\/td> OldWebPay<\/td> Object<\/td> The section that contains requested data from Old webpay<\/td><\/tr> 6<\/td> NewWebPay<\/td> Object<\/td> The section that contains requested data from New webpay<\/td><\/tr><\/tbody><\/table>\n\n\n\n Success sample response<\/strong><\/p>\n\n\n\n Response : { “responseCode”: “00”, “responseMessage”: “Successful”, “dateRange”: “Monthly”, “data”: { “OldWebPay”: { “count”: 246763, “content”: [ { “paymentDate”: “2020-08-01 00:01:25.927”, “customerName”: “THE NIGERIAN STOCK EXCHANGE”, “bankCode”: “UBA”, “paymentRef”: “UBA|WEB|ENS|1-08-2020|000001”, “productName”: “Einao Solutions Web Payments”, “amount”: “11529.95” }, { “paymentDate”: “2020-08-01 00:01:32.883”, “customerName”: “3006974423”, “bankCode”: “FBP”, “paymentRef”: “FBP|WEB|QT|1-08-2020|000002”, “productName”: “Quickteller Transfer”, “amount”: “101500.00” }, …. ] }, “NewWebPay”: { “count”: 640183, “content”: [ { “paymentDate”: “2020-08-11 00:00:00.283”, “customerName”: “Jsuleiman”, “bankCode”: “033”, “paymentRef”: “315781838”, “productName”: “BetKing”, “amount”: “1000” }, { “paymentDate”: “2020-08-11 00:00:00.540”, “customerName”: “NULL”, “bankCode”: “032”, “paymentRef”: “UBANG\/FLW294606640”, “productName”: “DEFAULT_MX71”, “amount”: “100” }, …. ] } } }<\/td><\/tr><\/tbody><\/table>\n\n\n\n 5.1.4 All Collections Dataset<\/strong><\/h3>\n\n\n\n Description:  <\/strong>This endpoint enables the caller to get selected purchase information for customers on all collections channel over a specified period.<\/p>\n\n\n\n Request Data Description<\/strong><\/p>\n\n\n\n #<\/td> Field Name<\/td> Data Type<\/td> Max Length \/ Format(s)<\/td> Required<\/td> Description<\/td><\/tr> 1<\/td> start-date<\/td> Date<\/td> YYYY-MM-dd,yyyy-MM-dd HH:mm,yyyy-MM-dd HH:mm:ss<\/td> Yes<\/td> This field specifies the start date for dataset reports generation.If a time value is added, it uses the time value.Else if no time-value is added, it defaults to T00:00:00<\/td><\/tr> 2<\/td> end-date<\/td> Date<\/td> YYYY-MM-dd,yyyy-MM-dd HH:mm,yyyy-MM-dd HH:mm:ss<\/td> Yes<\/td> This field specifies the end date to be used for dataset reports generation.If a time value is added, is uses the time value.Else if no time-value is added, it defaults to T23:59:59:999<\/td><\/tr> 3<\/td> client-name<\/td> String<\/td> <\/td> Yes<\/td> This field specifies the name of the client as registered on the webPay collections channel.<\/td><\/tr> 4<\/td> page-number<\/td> integer<\/td> <\/td> Yes<\/td> For Pagination: query parameter for the current page being requested<\/td><\/tr> 5<\/td> page-size<\/td> integer<\/td> <\/td> Yes<\/td> For Paginated: query parameter for the number of records to return per page<\/td><\/tr><\/tbody><\/table>\n\n\n\n Endpoint<\/strong><\/p>\n\n\n\n {{baseurl}}\/api\/v1\/request\/collections\/start-date\/{start-date}\/end-date\/{end-date}\/client-name\/{client-name}?page-number=1&page-size=30<\/strong><\/p>\n\n\n\n Sample request call:<\/strong><\/p>\n\n\n\n {{baseurl}}\/api\/v1\/request\/collections\/start-date\/2020-01-01 12:13:43\/end-date\/2020-06-01 22:43:15\/client-name\/Other_Client?page-number=1&page-size=30<\/strong><\/p>\n\n\n\n Headers:<\/strong><\/p>\n\n\n\n HTTP Method:<\/strong> GET<\/p>\n\n\n\n Authentication:<\/strong> User Access Token or Client Access Token<\/p>\n\n\n\n Sample Response<\/strong><\/p>\n\n\n\n Description<\/strong><\/p>\n\n\n\n #<\/td> Field Name<\/td> Data Type<\/td> Description<\/td><\/tr> 1<\/td> responseCode<\/td> String<\/td> The code representing the state of the response, it show whether the response was a success or not. NB: “00” is the code for success<\/td><\/tr> 2<\/td> responseMessage<\/td> String<\/td> The description that explains the responseCode from above <\/td><\/tr> 3<\/td> dateRange<\/td> String<\/td> The date range between the start date and end date<\/td><\/tr> 4<\/td> data<\/td> Object<\/td> The section that contains the actual data requested by the request<\/td><\/tr><\/tbody><\/table>\n\n\n\n Success sample response<\/strong><\/p>\n\n\n\n Response : { “responseCode”: “00”, “responseMessage”: “Successful”, “dateRange”: “Monthly”, “data”: { RetailPay”: { “count”: 832860, “content”: [ { “orderCode”: “20080129480”, “customerCode”: “NULL”, “datePurchased”: “2020-08-01 15:46:23.203”, “paymentMethod”: “NULL”, “paymentStatus”: “0”, “productDescription”: “MTN VTU”, “orderPrice”: “1000.00” }, { “orderCode”: “20080129481”, “customerCode”: “NULL”, “datePurchased”: “2020-08-01 15:46:23.657”, “paymentMethod”: “DmsCredit”, “paymentStatus”: “2”, “productDescription”: “GLO VTU”, “orderPrice”: “100.00” }, …. ] }, “OldWebPay”: { “count”: 283394, “content”: [ { “paymentDate”: “2020-08-04 08:21:42.957”, “customerName”: “2348028231000”, “bankCode”: “UBA”, “paymentRef”: “UBA|WEB|QT|4-08-2020|000841”, “productName”: “Quickteller Transfer Agent”, “amount”: “11347.50” }, { “paymentDate”: “2020-08-04 08:21:45.220”, “customerName”: “info@kolomoni.ng”, “bankCode”: “UBA”, “paymentRef”: “UBA|WEB|QT|4-08-2020|000843”, “productName”: “Quickteller Transfer Agent”, “amount”: “8000.00” }, …. ] }, “Paydirect”: { “count”: 121988, “content”: [ { “paymentDate”: “2020-08-01 12:00:27.027”, “amount”: “1100.00”, “productName”: “Sporty Internet ltd”, “customerName”: “08122359474”, “paymentMethod”: “Debit Card”, “paymentRef”: “DBM|MOB|4DBM0001|SIT|010820120027|NXXP8W44”, “bankName”: “Access Bank Diamond” }, { “paymentDate”: “2020-08-01 12:00:27.050”, “amount”: “550.00”, “productName”: “Bet 9Ja”, “customerName”: “Onyewu Benedict”, “paymentMethod”: “Debit Card”, “paymentRef”: “FAP|MOB|4FAP0001|BJA|010820120027|MQVBU94A”, “bankName”: “First Bank of Nigeria Plc” }, …. ] }, “NewWebPay”: { “count”: 640183, “content”: [ { “paymentDate”: “2020-08-11 04:51:03.910”, “customerName”: “NULL”, “bankCode”: “044”, “paymentRef”: “PiggyV_t773251890i100081rpgvpybsv2ccm”, “productName”: “Recurring Payments”, “amount”: “200” }, { “paymentDate”: “2020-08-11 04:51:04.173”, “customerName”: “NULL”, “bankCode”: “011”, “paymentRef”: “Sporty_t773251868i107852r200811szcaue”, “productName”: “Recurring Payments”, “amount”: “50000” }, …. ] } } }<\/td><\/tr><\/tbody><\/table>\n\n\n\n 5.2 Collections Analysis<\/strong><\/h2>\n\n\n\n 5.2.1 Paydirect Analysis<\/strong><\/h3>\n\n\n\n Description:  <\/strong>This end point enables the caller to get analytical information based on paydirect collections dataset for a specified period.<\/p>\n\n\n\n Request Data Description<\/strong><\/p>\n\n\n\n #<\/td> Field Name<\/td> Data Type<\/td> Max Length \/ Format<\/td> Required<\/td> Description<\/td><\/tr> 1<\/td> startDate<\/td> Date<\/td> YYYY-MM-dd,yyyy-MM-dd HH:mm,yyyy-MM-dd HH:mm:ss<\/td> Yes<\/td> This field specifies the start date of your report. The analysis will cover all records between the value specified in this field and the endDate field.If a time value is added, it uses the time value.Else if no time-value is added, it defaults to T00:00:00<\/td><\/tr> 2<\/td> endDate<\/td> Date<\/td> YYYY-MM-dd,yyyy-MM-dd HH:mm,yyyy-MM-dd HH:mm:ss<\/td> Yes<\/td> This field specifies the analysis  report end date.If a time value is added, it uses the time value.Else if no time-value is added, it defaults to T23:59:59<\/td><\/tr> 3<\/td> clientName<\/td> String<\/td> 20<\/td> Yes<\/td> This field specifies the name of the Client of which the analysis is for.<\/td><\/tr><\/tbody><\/table>\n\n\n\n Endpoint<\/strong><\/p>\n\n\n\n {{baseurl}}\/api\/v1\/request\/collections\/paydirect-analysis\/start-date\/{start-date}\/end-date\/{end-date}\/client-name\/{client-name}<\/strong><\/p>\n\n\n\n Sample request call:<\/strong><\/p>\n\n\n\n {{baseurl}}\/api\/v1\/request\/collections\/paydirect-analysis\/start-date\/2020-01-01 12:13:43\/end-date\/2020-06-01 22:43:15\/client-name\/Some_Client<\/strong><\/p>\n\n\n\n Headers:<\/strong><\/p>\n\n\n\n HTTP Method:<\/strong> GET<\/p>\n\n\n\n Authentication:<\/strong> User Access Token or Client Access Token<\/p>\n\n\n\n Sample Response<\/strong><\/p>\n\n\n\n Description<\/strong><\/p>\n\n\n\n #<\/td> Field Name<\/td> Data Type<\/td> Description<\/td><\/tr> 1<\/td> responseCode<\/td> String<\/td> The code representing the state of the response, it show whether the response was a success or not. NB: “00” is the code for success<\/td><\/tr> 2<\/td> responseMessage<\/td> String<\/td> The description that explains the responseCode from above <\/td><\/tr> 3<\/td> dateRange<\/td> String<\/td> The date range between the start date and end date<\/td><\/tr> 4<\/td> data<\/td> Object<\/td> The section that contains the actual data requested by the request<\/td><\/tr> 5<\/td> totalCount<\/td> String<\/td> The total number of transactions for the analysis<\/td><\/tr> 6<\/td> paydirectTypeAnalysisList<\/td> List<\/td> The list of the different categories for paydirect analysis<\/td><\/tr> 7<\/td> noOfCustomers<\/td> String<\/td> Number of unique customers with the product and payment method<\/td><\/tr> 8<\/td> paymentMethod<\/td> String<\/td> Payment method within the category<\/td><\/tr> 9<\/td> productName<\/td> String<\/td> Product Name within the category<\/td><\/tr> 10<\/td> noOfTransactions<\/td> String<\/td> Number of transactions with the product and payment method<\/td><\/tr><\/tbody><\/table>\n\n\n\n Success sample response<\/strong><\/p>\n\n\n\n Response : { “responseCode”: “00”, “responseMessage”: “Successful”, “dateRange”: “6-Months”, “data”: { “totalCount”: “121988”, “paydirectTypeAnalysisList”: [ { “noOfCustomers”: “21977”, “paymentMethod”: “Debit Card”, “productName”: “Bet 9Ja”, “noOfTransactions”: “37116” }, { “noOfCustomers”: “32609”, “paymentMethod”: “Debit Card”, “productName”: “Multichoice”, “noOfTransactions”: “34790” }, { “noOfCustomers”: “5361”, “paymentMethod”: “Debit Card”, “productName”: “Sporty Internet ltd”, “noOfTransactions”: “9216” }, … ] } }<\/td><\/tr><\/tbody><\/table>\n\n\n\n 5.2.2 Retailpay Analysis<\/strong><\/h3>\n\n\n\n Description:  <\/strong>This end point enables the caller to get analytical information based on retailpay collections dataset for a specified period.<\/p>\n\n\n\n Request Data Description<\/strong><\/p>\n\n\n\n #<\/td> Field Name<\/td> Data Type<\/td> Max Length \/ Format<\/td> Required<\/td> Description<\/td><\/tr> 1<\/td> startDate<\/td> Date<\/td> YYYY-MM-dd,yyyy-MM-dd HH:mm,yyyy-MM-dd HH:mm:ss<\/td> Yes<\/td> This field specifies the start date of your report. The analysis will cover all records between the value specified in this field and the endDate field.If a time value is added, it uses the time value.Else if no time-value is added, it defaults to T00:00:00<\/td><\/tr> 2<\/td> endDate<\/td> Date<\/td> YYYY-MM-dd,yyyy-MM-dd HH:mm,yyyy-MM-dd HH:mm:ss<\/td> Yes<\/td> This field specifies the analysis  report end date.If a time value is added, it uses the time value.Else if no time-value is added, it defaults to T23:59:59<\/td><\/tr> 3<\/td> clientName<\/td> String<\/td> 20<\/td> Yes<\/td> This field specifies the name of the Client of which the analysis is for.<\/td><\/tr><\/tbody><\/table>\n\n\n\n Endpoint<\/strong><\/p>\n\n\n\n {{baseurl}}\/api\/v1\/request\/collections\/retailpay-analysis\/start-date\/{start-date}\/end-date\/{end-date}\/client-name\/{client-name}<\/strong><\/p>\n\n\n\n Sample request call:<\/strong><\/p>\n\n\n\n {{baseurl}}\/api\/v1\/request\/collections\/retailpay-analysis\/start-date\/2020-01-01 12:13:43\/end-date\/2020-06-01 22:43:15\/client-name\/Some_Client<\/strong><\/p>\n\n\n\n Headers:<\/strong><\/p>\n\n\n\n HTTP Method:<\/strong> GET<\/p>\n\n\n\n Authentication:<\/strong> User Access Token or Client Access Token<\/p>\n\n\n\n Sample Response<\/strong><\/p>\n\n\n\n Description<\/strong><\/p>\n\n\n\n #<\/td> Field Name<\/td> Data Type<\/td> Description<\/td><\/tr> 1<\/td> responseCode<\/td> String<\/td> The code representing the state of the response, it show whether the response was a success or not. NB: “00” is the code for success<\/td><\/tr> 2<\/td> responseMessage<\/td> String<\/td> The description that explains the responseCode from above <\/td><\/tr> 3<\/td> dateRange<\/td> String<\/td> The date range between the start date and end date<\/td><\/tr> 4<\/td> data<\/td> Object<\/td> The section that contains the actual data requested by the request<\/td><\/tr> 5<\/td> totalCount<\/td> String<\/td> The total number of transactions for the analysis<\/td><\/tr> 6<\/td> retailpayTypeAnalysisList<\/td> List<\/td> The list of the different categories for retailpay analysis<\/td><\/tr> 7<\/td> noOfCustomers<\/td> String<\/td> Number of unique customers with the product and payment method<\/td><\/tr> 8<\/td> paymentMethod<\/td> String<\/td> Payment method within the category<\/td><\/tr> 9<\/td> productName<\/td> String<\/td> Product Name within the category<\/td><\/tr> 10<\/td> noOfTransactions<\/td> String<\/td> Number of transactions with the product and payment method<\/td><\/tr><\/tbody><\/table>\n\n\n\n Success sample response<\/strong><\/p>\n\n\n\n Response : { “responseCode”: “00”, “responseMessage”: “Successful”, “dateRange”: “Monthly”, “data”: { “totalCount”: “611717”, “retailpayTypeAnalysisList”: [ { “noOfCustomers”: “28”, “paymentMethod”: “DmsCredit”, “productName”: “MTN VTU”, “noOfTransactions”: “329026” }, { “noOfCustomers”: “25”, “paymentMethod”: “DmsCredit”, “productName”: “AIRTEL VTU”, “noOfTransactions”: “113945” }, { “noOfCustomers”: “23”, “paymentMethod”: “DmsCredit”, “productName”: “GLO VTU”, “noOfTransactions”: “59892” }, … ] } }<\/td><\/tr><\/tbody><\/table>\n\n\n\n 5.2.3 Webpay Analysis<\/strong><\/h3>\n\n\n\n Description:  <\/strong>This end point enables the caller to get analytical information based on webpay collections dataset for a specified period.<\/p>\n\n\n\n Request Data Description<\/strong><\/p>\n\n\n\n #<\/td> Field Name<\/td> Data Type<\/td> Max Length \/ Format<\/td> Required<\/td> Description<\/td><\/tr> 1<\/td> startDate<\/td> Date<\/td> YYYY-MM-dd,yyyy-MM-dd HH:mm,yyyy-MM-dd HH:mm:ss<\/td> Yes<\/td> This field specifies the start date of your report. The analysis will cover all records between the value specified in this field and the endDate field.If a time value is added, it uses the time value.Else if no time-value is added, it defaults to T00:00:00<\/td><\/tr> 2<\/td> endDate<\/td> Date<\/td> YYYY-MM-dd,yyyy-MM-dd HH:mm,yyyy-MM-dd HH:mm:ss<\/td> Yes<\/td> This field specifies the analysis  report end date.If a time value is added, it uses the time value.Else if no time-value is added, it defaults to T23:59:59<\/td><\/tr> 3<\/td> clientName<\/td> String<\/td> 20<\/td> Yes<\/td> This field specifies the name of the Client of which the analysis is for.<\/td><\/tr><\/tbody><\/table>\n\n\n\n Endpoint<\/strong><\/p>\n\n\n\n {{baseurl}}\/api\/v1\/request\/collections\/webpay-analysis\/start-date\/{start-date}\/end-date\/{end-date}\/client-name\/{client-name}<\/strong><\/p>\n\n\n\n Sample request call:<\/strong><\/p>\n\n\n\n {{baseurl}}\/api\/v1\/request\/collections\/webpay-analysis\/start-date\/2020-01-01 12:13:43\/end-date\/2020-06-01 22:43:15\/client-name\/Some_Client<\/strong><\/p>\n\n\n\n Headers:<\/strong><\/p>\n\n\n\n HTTP Method:<\/strong> GET<\/p>\n\n\n\n Authentication:<\/strong> User Access Token or Client Access Token<\/p>\n\n\n\n Sample Response<\/strong><\/p>\n\n\n\n Description<\/strong><\/p>\n\n\n\n #<\/td> Field Name<\/td> Data Type<\/td> Description<\/td><\/tr> 1<\/td> responseCode<\/td> String<\/td> The code representing the state of the response, it show whether the response was a success or not. NB: “00” is the code for success<\/td><\/tr> 2<\/td> responseMessage<\/td> String<\/td> The description that explains the responseCode from above <\/td><\/tr> 3<\/td> dateRange<\/td> String<\/td> The date range between the start date and end date<\/td><\/tr> 4<\/td> data<\/td> Object<\/td> The section that contains the actual data requested by the request<\/td><\/tr> 5<\/td> OldWebPay<\/td> Object<\/td> The section that contains requested data from Old webpay<\/td><\/tr> 6<\/td> NewWebPay<\/td> Object<\/td> The section that contains requested data from New webpay<\/td><\/tr> 7<\/td> totalCount<\/td> String<\/td> The total number of transactions for the analysis<\/td><\/tr> 8<\/td> oldwebpayTypeAnalysisList<\/td> List<\/td> The list of the different categories for Old webpay analysis<\/td><\/tr> 9<\/td> newwebpayTypeAnalysisList<\/td> List<\/td> The list of the different categories for New webpay analysis<\/td><\/tr> 10<\/td> noOfCustomers<\/td> String<\/td> Number of unique customers with the product and payment method<\/td><\/tr> 11<\/td> paymentMethod<\/td> String<\/td> Payment method within the category<\/td><\/tr> 12<\/td> productName<\/td> String<\/td> Product Name within the category<\/td><\/tr> 13<\/td> noOfTransactions<\/td> String<\/td> Number of transactions with the product and payment method<\/td><\/tr><\/tbody><\/table>\n\n\n\n Success sample response<\/strong><\/p>\n\n\n\n Response : { “responseCode”: “00”, “responseMessage”: “Successful”, “dateRange”: “Monthly”, “data”: { “OldWebPay”: { “totalCount”: “265629”, “oldwebpayTypeAnalysisList”: [ { “noOfCustomers”: “17786”, “productName”: “QuickTeller”, “noOfTransactions”: “215386” }, { “noOfCustomers”: “1778”, “productName”: “Unified Payment Services Limited”, “noOfTransactions”: “7536” }, { “noOfCustomers”: “5909”, “productName”: “Arik Air Limited”, “noOfTransactions”: “6575” }, … ] }, “NewWebPay”: { “totalCount”: “640183”, “newwebpayTypeAnalysisList”: [ { “noOfCustomers”: “1”, “productName”: “Recurring Payments”, “noOfTransactions”: “260387” }, { “noOfCustomers”: “1”, “productName”: “Payment”, “noOfTransactions”: “100429” }, { “noOfCustomers”: “1”, “productName”: “Flutterwave PG 2”, “noOfTransactions”: “79309” }, … ] } }<\/td><\/tr><\/tbody><\/table>\n","protected":false},"author":228,"featured_media":0,"parent":3577,"menu_order":5,"comment_status":"open","ping_status":"closed","template":"","meta":{"spay_email":""},"doc_tag":[],"_links":{"self":[{"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/4196"}],"collection":[{"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/types\/docs"}],"author":[{"embeddable":true,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/users\/228"}],"replies":[{"embeddable":true,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/comments?post=4196"}],"version-history":[{"count":2,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/4196\/revisions"}],"predecessor-version":[{"id":4289,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/4196\/revisions\/4289"}],"up":[{"embeddable":true,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/3577"}],"next":[{"title":"Introduction","link":"https:\/\/sandbox.interswitchng.com\/docbase\/docs\/interswitch-data-service\/introduction\/","href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/4320"}],"prev":[{"title":"Validation End-Points","link":"https:\/\/sandbox.interswitchng.com\/docbase\/docs\/interswitch-data-service\/validation-end-points-3\/","href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/4194"}],"wp:attachment":[{"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/media?parent=4196"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/doc_tag?post=4196"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}