GET
/
transactions
curl --request GET \
  --url https://staging.api.mavapay.co/api/v1/transactions \
  --header 'X-API-KEY: <api-key>'
{
  "status": "ok",
  "message": "all transaction",
  "count": 1,
  "nextPage": false,
  "currentPage": 1,
  "remainingPage": 0,
  "totalPages": 1,
  "data": [
    {
      "id": "10cda92f-db32-4f69-ae30-af32a0055caf",
      "ref": "142a39e0bb85c45b06a9657f56156",
      "hash": "89d7fd6571c8bdf4242091953553c26228dd5b7679729d20aaf2cc84f000d1bc",
      "amount": 10000,
      "fees": 0,
      "currency": "NGN",
      "type": "WITHDRAWAL",
      "status": "SUCCESS",
      "autopayout": true,
      "createdAt": "2025-01-23T10:46:01.050Z",
      "updatedAt": "2025-01-23T10:46:04.590Z",
      "metadata": {
        "id": "f2bf7bf8-9fe9-4afd-9ebb-cf3abae8cb19",
        "merchantId": "f77986d6-75df-4979-85a9-8acedcfca392",
        "merchantName": "Ricki Allardice",
        "bankName": "CAPITEC BANK",
        "bankAccountNumber": "1352906218",
        "reference": "2bNkqVDLER7n65O7RrcV",
        "customerInternalFee": 0,
        "order": {
          "id": "22723-5636",
          "settledQuoteId": "e3d3cb1c-3206-40bb-81a9-8dfd9d69a853",
          "amount": 10000,
          "currency": "NGN",
          "paymentMethod": "LIGHTNING",
          "status": "PAID",
          "quote": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "exchangeRate": 1874805.7499999998,
            "usdToTargetCurrencyRate": 18.4977,
            "paymentBtcDetail": "<string>",
            "paymentMethod": "LIGHTNING",
            "totalAmount": 6474,
            "equivalentAmount": 10000,
            "expiry": "2023-11-07T05:31:56Z",
            "sourceCurrency": "BTCSAT",
            "targetCurrency": "NGNKOBO",
            "paymentCurrency": "NGNKOBO",
            "customerInternalFee": 0
          }
        }
      }
    }
  ]
}

Authorizations

​
X-API-KEY
string
header
required

Query Parameters

​
page
integer
default:1

Page number for pagination

Required range: x >= 1
​
limit
integer
default:10

Number of items per page

Required range: 1 <= x <= 100
​
txId
string

Filter by transaction ID

​
accountName
string

Filter by account name (only applicable for NGN and ZAR transactions)

​
status
enum<string>

Filter by transaction status

Available options:
SUCCESS,
PENDING,
FAILED
​
type
enum<string>

Filter by transaction type

Available options:
WITHDRAWAL,
DEPOSIT
​
minAmount
integer

Filter by minimum amount (in lowest denomination of the currency)

Required range: x >= 0
​
maxAmount
integer

Filter by maximum amount (in lowest denomination of the currency)

Required range: x >= 0
​
startDate
string

Filter transactions from this date (ISO 8601 format)

Example:

"2024-01-01T00:00:00Z"

​
endDate
string

Filter transactions until this date (ISO 8601 format)

Example:

"2024-12-31T23:59:59Z"

Response

200
application/json

Transaction response with pagination

The response is of type object.