Sign in
Transaction

Get all transactions

Returns all transactions with pagination and filtering options

get/transactions

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

Changed in 7 of the 32 revisions of this API.9523

  • 842376cab85511See the full diff
    • ●

      added the new USDT enum value to the data/items/currency response property for the response status 200

      response-property-enum-value-added

    • ○

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

      request-parameter-enum-value-added

  • 49368798ec501See the full diff
    • ○

      the query request parameter currency became optional

      request-parameter-became-optional

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 295a24f2c2611See the full diff
    • ○

      added the new optional query request parameter currency

      new-optional-request-parameter

  • f3878f349317117See the full diff
    • ▲

      the status response's property type/format changed from string/string to string/ for status 200

      response-property-type-changed

    • ○

      added the new optional query request parameter accountName

      new-optional-request-parameter

    • ○

      added the new optional query request parameter endDate

      new-optional-request-parameter

    • ○

      added the new optional query request parameter limit

      new-optional-request-parameter

    • ○

      added the new optional query request parameter maxAmount

      new-optional-request-parameter

    • ○

      added the new optional query request parameter minAmount

      new-optional-request-parameter

    • ○

      added the new optional query request parameter page

      new-optional-request-parameter

    • ○

      added the new optional query request parameter startDate

      new-optional-request-parameter

    • ○

      added the new optional query request parameter status

      new-optional-request-parameter

    • ○

      added the new optional query request parameter txId

      new-optional-request-parameter

    • ○

      added the new optional query request parameter type

      new-optional-request-parameter

    • ○

      added the optional property count to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property currentPage to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property message to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property nextPage to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property remainingPage to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property totalPages to the response with the 200 status

      response-optional-property-added

    • ○

      removed the TRANSFER enum value from the data/items/type response property for the response status 200

      response-property-enum-value-removed

  • 7b7e4fa5fe46821See the full diff
    • ▲

      the data/items/amount response's property type/format changed from number/number to number/ for status 200

      response-property-type-changed

    • ▲

      the data/items/autopayout response's property type/format changed from boolean/boolean to boolean/ for status 200

      response-property-type-changed

    • ▲

      the data/items/currency response's property type/format changed from string/string to string/ for status 200

      response-property-type-changed

    • ▲

      the data/items/fees response's property type/format changed from number/number to number/ for status 200

      response-property-type-changed

    • ▲

      the data/items/hash response's property type/format changed from string/string to string/ for status 200

      response-property-type-changed

    • ▲

      the data/items/ref response's property type/format changed from string/string to string/ for status 200

      response-property-type-changed

    • ▲

      the data/items/status response's property type/format changed from string/string to string/ for status 200

      response-property-type-changed

    • ▲

      the data/items/type response's property type/format changed from string/string to string/ for status 200

      response-property-type-changed

    • ●

      removed the optional property data/items/transactionMetadata from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/items/walletId from the response with the 200 status

      response-optional-property-removed

    • ○

      added the optional property data/items/metadata to the response with the 200 status

      response-optional-property-added

  • c220a343551221See the full diff
    • ●

      removed the optional property data/items/transactionMetadata/eProviderRef from the response with the 200 status

      response-optional-property-removed

    • ●

      added the new ZAR enum value to the data/items/currency response property for the response status 200

      response-property-enum-value-added

    • ○

      removed the USD enum value from the data/items/currency response property for the response status 200

      response-property-enum-value-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 05948c6d94921See the full diff
    • ○

      endpoint added

      endpoint-added