/
List All Transfers (Deprecated)

List All Transfers (Deprecated)

Aug 05, 2020

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/v1/disbursements/single/transactions?pageSize=5&pageNo=1

This endpoint is protected with Basic Authentication


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": "reference_generator_93",
                "narration": "911 Transaction",
                "bankCode": "058",
                "accountNumber": "0111946768",
                "currency": "Naira",
                "accountName": "MEKILIUWA, SMART CHINONSO",
                "bankName": "Unspecified Bank",
                "dateCreated": "No Date Specified",
                "fee": 11.00,
                "status": "SUCCESS"
            },
            {
                "amount": 10.00,
                "reference": "reference_generator_934",
                "narration": "911 Transaction",
                "bankCode": "058",
                "accountNumber": "0111946768",
                "currency": "Naira",
                "accountName": "MEKILIUWA, SMART CHINONSO",
                "bankName": "Unspecified Bank",
                "dateCreated": "No Date Specified",
                "fee": 11.00,
                "status": "PENDING_AUTHORIZATION"
            },
            {
                "amount": 10.00,
                "reference": "reference_generator_9345",
                "narration": "911 Transaction",
                "bankCode": "058",
                "accountNumber": "0111946768",
                "currency": "Naira",
                "accountName": "MEKILIUWA, SMART CHINONSO",
                "bankName": "Unspecified Bank",
                "dateCreated": "No Date Specified",
                "fee": 11.00,
                "status": "SUCCESS"
            },
            {
                "amount": 10.00,
                "reference": "Final-Reference",
                "narration": "911 Transaction",
                "bankCode": "058",
                "accountNumber": "0111946768",
                "currency": "NGN",
                "accountName": "MEKILIUWA, SMART CHINONSO",
                "bankName": "GTBank",
                "dateCreated": "13/11/2019 05:39:39 PM",
                "fee": 1.00,
                "status": "PENDING_AUTHORIZATION"
            },
            {
                "amount": 10.00,
                "reference": "new-reference-1",
                "narration": "911 Transaction",
                "bankCode": "058",
                "accountNumber": "0111946768",
                "currency": "NGN",
                "accountName": "MEKILIUWA, SMART CHINONSO",
                "bankName": "GTBank",
                "dateCreated": "13/11/2019 08:26:10 PM",
                "fee": 1.00,
                "status": "SUCCESS"
            }
        ],
        "pageable": {
            "sort": {
                "sorted": false,
                "unsorted": true,
                "empty": true
            },
            "pageSize": 5,
            "pageNumber": 0,
            "offset": 0,
            "paged": true,
            "unpaged": false
        },
        "totalPages": 5,
        "totalElements": 24,
        "last": false,
        "sort": {
            "sorted": false,
            "unsorted": true,
            "empty": true
        },
        "first": true,
        "numberOfElements": 5,
        "size": 5,
        "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/v1/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": 2108.48,
                "totalFee": 8.48,
                "batchReference": "salary-payment-1",
                "batchStatus": "AWAITING_PROCESSING",
                "totalTransactions": 3,
                "dateCreated": "13/11/2019 09:05:42 PM"
            },
            {
                "totalAmount": 2108.48,
                "totalFee": 8.48,
                "batchReference": "batch-1573681308355",
                "batchStatus": "COMPLETED",
                "totalTransactions": 3,
                "dateCreated": "13/11/2019 09:42:06 PM"
            }
        ],
        "pageable": {
            "sort": {
                "sorted": false,
                "unsorted": true,
                "empty": true
            },
            "pageSize": 2,
            "pageNumber": 0,
            "offset": 0,
            "paged": true,
            "unpaged": false
        },
        "totalPages": 3,
        "totalElements": 5,
        "last": false,
        "sort": {
            "sorted": false,
            "unsorted": true,
            "empty": true
        },
        "first": true,
        "numberOfElements": 2,
        "size": 2,
        "number": 0,
        "empty": false
    }
}

Field Reference

FieldDescription
pageNoA number specifying what page of transfers to be retrieved. Minimum value is 0, and defaults to 0 if not specified.
pageSizeA number specifying size of each transfer page. Minimum value is 1, and defaults to 10 if not specified.
amountThe amount to be disbursed to the beneficiary
referenceThe 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.
narrationThe Narration for the transactions being processed
bankCodeThe 3 digit bank code representing the destination bank
bankNameThe name of the destination bank
accountNumberThe beneficiary account number
accountNameThe name tied to the account in the destination bank
currency (M)The currency of the transaction being initialized. "NGN"
statusThe status  of a single transfer request. (SUCCESS, FAILED, PENDING, OTP_EMAIL_DISPATCH_FAILED, PENDING_AUTHORIZATION)
batchStatusThe status of the processing of the entire Batch. (FAILED_ON_ACCOUNTS_VALIDATION, OTP_EMAIL_DISPATCH_FAILED, PENDING, PENDING_AUTHORIZATION, AWAITING_PROCESSING, IN_PROGRESS ,COMPLETED)
totalTransactionsThe total number of transactions in the batch.
totalAmountThe total amount deducted for all the transactions in the batch
feeThe total transaction fees deducted for a single transaction
totalFeeThe total transaction fees deducted for all the transactions in the batch.