Introduction

THe Monnify Statement feature enables Merchants using wallets to conveniently generate a wallet statement.

This statement would contain;

  1. deposits into the wallets (Credits)
  2. withdrawals for payment (Debits)
  3. any charges where applicable
  4. balances on every transaction,
  5. transaction references and descriptions
  6. 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

  1. Source Account number : The merchant's WALLET ACCOUNT NUMBER
  2. Start Date (In Long format) : A timestamp value specifying the date to start filtering transactions by the createdAt field
  3. End Date (In Long format): A timestamp value specifying the date to stop filtering disbursement transactions by the createdAt field
  4. Page Number: The current page from the total to be retrieved
  5. 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:

json
Copy button
{{Base_Url}}/api/v1/disbursements/wallet/{{accountNumber}}/statement

Sample Request

json
Copy button
{{Base_Url}}/api/v1/disbursements/wallet/8016722372/statement?startDate=1702076400000&endDate=1702458365000&pageNo=0&pageSize=11

Response Structure

json
Copy button
"requestSuccessful": true,
   "responseMessage": "success",
   "responseCode": "0",
   "responseBody": {
       "content": [
           {
               "walletTransactionReference": "AT5_MFDS7820231213095406006362L4V3F9_1_DEBIT_0",
               "monnifyTransactionReference": "AT5_MFDS7820231213095406006362L4V3F9_1_DEBIT_0",
               "availableBalanceBefore": 630.0,
               "availableBalanceAfter": 500.0,
               "amount": 130.0,
               "transactionDate": "2023-12-13T08:54:06.000+0000",
               "transactionType": "DEBIT",
               "message": null,
               "narration": "MFDS7820231213095406006362L4V3F9/#/MFDB_483_4ace7c31-9b9d-43cb-bff1-48117f5e480f-1/#/test/#/GTBank/#/0456638287",
               "status": "COMPLETED"
           },
           {
               "walletTransactionReference": "AT5_MFDS7820231213095406006363AQ5EDQ_1_DEBIT_0",
               "monnifyTransactionReference": "AT5_MFDS7820231213095406006363AQ5EDQ_1_DEBIT_0",
               "availableBalanceBefore": 500.0,
               "availableBalanceAfter": 390.0,
               "amount": 110.0,
               "transactionDate": "2023-12-13T08:54:06.000+0000",
               "transactionType": "DEBIT",
               "message": null,
               "narration": "MFDS7820231213095406006363AQ5EDQ/#/MFDB_483_4ace7c31-9b9d-43cb-bff1-48117f5e480f-2/#/test/#/First bank/#/3012686077",
               "status": "COMPLETED"
           },
           {
               "walletTransactionReference": "AT5_MFDS7820231213095406006364RD7AMA_1_DEBIT_0",
               "monnifyTransactionReference": "AT5_MFDS7820231213095406006364RD7AMA_1_DEBIT_0",
               "availableBalanceBefore": 390.0,
               "availableBalanceAfter": 280.0,
               "amount": 110.0,
               "transactionDate": "2023-12-13T08:54:06.000+0000",
               "transactionType": "DEBIT",
               "message": null,
               "narration": "MFDS7820231213095406006364RD7AMA/#/MFDB_483_4ace7c31-9b9d-43cb-bff1-48117f5e480f-3/#/test/#/Zenith bank/#/2120456619",
               "status": "COMPLETED"
           },
           {
               "walletTransactionReference": "AT5_MFDS69420231213093010005157WG187R_1_DEBIT_0",
               "monnifyTransactionReference": "AT5_MFDS69420231213093010005157WG187R_1_DEBIT_0",
               "availableBalanceBefore": 870.0,
               "availableBalanceAfter": 740.0,
               "amount": 130.0,
               "transactionDate": "2023-12-13T08:30:10.000+0000",
               "transactionType": "DEBIT",
               "message": null,
               "narration": "MFDS69420231213093010005157WG187R/#/MFDB_483_6002ba60-0df0-4219-972a-a2eb0650d9ff-1/#/test/#/GTBank/#/0456638287",
               "status": "COMPLETED"
           },
           {
               "walletTransactionReference": "AT5_MFDS69420231213093010005158VAQR70_1_DEBIT_0",
               "monnifyTransactionReference": "AT5_MFDS69420231213093010005158VAQR70_1_DEBIT_0",
               "availableBalanceBefore": 980.0,
               "availableBalanceAfter": 870.0,
               "amount": 110.0,
               "transactionDate": "2023-12-13T08:30:10.000+0000",
               "transactionType": "DEBIT",
               "message": null,
               "narration": "MFDS69420231213093010005158VAQR70/#/MFDB_483_6002ba60-0df0-4219-972a-a2eb0650d9ff-2/#/test/#/First bank/#/3012686077",
               "status": "COMPLETED"
           },
           {
               "walletTransactionReference": "AT5_MFDS69420231213093010005159YKATJK_1_DEBIT_0",
               "monnifyTransactionReference": "AT5_MFDS69420231213093010005159YKATJK_1_DEBIT_0",
               "availableBalanceBefore": 740.0,
               "availableBalanceAfter": 630.0,
               "amount": 110.0,
               "transactionDate": "2023-12-13T08:30:10.000+0000",
               "transactionType": "DEBIT",
               "message": null,
               "narration": "MFDS69420231213093010005159YKATJK/#/MFDB_483_6002ba60-0df0-4219-972a-a2eb0650d9ff-3/#/test/#/Zenith bank/#/2120456619",
               "status": "COMPLETED"
           },
           {
               "walletTransactionReference": "AT5_MFDS71720231213090951004371YGW97L_1_DEBIT_0",
               "monnifyTransactionReference": "AT5_MFDS71720231213090951004371YGW97L_1_DEBIT_0",
               "availableBalanceBefore": 1110.0,
               "availableBalanceAfter": 980.0,
               "amount": 130.0,
               "transactionDate": "2023-12-13T08:09:55.000+0000",
               "transactionType": "DEBIT",
               "message": null,
               "narration": "MFDS71720231213090951004371YGW97L/#/MFDB_483_ee2036fc-380c-45e4-8cc2-79687d5782e4-1/#/test/#/GTBank/#/0456638287",
               "status": "COMPLETED"
           },
           {
               "walletTransactionReference": "AT5_MFDS7172023121309095400437222PJ74_1_DEBIT_0",
               "monnifyTransactionReference": "AT5_MFDS7172023121309095400437222PJ74_1_DEBIT_0",
               "availableBalanceBefore": 1330.0,
               "availableBalanceAfter": 1220.0,
               "amount": 110.0,
               "transactionDate": "2023-12-13T08:09:54.000+0000",
               "transactionType": "DEBIT",
               "message": null,
               "narration": "MFDS7172023121309095400437222PJ74/#/MFDB_483_ee2036fc-380c-45e4-8cc2-79687d5782e4-2/#/test/#/First bank/#/3012686077",
               "status": "COMPLETED"
           },
           {
               "walletTransactionReference": "AT5_MFDS71720231213090954004373QP92S6_1_DEBIT_0",
               "monnifyTransactionReference": "AT5_MFDS71720231213090954004373QP92S6_1_DEBIT_0",
               "availableBalanceBefore": 1220.0,
               "availableBalanceAfter": 1110.0,
               "amount": 110.0,
               "transactionDate": "2023-12-13T08:09:54.000+0000",
               "transactionType": "DEBIT",
               "message": null,
               "narration": "MFDS71720231213090954004373QP92S6/#/MFDB_483_ee2036fc-380c-45e4-8cc2-79687d5782e4-3/#/test/#/Zenith bank/#/2120456619",
               "status": "COMPLETED"
           },
           {
               "walletTransactionReference": "AT5_MFDS7820231213090805004333UGAJJR_1_DEBIT_0",
               "monnifyTransactionReference": "AT5_MFDS7820231213090805004333UGAJJR_1_DEBIT_0",
               "availableBalanceBefore": 1570.0,
               "availableBalanceAfter": 1440.0,
               "amount": 130.0,
               "transactionDate": "2023-12-13T08:08:05.000+0000",
               "transactionType": "DEBIT",
               "message": null,
               "narration": "MFDS7820231213090805004333UGAJJR/#/MFDB_483_b816a551-2977-4c65-8da9-e077ce725dc7-1/#/test/#/GTBank/#/0456638287",
               "status": "COMPLETED"
           },
           {
               "walletTransactionReference": "AT5_MFDS782023121309080500433478V8X6_1_DEBIT_0",
               "monnifyTransactionReference": "AT5_MFDS782023121309080500433478V8X6_1_DEBIT_0",
               "availableBalanceBefore": 1440.0,
               "availableBalanceAfter": 1330.0,
               "amount": 110.0,
               "transactionDate": "2023-12-13T08:08:05.000+0000",
               "transactionType": "DEBIT",
               "message": null,
               "narration": "MFDS782023121309080500433478V8X6/#/MFDB_483_b816a551-2977-4c65-8da9-e077ce725dc7-2/#/test/#/First bank/#/3012686077",
               "status": "COMPLETED"
           }
       ],
       "pageable": {
           "sort": {
               "sorted": false,
               "unsorted": true,
               "empty": true
           },
           "pageSize": 11,
           "pageNumber": 0,
           "offset": 0,
           "unpaged": false,
           "paged": true
       },
       "last": false,
       "totalPages": 3,
       "totalElements": 29,
       "size": 11,
       "number": 0,
       "sort": {
           "sorted": false,
           "unsorted": true,
           "empty": true
       },
       "first": true,
       "numberOfElements": 11,
       "empty": false
   }
}




Was this page helpful? Tell us what you think..

Got Questions

Reach out to us at [email protected] if you have any questions as regards integrating with the Monnify API.

Monnify Tutorial Videos

Check out Our Youtube channel for tutorials on how to integrate the Monnify API.

Join Our Slack Community

Click here to join the Monnify Slack community.
Copyright © 2024 Monnify
Terms of Service Privacy Policy