STstealthmoney
Transaction

Get all transactions

Changed on

Returns all transactions with pagination and filtering options

get/transactions

Request

Query parameters

pageinteger

Page number for pagination

limitinteger

Number of items per page

txIdstring uuid

Filter by transaction ID

accountNamestring

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

status'SUCCESS' | 'PENDING' | 'FAILED'

Filter by transaction status

type'WITHDRAWAL' | 'DEPOSIT'

Filter by transaction type

currency'NGN' | 'KES' | 'ZAR' | 'USDT'

The currency of the transaction

minAmountinteger

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

maxAmountinteger

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

startDatestring date-time
Example:2024-01-01T00:00:00Z

Filter transactions from this date (ISO 8601 format)

endDatestring date-time
Example:2024-12-31T23:59:59Z

Filter transactions until this date (ISO 8601 format)

Response

Transaction response with pagination

statusstring
messagestring
countinteger

Total number of transactions

nextPageboolean

Whether there is a next page available

currentPageinteger

Current page number

remainingPageinteger

Number of remaining pages

totalPagesinteger

Total number of pages

Example response

{
  "status": "ok",
  "message": "all transaction",
  "count": 1,
  "currentPage": 1,
  "totalPages": 1,
  "data": [
    {
      "id": "10cda92f-db32-4f69-ae30-af32a0055caf",
      "ref": "142a39e0bb85c45b06a9657f56156",
      "hash": "89d7fd6571c8bdf4242091953553c26228dd5b7679729d20aaf2cc84f000d1bc",
      "amount": 10000,
      "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",
        "order": {
          "id": "22723-5636",
          "settledQuoteId": "e3d3cb1c-3206-40bb-81a9-8dfd9d69a853",
          "amount": 10000,
          "quote": {
            "exchangeRate": 1874805.7499999998,
            "usdToTargetCurrencyRate": 18.4977,
            "totalAmount": 6474,
            "equivalentAmount": 10000
          }
        }
      }
    }
  ]
}

Changes

  • 842376cab855Revision changes
    • warning

      added the new USDT enum value to the // response property for the response status

    • info

      added the new enum value USDT to the query request parameter currency

  • 49368798ec50Revision changes
    • info

      the query request parameter currency became optional