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 NameData TypeRequiredDescription
1sourceEntityIdIntegerYesInternal ID of the sub-entity that originated the transaction
2clientRefStringConditionalThe unique caller-supplied reference used when the transaction was created. Either clientRef or transactionId must be provided
3transactionIdStringConditionalThe 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 NameDescription
1successIndicates whether the request was successful
2responseCodeHTTP-like response code (e.g. 200)
3responseMessageHuman-readable result message
4dataObject containing details of the created transaction
4.1data.institutionIdID of institution that initiated transfer
4.2data.subInstitutionIdID of the sub-entity that initiated the transfer
4.3data.assetIdAsset transferred
4.4data.blockchainBlockchain network used
4.5data.transactionTypeTransaction type (e.g. TRANSFER)
4.6data.amountAmount transferred
4.7data.feeChargedFee charged for transaction
4.8data.statusTransaction status (e.g. SUBMITTED, COMPLETED)
4.9data.subStatusDetailed processing status
4.10data.transactionIdSystem-generated transaction ID
4.11data.clientRefCaller-provided reference
4.12data.transactionHashOn-chain hash (once available)
4.13data.sourceAddressSource wallet address
4.14data.sourceWalletNameSource vault name
4.15data.destinationAddressDestination wallet address
4.16data.destinationWalletNameDestination wallet name (if applicable)
4.17data.destinationEntityIdDestination institution ID (if applicable)
4.18data.noteTransaction narration
4.19data.createdAtCreation timestamp
4.20data.updatedAtLast 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"
}

Did this page help you?