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 either the paymentReference or transactionReference to confirm the actual status of that transaction before updating the records on your database.
Endpoint
GET: https://sandbox.monnify.com/api/v1/merchant/transactions/query
Please note that this endpoint is protected using basic authentication. We’ve touched on Basic Authentication in the Authentication section of this document.
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
Request Headers Authorization:"Basic TUtfUFJPRF9XV0RYRktCN1paOkVUOVJMU1dESjNEN1FYRE44UUNSTVlSTlBCM1czRUFL" Request URL GET https://sandbox.monnify.com/api/v1/merchant/transactions/query?paymentReference=reference12345 Or GET https://sandbox.monnify.com/api/v1/merchant/transactions/query?transactionReference=MNFY|20190809123429|000000
{
"requestSuccessful": true,
"responseMessage": "success",
"responseCode": "0",
"responseBody": {
"paymentMethod": "ACCOUNT_TRANSFER",
"createdOn": "2019-08-09T18:52:45.000+0000",
"amount": 100.00,
"currencyCode": "NGN",
"customerName": "Test Reserved Account",
"customerEmail": "test@tester.com",
"paymentDescription": "Test Reserved Account",
"paymentStatus": "PAID",
"transactionReference": "MNFY|20190809123429|000000",
"paymentReference": "reference12345"
}
}