Fetch Transactions (Paginated)
This endpoint retrieves a paginated list of transactions for the institution associated with the auth token. Supports a rich set of filters including date range, status, asset, transaction type, addresses, and more.
GET {{host}}/api/v1/transactions/transfer
Query Parameters
| # | Field Name | Data Type | Required | Default | Description |
|---|---|---|---|---|---|
| 1 | page | Integer | No | 1 | Page number to retrieve (1-indexed) |
| 2 | perPage | Integer | No | 100 | Number of records to return per page |
| 3 | startDateTime | String | No | - | Filter transactions created on or after this datetime. Format: yyyy-MM-dd HH:mm:ss |
| 4 | endDateTime | String | No | - | Filter transactions created on or before this datetime. Format: yyyy-MM-dd HH:mm:ss |
| 5 | subInstitutionId | Integer | No | - | Filter by a specific sub-entity's internal ID |
| 6 | status | String | No | - | Filter by transaction status (e.g. SUBMITTED, COMPLETED, FAILED) |
| 7 | transactionType | String | No | - | Filter by transaction type (e.g. TRANSFER) |
| 8 | operation | String | No | - | Filter by transaction operation direction (e.g. DEBIT, CREDIT) |
| 9 | assetId | String | No | - | Filter by asset identifier (e.g. CNGN_B75VRLGX_8GWM) |
| 10 | sourceAddress | String | No | - | Filter by the source blockchain address |
| 11 | destinationAddress | String | No | - | Filter by the destination blockchain address |
| 12 | sourceWalletName | String | No | - | Filter by the name of the source vault wallet |
| 13 | destinationWalletName | String | No | - | Filter by the name of the destination vault wallet |
| 14 | transactionHash | String | No | - | Filter by on-chain transaction hash |
| 15 | transactionId | String | No | - | Filter by system-generated transaction ID |
Sample Request
GET {{host}}/api/v1/transactions/transfer?page=1&perPage=50&status=COMPLETED&assetId=CNGN_B75VRLGX_8GWM&startDateTime=2026-05-01 00:00:00&endDateTime=2026-05-21 23:59:59
Response Message Field Description
| # | Field Name | Description |
|---|---|---|
| 1 | success | Indicates whether the request was successful (true for success) |
| 2 | responseCode | HTTP-like response code (e.g. 200 for success) |
| 3 | responseMessage | Human-readable result message (e.g. Success) |
| 4 | data | Paginated wrapper object |
| 4.1 | data.page | The current page number returned |
| 4.2 | data.perPage | Number of records per page |
| 4.3 | data.message | Human-readable result message |
| 4.4 | data.totalData | Total number of transaction records across all pages |
| 4.5 | data.totalFilteredCount | Total number of records matching the applied filters |
| 4.6 | data.data | Array of transaction objects (same structure as Create Institution Transfer response data) |
Sample Response (Success)
{
"success": true,
"responseCode": "200",
"responseMessage": "Success",
"data": {
"page": 1,
"perPage": 50,
"message": "Success",
"totalData": 320,
"totalFilteredCount": 18,
"data": [
{
"institutionId": 3,
"subInstitutionId": null,
"assetId": "CNGN_B75VRLGX_8GWM",
"blockchain": "Base Testnet",
"transactionType": "TRANSFER",
"amount": "500.00",
"feeCharged": "1.50",
"status": "COMPLETED",
"subStatus": "CONFIRMED",
"transactionId": "ISW-TX-20260521-8F3K",
"clientRef": "TXN-20260521-00123",
"transactionHash": "0xHASH9876..............",
"sourceAddress": "0x632E8..............",
"sourceWalletName": "Acme Financial Services",
"destinationAddress": "0xABCD1234..............",
"destinationWalletName": null,
"note": "Payment for settlement batch #42",
"createdAt": "2026-05-21T10:15:00",
"updatedAt": "2026-05-21T10:18:42"
}
]
}
}Sample Response (Failure)
{
"success": false,
"responseCode": "401",
"responseMessage": "Unauthorized"
}Updated about 11 hours ago
Did this page help you?
