Skip to main content

Transaction Ledger

Retrieve wallet transactions for the current workspace and environment. Includes top-ups, shipment fee deductions, and refunds. Supports cursor-based pagination and date range filtering.


Endpoint

GET/v1/wallet/transactions

Required permission: wallet:transactions:get


Query Parameters

ParameterTypeRequiredDescription
limitIntegerMax records per page. Defaults to 20.
cursorStringPagination cursor from a previous response.
startDateStringISO 8601 start of the date range (e.g. 2026-07-01T00:00:00Z).
endDateStringISO 8601 end of the date range (e.g. 2026-07-31T23:59:59Z).

When both startDate and endDate are omitted, all transactions for the environment are returned in reverse-chronological order.


Response

Top-level fields

FieldTypeDescription
itemsArrayList of transaction records.
nextCursorString?Cursor to fetch the next page. null when there are no more results.

Item fields

FieldTypeDescription
idStringUnique ledger entry ID (e.g. TNX_A1B2C3D4).
dateStringISO 8601 UTC timestamp of the transaction.
typeStringTransaction category. TOPUP, SHIPMENT_FEE, or REFUND.
descriptionStringHuman-readable summary of the transaction.
amountFloatTransaction value in ₦.
balanceAfterFloatWallet balance immediately after this transaction.
referenceString?Associated reference ID. shipment ID for fees/refunds, bank reference for top-ups.

Transaction Types

ValueWhen it appears
TOPUPA wallet deposit was processed.
SHIPMENT_FEEA shipment was booked and the fee was deducted.
REFUNDA shipment was canceled and the fee was returned.

{
"statusCode": 200,
"message": "Success",
"data": {
"items": [
{
"id": "TNX_A1B2C3D4E5",
"date": "2026-07-01T18:00:00Z",
"type": "TOPUP",
"description": "Prepaid Deposit via GTBank",
"amount": 50000,
"balanceAfter": 150000,
"reference": "GTB2026070100987"
},
{
"id": "TNX_B2C3D4E5F6",
"date": "2026-07-01T17:42:00Z",
"type": "SHIPMENT_FEE",
"description": "Shipment fee for payment reference TCL-SB-3891829",
"amount": 33040,
"balanceAfter": 100000,
"reference": "SHP_Z8F9A2B3C4"
}
],
"nextCursor": null
}
}