v1

latestOpenAPI 3.1.02026-07-26590236.8 KB

List Transactions

get/transaction

Query parameters

pageinteger
per_pagestring
fromstring date
tostring date
status'pending' | 'failed' | 'completed' | 'reversed' | 'cancelled' | 'successful' | 'declined' | 'refunded' | 'chargeback' | 'chargeback_reversed'
currency'USD' | 'NGN' | 'GBP' | 'EUR' | 'CNY' | 'KES'
account_idstring
card_idstring
linked_transaction_idstring
kindstring
includestring

You can populate relationships by appending the transaction type i.e deposit, charge, conversion, payout as comma separated values

Response

200

messagestring
statusstring

Example response

{
  "data": [
    {
      "id": "d106fee8696011eda78fe041a4724e32",
      "account_id": "c311174468f511eda78fe041a4724e32",
      "kind": "deposit",
      "deposit_id": "d101a04c696011eda78fe041a4724e32",
      "type": "credit",
      "description": "Account Opened",
      "currency": "USD",
      "amount": 100000,
      "balance_before": 297000,
      "balance_after": 396000,
      "status": "successful",
      "created_at": "2022-11-21T06:53:26Z",
      "updated_at": "2022-11-21T06:53:26Z"
    }
  ],
  "message": "Transactions retrieved successfully",
  "meta": {
    "per_page": 20,
    "page": 1,
    "count_total": 1,
    "page_total": 1
  },
  "status": "success"
}