Introduction

The Monnify Statement feature enables merchants using wallets to conveniently generate wallet statements.

This statement would contain:

Deposits into the wallets (Credits)
Withdrawals for payment (Debits)
Any charges where applicable
Balances on every transaction,
Transaction references and descriptions
Narration

Feature Details

To generate a wallet statement, the merchant would simply make a GET request to the Wallet statement API and specify the following in the request

Source Account number : The merchant's WALLET ACCOUNT NUMBER
Start Date (In Long format) : A timestamp value specifying the date to start filtering transactions by the createdAt field
End Date (In Long format): A timestamp value specifying the date to stop filtering disbursement transactions by the createdAt field
Enable Time Filter: This param allows caller to filter based on time (hour only) given in startDate and endDate query params.
Page Number: The current page from the total to be retrieved
Page Size: The number of entries/records to be returned in a single page

A JSON response containing the statement would then be returned.

API Endpoint:

1{{Base_Url}}/api/v1/disbursements/wallet/{{accountNumber}}/statement

Sample Request

1{{Base_Url}}/api/v1/disbursements/wallet/8016722372/statement?startDate=1702076400000&endDate=1702458365000&enableTimeFilter=true&pageNo=0&pageSize=11

Response Structure

response.json

1{
2 "requestSuccessful": true,
3 "responseMessage": "success",
4 "responseCode": "0",
5 "responseBody": {
6     "content": [
7         {
8             "walletTransactionReference": "AT5_MFDS7820231213095406006362L4V3F9_1_DEBIT_0",
9             "monnifyTransactionReference": "AT5_MFDS7820231213095406006362L4V3F9_1_DEBIT_0",
10             "availableBalanceBefore": 630.0,
11             "availableBalanceAfter": 500.0,
12             "amount": 130.0,
13             "transactionDate": "2023-12-13T08:54:06.000+0000",
14             "transactionType": "DEBIT",
15             "message": null,
16             "narration": "MFDS7820231213095406006362L4V3F9/#/MFDB_483_4ace7c31-9b9d-43cb-bff1-48117f5e480f-1/#/test/#/GTBank/#/0456638287",
17             "status": "COMPLETED"
18         },
19         {
20             "walletTransactionReference": "AT5_MFDS7820231213095406006363AQ5EDQ_1_DEBIT_0",
21             "monnifyTransactionReference": "AT5_MFDS7820231213095406006363AQ5EDQ_1_DEBIT_0",
22             "availableBalanceBefore": 500.0,
23             "availableBalanceAfter": 390.0,
24             "amount": 110.0,
25             "transactionDate": "2023-12-13T08:54:06.000+0000",
26             "transactionType": "DEBIT",
27             "message": null,
28             "narration": "MFDS7820231213095406006363AQ5EDQ/#/MFDB_483_4ace7c31-9b9d-43cb-bff1-48117f5e480f-2/#/test/#/First bank/#/3012686077",
29             "status": "COMPLETED"
30         },
31         {
32             "walletTransactionReference": "AT5_MFDS7820231213095406006364RD7AMA_1_DEBIT_0",
33             "monnifyTransactionReference": "AT5_MFDS7820231213095406006364RD7AMA_1_DEBIT_0",
34             "availableBalanceBefore": 390.0,
35             "availableBalanceAfter": 280.0,
36             "amount": 110.0,
37             "transactionDate": "2023-12-13T08:54:06.000+0000",
38             "transactionType": "DEBIT",
39             "message": null,
40             "narration": "MFDS7820231213095406006364RD7AMA/#/MFDB_483_4ace7c31-9b9d-43cb-bff1-48117f5e480f-3/#/test/#/Zenith bank/#/2120456619",
41             "status": "COMPLETED"
42         },
43         {
44             "walletTransactionReference": "AT5_MFDS69420231213093010005157WG187R_1_DEBIT_0",
45             "monnifyTransactionReference": "AT5_MFDS69420231213093010005157WG187R_1_DEBIT_0",
46             "availableBalanceBefore": 870.0,
47             "availableBalanceAfter": 740.0,
48             "amount": 130.0,
49             "transactionDate": "2023-12-13T08:30:10.000+0000",
50             "transactionType": "DEBIT",
51             "message": null,
52             "narration": "MFDS69420231213093010005157WG187R/#/MFDB_483_6002ba60-0df0-4219-972a-a2eb0650d9ff-1/#/test/#/GTBank/#/0456638287",
53             "status": "COMPLETED"
54         },
55         {
56             "walletTransactionReference": "AT5_MFDS69420231213093010005158VAQR70_1_DEBIT_0",
57             "monnifyTransactionReference": "AT5_MFDS69420231213093010005158VAQR70_1_DEBIT_0",
58             "availableBalanceBefore": 980.0,
59             "availableBalanceAfter": 870.0,
60             "amount": 110.0,
61             "transactionDate": "2023-12-13T08:30:10.000+0000",
62             "transactionType": "DEBIT",
63             "message": null,
64             "narration": "MFDS69420231213093010005158VAQR70/#/MFDB_483_6002ba60-0df0-4219-972a-a2eb0650d9ff-2/#/test/#/First bank/#/3012686077",
65             "status": "COMPLETED"
66         },
67         {
68             "walletTransactionReference": "AT5_MFDS69420231213093010005159YKATJK_1_DEBIT_0",
69             "monnifyTransactionReference": "AT5_MFDS69420231213093010005159YKATJK_1_DEBIT_0",
70             "availableBalanceBefore": 740.0,
71             "availableBalanceAfter": 630.0,
72             "amount": 110.0,
73             "transactionDate": "2023-12-13T08:30:10.000+0000",
74             "transactionType": "DEBIT",
75             "message": null,
76             "narration": "MFDS69420231213093010005159YKATJK/#/MFDB_483_6002ba60-0df0-4219-972a-a2eb0650d9ff-3/#/test/#/Zenith bank/#/2120456619",
77             "status": "COMPLETED"
78         },
79         {
80             "walletTransactionReference": "AT5_MFDS71720231213090951004371YGW97L_1_DEBIT_0",
81             "monnifyTransactionReference": "AT5_MFDS71720231213090951004371YGW97L_1_DEBIT_0",
82             "availableBalanceBefore": 1110.0,
83             "availableBalanceAfter": 980.0,
84             "amount": 130.0,
85             "transactionDate": "2023-12-13T08:09:55.000+0000",
86             "transactionType": "DEBIT",
87             "message": null,
88             "narration": "MFDS71720231213090951004371YGW97L/#/MFDB_483_ee2036fc-380c-45e4-8cc2-79687d5782e4-1/#/test/#/GTBank/#/0456638287",
89             "status": "COMPLETED"
90         },
91         {
92             "walletTransactionReference": "AT5_MFDS7172023121309095400437222PJ74_1_DEBIT_0",
93             "monnifyTransactionReference": "AT5_MFDS7172023121309095400437222PJ74_1_DEBIT_0",
94             "availableBalanceBefore": 1330.0,
95             "availableBalanceAfter": 1220.0,
96             "amount": 110.0,
97             "transactionDate": "2023-12-13T08:09:54.000+0000",
98             "transactionType": "DEBIT",
99             "message": null,
100             "narration": "MFDS7172023121309095400437222PJ74/#/MFDB_483_ee2036fc-380c-45e4-8cc2-79687d5782e4-2/#/test/#/First bank/#/3012686077",
101             "status": "COMPLETED"
102         },
103         {
104             "walletTransactionReference": "AT5_MFDS71720231213090954004373QP92S6_1_DEBIT_0",
105             "monnifyTransactionReference": "AT5_MFDS71720231213090954004373QP92S6_1_DEBIT_0",
106             "availableBalanceBefore": 1220.0,
107             "availableBalanceAfter": 1110.0,
108             "amount": 110.0,
109             "transactionDate": "2023-12-13T08:09:54.000+0000",
110             "transactionType": "DEBIT",
111             "message": null,
112             "narration": "MFDS71720231213090954004373QP92S6/#/MFDB_483_ee2036fc-380c-45e4-8cc2-79687d5782e4-3/#/test/#/Zenith bank/#/2120456619",
113             "status": "COMPLETED"
114         },
115         {
116             "walletTransactionReference": "AT5_MFDS7820231213090805004333UGAJJR_1_DEBIT_0",
117             "monnifyTransactionReference": "AT5_MFDS7820231213090805004333UGAJJR_1_DEBIT_0",
118             "availableBalanceBefore": 1570.0,
119             "availableBalanceAfter": 1440.0,
120             "amount": 130.0,
121             "transactionDate": "2023-12-13T08:08:05.000+0000",
122             "transactionType": "DEBIT",
123             "message": null,
124             "narration": "MFDS7820231213090805004333UGAJJR/#/MFDB_483_b816a551-2977-4c65-8da9-e077ce725dc7-1/#/test/#/GTBank/#/0456638287",
125             "status": "COMPLETED"
126         },
127         {
128             "walletTransactionReference": "AT5_MFDS782023121309080500433478V8X6_1_DEBIT_0",
129             "monnifyTransactionReference": "AT5_MFDS782023121309080500433478V8X6_1_DEBIT_0",
130             "availableBalanceBefore": 1440.0,
131             "availableBalanceAfter": 1330.0,
132             "amount": 110.0,
133             "transactionDate": "2023-12-13T08:08:05.000+0000",
134             "transactionType": "DEBIT",
135             "message": null,
136             "narration": "MFDS782023121309080500433478V8X6/#/MFDB_483_b816a551-2977-4c65-8da9-e077ce725dc7-2/#/test/#/First bank/#/3012686077",
137             "status": "COMPLETED"
138         }
139     ],
140     "pageable": {
141         "sort": {
142             "sorted": false,
143             "unsorted": true,
144             "empty": true
145         },
146         "pageSize": 11,
147         "pageNumber": 0,
148         "offset": 0,
149         "unpaged": false,
150         "paged": true
151     },
152     "last": false,
153     "totalPages": 3,
154     "totalElements": 29,
155     "size": 11,
156     "number": 0,
157     "sort": {
158         "sorted": false,
159         "unsorted": true,
160         "empty": true
161     },
162     "first": true,
163     "numberOfElements": 11,
164     "empty": false
165 }
166}

Rate this page

How would you rate your experience?

Introduction

Feature Details

API Endpoint:

Sample Request

Response Structure

Rate this page

Got Questions

Monnify Tutorial Videos

Join Our Slack Community