Query Sub-Entity Transfer Status
This endpoint queries the current status of a previously submitted sub-entity transfer. The sourceEntityId is required to scope the lookup to the correct sub-entity.
POST {{host}}/api/v1/transactions/transfer/sub-entity/confirmation
Content-Type: application/json
Request Message Description
| # | Field Name | Data Type | Required | Description |
|---|---|---|---|---|
| 1 | sourceEntityId | Integer | Yes | Internal ID of the sub-entity that originated the transaction |
| 2 | clientRef | String | Conditional | The unique caller-supplied reference used when the transaction was created. Either clientRef or transactionId must be provided |
| 3 | transactionId | String | Conditional | The system-generated transaction identifier returned at creation. Either clientRef or transactionId must be provided |
Sample Request
{
"sourceEntityId": 78,
"clientRef": "TXN-20260521-00456"
}Response Message Field Description
| # | Field Name | Description |
|---|---|---|
| 1 | success | Indicates whether the request was successful |
| 2 | responseCode | HTTP-like response code (e.g. 200) |
| 3 | responseMessage | Human-readable result message |
| 4 | data | Object containing details of the created transaction |
| 4.1 | data.institutionId | ID of institution that initiated transfer |
| 4.2 | data.subInstitutionId | ID of the sub-entity that initiated the transfer |
| 4.3 | data.assetId | Asset transferred |
| 4.4 | data.blockchain | Blockchain network used |
| 4.5 | data.transactionType | Transaction type (e.g. TRANSFER) |
| 4.6 | data.amount | Amount transferred |
| 4.7 | data.feeCharged | Fee charged for transaction |
| 4.8 | data.status | Transaction status (e.g. SUBMITTED, COMPLETED) |
| 4.9 | data.subStatus | Detailed processing status |
| 4.10 | data.transactionId | System-generated transaction ID |
| 4.11 | data.clientRef | Caller-provided reference |
| 4.12 | data.transactionHash | On-chain hash (once available) |
| 4.13 | data.sourceAddress | Source wallet address |
| 4.14 | data.sourceWalletName | Source vault name |
| 4.15 | data.destinationAddress | Destination wallet address |
| 4.16 | data.destinationWalletName | Destination wallet name (if applicable) |
| 4.17 | data.destinationEntityId | Destination institution ID (if applicable) |
| 4.18 | data.note | Transaction narration |
| 4.19 | data.createdAt | Creation timestamp |
| 4.20 | data.updatedAt | Last update timestamp |
Sample Response (Success)
{
"success": true,
"responseCode": "200",
"responseMessage": "Success",
"data": {
"institutionId": 3,
"subInstitutionId": 78,
"assetId": "CNGN_B75VRLGX_8GWM",
"blockchain": "Base Testnet",
"transactionType": "TRANSFER",
"amount": "200.00",
"feeCharged": "0.80",
"status": "COMPLETED",
"subStatus": "CONFIRMED",
"transactionId": "ISW-TX-20260521-9G4L",
"clientRef": "TXN-20260521-00456",
"transactionHash": "0xHASH5432..............",
"sourceAddress": "0x94XYZ..............",
"sourceWalletName": "Acme Sub-entity Alpha",
"destinationAddress": "0xDEF05678..............",
"note": "Sub-entity payout run",
"createdAt": "2026-05-21T11:00:00",
"updatedAt": "2026-05-21T11:04:15"
}
}Sample Response (Failure)
{
"success": false,
"responseCode": "404",
"responseMessage": "Transaction Not Found"
}Updated about 11 hours ago
Did this page help you?
