Single Transfers
To get a list of all single transfers, you will need to send a request to the endpoint below:
Endpoint
GET: https://sandbox.monnify.com/api/v2/disbursements/single/transactions?pageSize=5&pageNo=1
This endpoint is protected by OAuth 2.0 Bearer Token
Below is a sample response for getting all single transactions
Get All Single Transactions Response
{
"requestSuccessful":true,
"responseMessage":"success",
"responseCode":"0",
"responseBody":{
"content":[
{
"amount":10.00,
"reference":"1596666798811311",
"narration":"monthly stipend",
"currency":"NGN",
"fee":20.00,
"twoFaEnabled":true,
"status":"SUCCESS",
"transactionDescription":" Approved or completed successfully",
"transactionReference":"MFDS|20200805233321|001618",
"createdOn":"2020-08-05T22:33:22.000+0000",
"sourceAccountNumber":"8000001995",
"destinationAccountNumber":"0068687503",
"destinationAccountName":"DAMILARE SAMUEL OGUNNAIKE",
"destinationBankCode":"232",
"destinationBankName":"Sterling bank"
},
{
"amount":10.00,
"reference":"1596666798811411",
"narration":"monthly stipend",
"currency":"NGN",
"fee":20.00,
"twoFaEnabled":true,
"status":"SUCCESS",
"transactionDescription":" Approved or completed successfully",
"transactionReference":"MFDS|20200805233321|001619",
"createdOn":"2020-08-05T22:33:22.000+0000",
"sourceAccountNumber":"8000001995",
"destinationAccountNumber":"2083919503",
"destinationAccountName":"OGUNNAIKE DAMILARE, SAMUEL",
"destinationBankCode":"033",
"destinationBankName":"United Bank For Africa Plc"
}
],
"pageable":{
"sort":{
"sorted":true,
"unsorted":false,
"empty":false
},
"pageSize":2,
"pageNumber":0,
"offset":0,
"unpaged":false,
"paged":true
},
"totalPages":54,
"last":false,
"totalElements":108,
"sort":{
"sorted":true,
"unsorted":false,
"empty":false
},
"first":true,
"numberOfElements":2,
"size":2,
"number":0,
"empty":false
}
}
Bulk Transfers
To get a list of all bulk transfers, you will need to send a request to the endpoint below:
Endpoint
GET: https://sandbox.monnify.com/api/v2/disbursements/bulk/transactions?pageSize=2
This endpoint is protected with Basic Authentication
Below is a sample response for getting all single transactions
Get All Bulk Transactions Response
{
"requestSuccessful":true,
"responseMessage":"success",
"responseCode":"0",
"responseBody":{
"content":[
{
"totalAmount":45.00,
"totalFee":80.00,
"batchReference":"Batch-1596666798811",
"batchStatus":"COMPLETED",
"totalTransactionsCount":4,
"dateCreated":"2020-08-05T22:33:21.000+0000"
},
{
"totalAmount":50.00,
"totalFee":20.00,
"batchReference":"Batch-1593606495053",
"batchStatus":"COMPLETED",
"totalTransactionsCount":1,
"dateCreated":"2020-07-01T12:28:16.000+0000"
},
{
"totalAmount":50.00,
"totalFee":20.00,
"batchReference":"Batch-1593606391931",
"batchStatus":"COMPLETED",
"totalTransactionsCount":1,
"dateCreated":"2020-07-01T12:26:33.000+0000"
}
],
"pageable":{
"sort":{
"sorted":true,
"unsorted":false,
"empty":false
},
"pageSize":3,
"pageNumber":0,
"offset":0,
"unpaged":false,
"paged":true
},
"totalPages":3,
"last":false,
"totalElements":7,
"sort":{
"sorted":true,
"unsorted":false,
"empty":false
},
"first":true,
"numberOfElements":3,
"size":3,
"number":0,
"empty":false
}
}
Field Reference
| Field | Description |
|---|---|
| pageNo | A number specifying what page of transfers to be retrieved. Minimum value is 0, and defaults to 0 if not specified. |
| pageSize | A number specifying size of each transfer page. Minimum value is 1, and defaults to 10 if not specified. |
| amount | The amount to be disbursed to the beneficiary |
| reference | The unique reference for a transaction. Also to be specified for each transaction in a bulk transaction request. |
| batchReference | The unique reference for the entire batch of transactions being sent. |
| narration | The Narration for the transactions being processed |
| destinationBankCode | The 3 digit bank code representing the destination bank |
| destinationBankName | The name of the destination bank |
| destinationAccountNumber | The beneficiary account number |
| destinationAccountName | The name tied to the account in the destination bank |
| currency (M) | The currency of the transaction being initialized. "NGN" |
| status | The status of a single transfer request. (SUCCESS, FAILED, PENDING, OTP_EMAIL_DISPATCH_FAILED, PENDING_AUTHORIZATION) |
| batchStatus | The status of the processing of the entire Batch. (FAILED_ON_ACCOUNTS_VALIDATION, OTP_EMAIL_DISPATCH_FAILED, PENDING, PENDING_AUTHORIZATION, AWAITING_PROCESSING, IN_PROGRESS ,COMPLETED) |
| totalTransactions | The total number of transactions in the batch. |
| totalAmount | The total amount deducted for all the transactions in the batch |
| fee | The total transaction fees deducted for a single transaction |
| totalFee | The total transaction fees deducted for all the transactions in the batch. |
Related Articles