Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

Request

Field

Description

paymentReference

Unique reference generated by the merchant for each transaction. 

transactionReference

Unique transaction reference generated by Monnify for each transaction

Here is a sample request and response

...

Get Transaction Status Response


Success response

Expand
Code Block
languagejson
{
    "requestSuccessful": true,
    "responseMessage": "success",
    "responseCode": "0",
    "responseBody": {
        "transactionReference": "MNFY|87|20230629132018|049239",
        "paymentReference": "MNFY|87|20230629132018|049239",
        "amountPaid": "200.00",
        "totalPayable": "200.00",
        "settlementAmount": "196.77",
        "paidOn": "29/06/2023 01:20:18 PM",
        "paymentStatus": "PAID",
        "paymentDescription": "Tes",
        "currency": "NGN",
        "paymentMethod": "ACCOUNT_TRANSFER",
        "product": {
            "type": "RESERVED_ACCOUNT",
            "reference": "xnkxxbbdmpjnckmcfkcl"
        },
        "cardDetails": null,
        "accountDetails": {
            "accountName": "BENJAMIN CHUKWUEMEKA ONONOGBU",
            "accountNumber": "*******3241",
            "bankCode": "100004",
            "amountPaid": "200.00",
            "sessionId": "100004230629121914104830107292",
            "destinationAccountNumber": "7025415989",
            "destinationAccountName": null,
            "destinationBankCode": "035",
            "destinationBankName": "Wema bank",
            "bankName": null
        },
        "accountPayments": [
            {
                "accountName": "BENJAMIN CHUKWUEMEKA ONONOGBU",
                "accountNumber": "*******3241",
                "bankCode": "100004",
                "amountPaid": "200.00",
                "sessionId": "100004230629121914104830107292",
                "destinationAccountNumber": "7025415989",
                "destinationAccountName": null,
                "destinationBankCode": "035",
                "destinationBankName": "Wema bank",
                "bankName": null
            }
        ],
        "customer": {
            "email": "test@tester.com",
            "name": "John Doe"
        },
        "metaData": {}
    }
}

Pending Response

Expand
Code Block
languagejson
{
    "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

Expand
Code Block
{
    "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

Expand
Code Block
{
    "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": {}
    }
}