This returns all transactions done by a merchant.
Endpoint
GET: https://sandbox.monnify.com/api/v1/transactions/search?Please note that this endpoint is protected by OAuth 2.0 Bearer Token
This endpoint supports specifying query parameters as described below.
| 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 |
| paymentReference | Unique reference generated by merchant for each transaction. | No |
| transactionReference | Unique transaction reference generated by Monnify for each transaction | No |
| fromAmount | A decimal number indicating minimum amount for the transactions to be returned | No |
| toAmount | A decimal number indicating maximum amount for the transactions to be returned | No |
| amount | A decimal number indicating exact amount for the transactions to be returned | No |
| customerName | A string value specifying name of customer for the transactions to be returned | No |
| customerEmail | A string value specifying email of customer for the transactions be returned. | No |
| paymentStatus | Transaction status for transactions to be returned, e.g. PAID, FAILED, PENDING. If not specified all transactions will be returned. | No |
| from | Timestamp indicating start time for transactions to be retrieved. | No |
| to | Timestamp indicating maximum time for transactions to be retrieved. | No |
Here’s a sample request and response
Get Transaction Status Request
Request Headers Authorization:"Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJsYXN0TmFtZSI6Ik9ndW5uYWlrZSIsInJlc2V0UGFzc3dvcmQiOmZhbHNlLCJ1c2VyX25hbWUiOiJvZ3VubmFpa2UuZGFtaWxhcmVAZ21haWwuY29tIiwiYXV0aGVudGljYXRpb25Eb21haW4iOiJDT1NNT1MiLCJyb2xlcyI6WyJNRVJDSEFOVC1BRE1JTklTVFJBVE9SLVVTRVItVFlQRSJdLCJicmFuY2giOm51bGwsImF1dGhvcml0aWVzIjpbIk1GT19DQU5fVVBEQVRFX05PVElGSUNBVElPTl9TRVRUSU5HUyIsIk1GT19DQU5fQVNTSUdOX1RJTExfQUNDT1VOVCIsIk1GT19DQU5fR0VUX0tZQ19ERVRBSUxTIiwiTUZPX0NBTl9VUERBVEVfTUVSQ0hBTlRfQUREUkVTUyIsIk1QRV9SRVNFUlZFX0FDQ09VTlQiLCJNRk9fQ0FOX1JFVFJJRVZFX1RJTExfQUNDT1VOVF9UUkFOU0FDVElPTlMiLCJNRk9fQ0FOX1VQREFURV9CVVNJTkVTU19ERVRBSUxTIiwiTUZPX0NBTl9DSEFOR0VfUEFTU1dPUkQiLCJNRk9fQ0FOX1VQREFURV9DT01QQU5ZX1JFR0lTVFJBVElPTl9ERVRBSUxTIiwiTUZPX0NBTl9VUERBVEVfU1VCX0FDQ09VTlRTIiwiTUZPX0NBTl9DUkVBVEVfSU5WT0lDRSIsIk1GT19DQU5fQ1JFQVRFX1NVQl9BQ0NPVU5UUyIsIk1GT19DQU5fR0VUX1RFTExfVVNFUlMiLCJNRk9fQ0FOX1ZJRVdfSU5WT0lDRSIsIk1GT19DQU5fR0VUX1VTRVJfREVUQUlMUyIsIk1GT19DQU5fUkVUUklFVkVfUkVTRVJWRURfQUNDT1VOVF9UUkFOU0FDVElPTlMiLCJNRk9fQ0FOX0dFVF9TRVRUTEVNRU5UX0RFVEFJTFMiLCJNRk9fQ0FOX1VQREFURV9JREVOVElUWV9JTkZPUk1BVElPTiIsIk1GT19DQU5fVVBEQVRFX1NFVFRMRU1FTlRfQUNDT1VOVCIsIk1GT19DQU5fRE9XTkxPQURfUFJPRklMRSIsIk1GT19DQU5fQ1JFQVRFX1JFU0VSVkVEX0FDQ09VTlQiLCJNRk9fQ0FOX0NSRUFURV9VU0VSIiwiTUZPX0NBTl9VUERBVEVfQ09OVFJBQ1RfREVUQUlMUyIsIk1GT19DQU5fVklFV19QQVlNRU5UX01FVEhPRF9ERVRBSUxTIiwiTUZPX0NBTl9ERUxFVEVfUkVTRVJWRURfQUNDT1VOVCIsIk1GT19DQU5fUkVUUklFVkVfUkVTRVJWRURfQUNDT1VOVCIsIk1GT19DQU5fUkVUUklFVkVfVElMTF9BQ0NPVU5UIiwiTUZPX0NBTl9WSUVXX0RBU0hCT0FSRCIsIk1GT19DQU5fQ1JFQVRFX1VTRVJTIiwiTUZPX0NBTl9WSUVXX1NVQl9BQ0NPVU5UUyIsIk1GT19DQU5fREVMRVRFX1RJTExfQUNDT1VOVCIsIk1GT19DQU5fVE9HR0xFX1VTRVJfU1RBVFVTIiwiTUZPX0NBTl9ERUxFVEVfU1VCX0FDQ09VTlRTIiwiTUZPX0NBTl9VUERBVEVfQlZOIiwiTUZPX0NBTl9VUERBVEVfUkVTRVJWRURfQUNDT1VOVCIsIk1GT19DQU5fQ1JFQVRFX1RJTExfQUNDT1VOVCIsIk1GT19DQU5fVU5BU1NJR05fVElMTF9BQ0NPVU5UIiwiTVBFX1JFVFJJRVZFX1JFU0VSVkVEX0FDQ09VTlQiXSwicGFuaWNNb2RlIjpmYWxzZSwiY2xpZW50X2lkIjoibW9ubmlmeS1mcm9udG9mZmljZS1zZXJ2aWNlIiwiZGV2aWNlU3RhdHVzIjoiREVGQVVMVCIsImZpcnN0TmFtZSI6IkRhbWlsYXJlIiwiYXVkIjpbImFwdHBheS1ub3RpZmljYXRpb24tc2VydmljZSIsImNvc21vcy1jb250cm9sLXNlcnZpY2UiLCJjb3Ntb3MtY29udHJvbC1jbGllbnQiLCJtb25uaWZ5LWZyb250b2ZmaWNlLXNlcnZpY2UiLCJtb25uaWZ5LXBheW1lbnQtZW5naW5lIl0sInNjb3BlIjpbInByb2ZpbGUiXSwibmFtZSI6IkRhbWlsYXJlIE9ndW5uYWlrZSIsInVzZXJUeXBlIjoiTG9jYWwgVXNlciIsImV4cCI6MTU3MDU0NTk0NSwianRpIjoiYTFlZmI3OGMtYjQ2MC00Y2M1LTlhNTgtOTcxNjM2ZGI3Zjg4IiwidXNlcm5hbWUiOiJvZ3VubmFpa2UuZGFtaWxhcmVAZ21haWwuY29tIn0.d8Op_PeqpWJN1efV_BBw0kl9s2geGkVNCk5cDhT9wOGOwryrHaKks21nItSz6vYG7C3t8TPndeOzxaJPFu5exb_EHX_UuxTY5vA7XrNn3q0QLkW2kZX3MjImSLs4ic3nI5jIfPMXn_SdWBkEo6KMvO8azOXwAigPCAmK1g_l3hrpnNOGqZSp8LbdJgLdR2F-fg8yaUHIA8evyGgSDobZGzX_dzWTIeQ_oImk8mIIUnfceZ8meemPk4akHGNYrQiPu0sJIacMRmjw9tfvvMxy8cG5UYk979TqCQi9tOyR2LJsCWxo5zLSzUX13XYzab3_gHxcdf7rQeZj2i1wqXMKUw" Request URL GET https://https://sandbox.monnify.com/api/v1/transactions/search?page=0&size=2&from=1602438060000&to=1605116460000
Get Transaction Status Request
{
"requestSuccessful": true,
"responseMessage": "success",
"responseCode": "0",
"responseBody": {
"content": [
{
"paymentMethod": "ACCOUNT_TRANSFER",
"createdOn": "2019-10-29T11:02:00.000+0000",
"amount": 22.00,
"flagged": false,
"currencyCode": "NGN",
"completedOn": "2019-10-29T11:08:11.000+0000",
"paymentDescription": "Isoken 001",
"paymentStatus": "EXPIRED",
"transactionReference": "MNFY|20191029110159|005805",
"paymentReference": "MNFY|20191029110159|005805",
"merchantCode": "ZETBBQ5Q7VLB",
"merchantName": "Lahray LTD "
},
{
"paymentMethod": "ACCOUNT_TRANSFER",
"createdOn": "2019-10-29T10:45:12.000+0000",
"amount": 22.00,
"flagged": false,
"fee": 0.18,
"currencyCode": "NGN",
"completedOn": "2019-10-29T10:49:49.000+0000",
"paymentDescription": "Isoken 001",
"paymentStatus": "PAID",
"transactionReference": "MNFY|20191029104511|005830",
"paymentReference": "MNFY|20191029104511|005830",
"merchantCode": "ZETBBQ5Q7VLB",
"merchantName": "Lahray LTD ",
"payableAmount": 22.00
}
],
"last": false,
"totalElements": 258,
"totalPages": 129,
"first": true,
"numberOfElements": 2,
"size": 2,
"number": 0,
"empty": false
}
}