Skip to main content
GET
List transactions
Useful for an overview or periodic reconciliation. To check a specific transaction you have just created, prefer Retrieve a transaction, which is more direct and accepts your own transaction_id.
  • Filters. query filters on free text; the other parameters filter on an exact value or a date range. They all apply at the same time (logical AND), not as alternatives. The example only shows a subset: add or remove parameters as needed.
  • Displayed values. The values of status and payment_method (see the payment methods) are formatted for display and do not match the machine values used by the other operations: do not compare them in your code, and only use this list for display or export.
  • Limits. No rate limit is documented: to be confirmed with support before heavy use. For real-time tracking of a given transaction, prefer webhooks over repeatedly polling this list.
Common error messages: Errors.

Authorizations

Authorization
string
header
required

Secret key of the Sandbox or Live account

Headers

Content-Type
string
required

Required by the API authentication, including on GET requests, even though they have no body.

Allowed value: "application/json"
Ipay-Target-Environment
enum<string>
required
Available options:
sandbox,
live
Ipay-Payment-Type
string
required

Payment method. POST /payments only supports mobile (mobile money). Other payment methods (bank card and other channels) are not used here: they are available through payment links (POST /external_payments). Full list: payment methods.

Allowed value: "mobile"
Example:

"mobile"

Query Parameters

query
string
status
enum<string>
Available options:
initiated,
pending,
succeeded,
failed,
refunded
created_from
string<date>
created_to
string<date>
items
integer
default:25
Required range: x >= 1

Response

List of transactions (raw JSON array, without a pagination envelope). The status and payment_method values are formatted for display (e.g. Succeeded, Airtel Ne) and not normalized: do not compare them with the status values used by the other operations.

id
integer
reference
string
status
string
Example:

"Succeeded"

amount
integer
fees
integer
payment_method
string

Payment method used by the customer — see the list of payment methods.

Example:

"Airtel Ne"

net_amount
integer
platform
string
device
string
failure_reason
string | null
country
string
currency
string
external_reference
string
msisdn
string
customer_name
string
created_at
string<date-time>
validated_at
string<date-time> | null