Skip to main content
GET
Get all transactions

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<uuid>

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
currency
enum<string>

The currency of the transaction

Available options:
NGN,
KES,
ZAR
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<date-time>

Filter transactions from this date (ISO 8601 format)

Example:

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

endDate
string<date-time>

Filter transactions until this date (ISO 8601 format)

Example:

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

Response

Transaction response with pagination

status
string
Example:

"ok"

message
string
Example:

"all transaction"

count
integer

Total number of transactions

Example:

1

nextPage
boolean

Whether there is a next page available

Example:

false

currentPage
integer

Current page number

Example:

1

remainingPage
integer

Number of remaining pages

Example:

0

totalPages
integer

Total number of pages

Example:

1

data
object[]