Skip to main content

All Transactions

After the transactions have been created. Users can view a list of all transactions made so far. To view all transactions, use this endpoint below.

GET /api/v1/client/transactions


Path param

authorization : *bearer
REQUEST BODY SCHEMA: application/json


NameDescriptionType
clientIdClient IdString
dateQuery for transaction created on this specific date. For date range filtering, use to and from parameters. Example: date=03-03-2021string
fromDefault: "Query transactions which were created on this date. Use in combination with <code>to</code> for range filtering"string
invoiceIdDefault: 100 Example: limit=50.Number of items to return per pageString
invoiceNoInvoice numberstring
policyIdExample: policyId=6183cd2c7c1fbfeffea4b6e0 Filter transactions by policystring
statusQuery transactions by status. Enum: "PENDING_PAYMENT" "PENDING_APPROVAL" "PENDING_VERIFICATION" "VERIFIED"string
toDefault: "Query transactions which were created on this date. <br> Use in combination with <code>from< code> for range filtering" Example: to=03-03-2021string

Response

CodeDescription
200List of all records
409Unauthorized.

Example Success Response

Content type
application/json

[
{
"statusCode": 200,
"success": true,
"data": [
{
"dateReceived": "string",
"payee": "string",
"transactionType": "RENEWAL",
"transactionNo": "string",
"paymentInstitution": "string",
"description": "",
"amount": 0,
"exchangeRate": 1,
"currency": "GHC",
"documents": [ ],
"checkoutUrl": "string",
"convertedAmount": 0,
"status": "PENDING_PAYMENT",
"cheque": { },
"invoice": {},
"paymentMethod": "ONLINE"
}
]
}
...
]