Get Bulk Transfer Transactions

This endpoint allows you to get a paginated list of all transactions in a bulk transfer batch and their statuses. To get the transactions in a bulk transfer, you will need to send a request to the endpoint below:

This endpoint is protected with OAuth 2.0 Bearer token. To find out more about authorization for Monnify endpoints, check Here.

Endpoint URL: {{base_url}}/api/v2/disbursements/bulk/{{batchReference}}/transactions?pageNo=0&pageSize=10

HTTP Method: GET

The {{base_url}} for test is https://sandbox.monnify.com but when you go live, it changes to the live url

Below is a sample response for getting the transactions in a bulk transfer

Get Bulk Transfer Transactions Response

{
    "requestSuccessful": true,
    "responseMessage": "success",
    "responseCode": "0",
    "responseBody": {
        "content": [
            {
                "amount": 1300.00,
                "reference": "Final-Reference-1ad",
                "narration": "911 Transaction",
				"twoFaEnabled": true,
				"status": "SUCCESS",
				"transactionDescription": "Approved or completed successfully",
                "destinationBankCode": "058",
                "destinationaccountNumber": "0111946768",
                "destinationAccountName": "MEKILIUWA, SMART CHINONSO",
                "destinationBankName": "GTBank",
                "currency": "NGN",
                "createdOn": "13/11/2019 10:45:08 PM",
                "fee": 20.00,
				"sourceAccountNumber": "8000001995"
            },
		    {
                "amount": 1300.00,
                "reference": "Final-Reference-1ae",
                "narration": "Test Payment",
				"twoFaEnabled": true,
				"status": "SUCCESS",
				"transactionDescription": "Approved or completed successfully",
                "destinationBankCode": "232",
                "destinationaccountNumber": "0111946768",
                "destinationAccountName": "LAHRAY, SMART CHINONSO",
                "destinationBankName": "GTBank",
                "currency": "NGN",
                "createdOn": "13/11/2019 10:45:08 PM",
                "fee": 20.00,
				"sourceAccountNumber": "8000001995"
            }
        ],
        "pageable": {
            "sort": {
                "sorted": false,
                "unsorted": true,
                "empty": true
            },
            "pageSize": 10,
            "pageNumber": 0,
            "offset": 0,
            "paged": true,
            "unpaged": false
        },
        "totalPages": 1,
        "totalElements": 3,
        "last": true,
        "sort": {
            "sorted": false,
            "unsorted": true,
            "empty": true
        },
        "first": true,
        "numberOfElements": 3,
        "size": 10,
        "number": 0,
        "empty": false
    }
}

Field Reference

Field	Description

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.
failedCount	Total number of failed transactions in the batch
successfulCount	Total number of successful transactions in the batch
pendingCount	Total number of pending transactions in the batch

Get Bulk Transfer Transactions

Related Articles