v1

latestOpenAPI 3.1.02026-08-04490133.8 KB

Get Transactions

get/transactions

Path parameters

searchstring required

Enter the transaction reference

rangestring required

options are day, week, month, year

limitinteger required

Start from 1. Default value is 10

pageinteger required

Start from 1. Default value is 1

fromstring date required

format YYYY-MM-dd

tostring date required

format YYYY-MM-dd

typestring required

options are payout, exchange, collection

currencystring required

options are UGX, USD, NGN, GHS, KES, RWF, TZS

statusstring required

options are pending, successful, failed

Response

200

codeinteger
successboolean

Example response

{
  "code": 200,
  "data": {
    "total_payouts": "20000",
    "total_collections": "19000",
    "transactions": [
      {
        "id": 792,
        "transactionId": "BE31661876379861",
        "type": "exchange",
        "currency": "UGX",
        "amount": "100",
        "balanceBefore": "398.78",
        "balanceAfter": "398.78",
        "destinationCurrency": "KES",
        "destinationAmount": "3.1007201981367",
        "accountId": 3,
        "meta": {
          "source": {
            "amount": 100,
            "balance": {
              "after": "398.78",
              "before": "398.78"
            },
            "currency": "UGX"
          },
          "destination": {
            "amount": 3.1,
            "balance": {
              "after": "1783.82",
              "before": "1783.82"
            },
            "currency": "KES"
          }
        },
        "status": "successful",
        "createdAt": "2022-08-30T16:19:39.864Z",
        "updatedAt": "2022-08-30T16:19:39.864Z"
      }
    ],
    "total": 1,
    "limit": 10,
    "page": 1
  },
  "success": true
}