Get Transactions By Settlement Reference

This returns all transactions that made up a settlement.

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/v1/transactions/find-by-settlement-reference?reference=VKALKYTW8BSL7J275EX9&page=0&size=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

This endpoint supports specifying query parameters as described below.

Request

Request
Field	Description	Compulsory
page	An integer specifying page of transactions to be retrieved. Page number starts from 0.	No. Defaults to 0
size	An integer specifying size of transactions to be returned per page.	No. Defaults to 10
reference	Settlement reference as displayed on your dashboard	Yes

Here’s a sample response

Get Transaction Status Response

{
    "requestSuccessful": true,
    "responseMessage": "success",
    "responseCode": "0",
    "responseBody": {
        "content": [
            {
                "transactionReference": "MNFY|20190523182133|000002",
                "paymentReference": "775252916",
                "amountPaid": "9000.00",
                "totalPayable": "9000.00",
                "paidOn": "23/05/2019 06:21:33",
                "paymentStatus": "PAID",
                "paymentDescription": "Neme Earphones",
                "transactionHash": null,
                "currency": "NGN",
                "paymentMethod": "ACCOUNT_TRANSFER",
                "product": {
                    "type": "WEB_SDK",
                    "reference": "775252916"
                },
                "cardDetails": null,
                "accountDetails": {
                    "accountName": null,
                    "accountNumber": "******2190",
                    "bankCode": "001",
                    "amountPaid": "9000.00"
                },
                "accountPayments": [
                    {
                        "accountName": "DAMILARE SAMUEL",
                        "accountNumber": "******2190",
                        "bankCode": "001",
                        "amountPaid": "9000.00"
                    }
                ],
                "customer": {
                    "email": null,
                    "name": null
                }
            }
        ],
        "pageable": {
            "sort": {
                "sorted": false,
                "unsorted": true,
                "empty": true
            },
            "offset": 0,
            "pageSize": 10,
            "pageNumber": 0,
            "unpaged": false,
            "paged": true
        },
        "last": true,
        "totalPages": 1,
        "totalElements": 1,
        "size": 10,
        "number": 0,
        "sort": {
            "sorted": false,
            "unsorted": true,
            "empty": true
        },
        "first": true,
        "numberOfElements": 1,
        "empty": false
    }
}