Skip to main content
GET
List transactions
Retrieve and filter your full transaction history. Results include an aggregate overview independent of pagination.

Overview object

Every list response includes an overview with counts for the full filtered set — not just the current page:
Counts respect all query filters (status, type, from, to, channelId, amountMin, amountMax, q) but ignore cursor — the numbers stay consistent across pages.

Transaction fee field

Each transaction item includes a transactionFee field (merchant API) / transaction_fee field (developer API): The fee is 0 when no pricing rule is configured for your account.

Pagination

Transactions return newest first. Pass nextCursor from the previous response to fetch the next page.
nextCursor: null means you have reached the last page.

Filtering

Combine status and type to narrow results:

Authorizations

Authorization
string
header
required

Paste your PalPluss API key in the username field and leave the password field empty — it is ignored.

Get your key from console → Settings → API Keys (starts with pk_live_ or pk_test_).

In your own code, send the key directly: Authorization: Basic YOUR_API_KEY

Query Parameters

limit
integer
default:20

Number of records per page (1–100, default 20).

Required range: 1 <= x <= 100
cursor
string

Pagination cursor from the previous response nextCursor field.

status
enum<string>

Filter by transaction status.

  • PENDING — Awaiting customer action or provider response
  • PROCESSING — Provider accepted; waiting for final confirmation
  • SUCCESS — Completed successfully
  • FAILED — Transaction failed (provider declined or timeout)
  • REVERSED — Successfully reversed (wallet credited back)
  • CANCELLED — Cancelled before processing
Available options:
PENDING,
PROCESSING,
SUCCESS,
FAILED,
REVERSED,
CANCELLED
type
enum<string>

Filter by transaction type.

  • STK — M-Pesa STK Push collection
  • B2C — Business to Customer payout
Available options:
STK,
B2C

Response

Paginated list of transactions.

success
boolean
required
Example:

true

data
object
required

Response payload. Shape varies by endpoint.

requestId
string<uuid>
required

Unique identifier for this API request. Include in support tickets.

Example:

"c1b2a3d4-e5f6-7890-abcd-ef1234567890"