Get Settlement Information for Transaction

This returns transaction details and settlement information for the transaction.

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/settlement-detail?transactionReference={{transactionReference}}

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
transactionReference	Monnify's transaction reference.	Yes

Here’s a sample response

Get Transaction Status Response

{
   "requestSuccessful":true,
   "responseMessage":"success",
   "responseCode":"0",
   "responseBody":{
      "transaction":{
         "transactionReference":"MNFY|20200616103633|000015",
         "paymentReference":"10046704",
         "amountPaid":"120.97",
         "totalPayable":"120.97",
         "settlementAmount":"120.00",
         "paidOn":"16/06/2020 10:39:43 AM",
         "paymentStatus":"PAID",
         "paymentDescription":"LahrayWeb",
         "currency":"NGN",
         "paymentMethod":"ACCOUNT_TRANSFER",
         "product":{
            "type":"WEB_SDK",
            "reference":"10046704"
         },
         "cardDetails":null,
         "accountDetails":{
            "accountName":"DAMILARE SAMUEL OGUNNAIKE",
            "accountNumber":"******7503",
            "bankCode":"000001",
            "amountPaid":"120.97"
         },
         "accountPayments":[
            {
               "accountName":"DAMILARE SAMUEL OGUNNAIKE",
               "accountNumber":"******7503",
               "bankCode":"000001",
               "amountPaid":"120.97"
            }
         ],
         "customer":{
            "email":"ogunnaike.damilare@gmail.com",
            "name":"Lahray"
         },
         "metaData":{
            "name":"Damilare",
            "age":"45"
         }
      },
      "beneficiaries":[
         {
            "beneficiaryType":"MERCHANT_CONTRACT",
            "beneficiaryCode":"888982476541",
            "beneficiaryIncome":120.00,
            "incurredFee":0.97,
            "settlementStatus":"SUCCESS",
            "settlementInformation":{
               "settledDate":"2020-06-16T21:18:38.000+0000",
               "settlementReference":"7GQM5XV2U3J8L3LR8QFS",
               "settlementAmount":360.00,
               "settlementFee":0.00,
               "destinationAccountNumber":"0068687503",
               "destinationAccountName":"DAMILARE SAMUEL OGUNNAIKE",
               "destinationBankName":"Sterling bank",
               "destinationBankCode":"232",
               "payoutReference":"MFY|MERCHANT_PAYOUT|20200616212025|005117"
            }
         }
      ]
   }
}