Get All Transactions

Overview

Description: This endpoint retrieves a list of transaction details with pagination support

Endpoint: {base_url}/alltransactions

REQUEST PARAMETER

Request Parameters

Request Parameters

#	Parameter	Type	Description	Required?
1	endDate	String	The end date for the query, in ISO 8601 format.	Yes
2	page	Integer	The page number for pagination	Yes
3	size	Integer	The number of records per page	Yes
4	startDate	String	The start date for the query, in ISO 8601 format	Yes

Response Parameters

Response Parameters

#	Parameter	Type	Description	Mandatory
1	count	Integer	Number of transactions returned	Yes
2	error	String	Error message, if applicable	No
3	execTime	String	Execution time of the request	No
4	hasnext	Boolean	Indicates if there is a next page	Yes
5	hasprevious	Boolean	Indicates if there is a previous page	Yes
6	islast	Boolean	Indicates if this is the last page	Yes
7	limit	Integer	Maximum number of items per request	Yes
8	message	String	Additional message about the response	No
9	offset	Integer	Offset value for pagination	Yes
10	status	Integer	Status code of the response	Yes
11	total	Integer	Total number of transactions available	Yes
12	transactions	Array of Objects	List of transaction details	Yes
13	transactions.amount	Integer	Amount associated with the transaction	Yes
14	transactions.billerserviceid	String	Bill service ID related to the transaction	Yes
15	transactions.billsessionid	String	Session ID of the bill	Yes
16	transactions.clientid	Integer	Client ID associated with the transaction	Yes
17	transactions.createdat	String	Timestamp when the transaction was created	Yes
18	transactions.createdby	String	User who created the transaction	No
19	transactions.fee	Integer	Transaction fee	No
20	transactions.id	Integer	Unique identifier for the transaction	Yes
21	transactions.modifiedat	String	Timestamp when the transaction was last modified	No
22	transactions.modifiedby	String	User who last modified the transaction	No
23	transactions.narration	String	Narration or description of the transaction	No
24	transactions.reversed	Boolean	Indicates if the transaction was reversed	Yes
25	transactions.switchreference	String	Reference ID for the switch operation	No
26	transactions.switchresponsecode	String	Response code for the switch operation	No
27	transactions.transactionreference	String	Unique reference for the transaction	Yes
28	transactions.username	String	Username associated with the transaction	No

Sample Request

Request Parameters

POST {base_url}/alltransactions

curl `${base_url}/alltransactions`
-H "Content-type: application/json"
-X POST
-d '{
  "endDate": "2025-02-11T10:39:10.600Z",
  "page": 0,
  "size": 0,
  "startDate": "2025-02-11T10:39:10.600Z"
}
'

Sample Response

Response Parameters

POST {base_url}/alltransactions

{
  "count": 0,
  "error": "string",
  "execTime": "string",
  "hasnext": true,
  "hasprevious": true,
  "islast": true,
  "limit": 0,
  "message": "string",
  "offset": 0,
  "status": 0,
  "total": 0,
  "transactions": [
    {
      "amount": 0,
      "billerserviceid": "string",
      "billsessionid": "string",
      "clientid": 0,
      "createdat": "2025-02-11T10:39:10.599Z",
      "createdby": "string",
      "fee": 0,
      "id": 0,
      "modifiedat": "2025-02-11T10:39:10.599Z",
      "modifiedby": "string",
      "narration": "string",
      "reversed": true,
      "switchreference": "string",
      "switchresponsecode": "string",
      "transactionreference": "string",
      "username": "string"
    }
  ]
}