Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 10 Current »

We highly recommend that when you receive a notification from us, even after checking to ensure the hash values match, you should initiate a get transaction status request to us with the transactionReference to confirm the actual status of that transaction before updating the records on your database. 

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/transactions/{{transactionReference}}

Content-Type: application/json

HTTP Method: GET

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

You can get the transaction status with a simple GET request to the get status endpoint and simply add either of the following query params in the table below.

Kindly do a url_encode of the transactionReference before passing into the url endpoint

Request

Field

Description

transactionReference

Unique transaction reference generated by Monnify for each transaction

Here’s a sample request and response

Sample Responses

Likely responses include: PAID, OVERPAID, PARTIALLY_PAID, PENDING, ABANDONED, CANCELLED, FAILED, REVERSED, EXPIRED.

Success Response

 Click here to expand...

{
    "requestSuccessful": true,
    "responseMessage": "success",
    "responseCode": "0",
    "responseBody": {
        "transactionReference": "MNFY|20200226093601|002095",
        "paymentReference": "330854835",
        "amountPaid": "100.00",
        "totalPayable": "100.00",
        "settlementAmount": "99.21",
        "paidOn": "26/02/2020 09:38:13 AM",
        "paymentStatus": "PAID",
        "paymentDescription": "LahrayWeb",
        "currency": "NGN",
        "paymentMethod": "ACCOUNT_TRANSFER",
        "product": {
            "type": "WEB_SDK",
            "reference": "330854835"
        },
        "cardDetails": null,
        "accountDetails": {
            "accountName": "DAMILARE SAMUEL OGUNNAIKE",
            "accountNumber": "******7503",
            "bankCode": "000001",
            "amountPaid": "100.00"
        },
        "accountPayments": [
            {
                "accountName": "DAMILARE SAMUEL OGUNNAIKE",
                "accountNumber": "******7503",
                "bankCode": "000001",
                "amountPaid": "100.00"
            }
        ],
        "customer": {
            "email": "ogunnaike.damilare@gmail.com",
            "name": "Lahray"
        },
        "metaData": {
            "name": "Damilare",
            "age": "45"
        }
    }
}
   

Pending Response

 Click here to expand...

{
    "requestSuccessful": true,
    "responseMessage": "success",
    "responseCode": "0",
    "responseBody": {
        "transactionReference": "MNFY|44|20220407112123|000684",
        "paymentReference": "130i0o0hfhlaad0",
        "amountPaid": "0.00",
        "totalPayable": "0.00",
        "settlementAmount": null,
        "paidOn": null,
        "paymentStatus": "PENDING",
        "paymentDescription": "Trial transaction",
        "currency": "NGN",
        "paymentMethod": "CARD",
        "product": {
            "type": "WEB_SDK",
            "reference": "130i0o0hfhlaad0"
        },
        "cardDetails": {
            "cardType": "Sandbox Card Scheme",
            "last4": "0007",
            "expMonth": "12",
            "expYear": "22",
            "bin": "520000",
            "bankCode": null,
            "bankName": null,
            "reusable": false,
            "countryCode": null,
            "cardToken": null,
            "supportsTokenization": false,
            "maskedPan": "520000******0007"
        },
        "accountDetails": null,
        "accountPayments": [],
        "customer": {
            "email": "stephen@ikhane.com",
            "name": "Stephen Ikhane"
        },
        "metaData": {}
    }
}

Expired Response

 Click here to expand...

{
    "requestSuccessful": true,
    "responseMessage": "success",
    "responseCode": "0",
    "responseBody": {
        "transactionReference": "MNFY|02|20220318085941|000387",
        "paymentReference": "123031klsaad0",
        "amountPaid": "0.00",
        "totalPayable": "0.00",
        "settlementAmount": null,
        "paidOn": "18/03/2022 09:30:42 AM",
        "paymentStatus": "EXPIRED",
        "paymentDescription": "Trial transaction",
        "currency": "NGN",
        "paymentMethod": "ACCOUNT_TRANSFER",
        "product": {
            "type": "API_NOTIFICATION",
            "reference": "123031klsaad0"
        },
        "cardDetails": null,
        "accountDetails": null,
        "accountPayments": [],
        "customer": {
            "email": "stephen@ikhane.com",
            "name": "Stephen Ikhane"
        },
        "metaData": {}
    }
}

Failed Response

 Click here to expand...

{
    "requestSuccessful": true,
    "responseMessage": "success",
    "responseCode": "0",
    "responseBody": {
        "transactionReference": "MNFY|44|20220407112123|000684",
        "paymentReference": "130i0o0hfhlaad0",
        "amountPaid": "0.00",
        "totalPayable": "0.00",
        "settlementAmount": null,
        "paidOn": null,
        "paymentStatus": "FAILED",
        "paymentDescription": "Trial transaction",
        "currency": "NGN",
        "paymentMethod": "CARD",
        "product": {
            "type": "WEB_SDK",
            "reference": "130i0o0hfhlaad0"
        },
        "cardDetails": {
            "cardType": "Sandbox Card Scheme",
            "last4": "0007",
            "expMonth": "12",
            "expYear": "22",
            "bin": "520000",
            "bankCode": null,
            "bankName": null,
            "reusable": false,
            "countryCode": null,
            "cardToken": null,
            "supportsTokenization": false,
            "maskedPan": "520000******0007"
        },
        "accountDetails": null,
        "accountPayments": [],
        "customer": {
            "email": "stephen@ikhane.com",
            "name": "Stephen Ikhane"
        },
        "metaData": {}
    }
}

  • No labels