AM/TA/Inv - Get Transaction Details

Details

/external/v1/transactions

Synopsis

Get Transaction Details

get

This route is used to retrieve the details of transactions, given a set of search filters. This endpoint is paginated, up to 50 records can be retrieved per call. This endpoint can be called by applications with access to scope "readTransactionData".

Required scopes

This endpoint requires the following scopes:

• : readTransactionData

Authorizations

oauth2

OAuth2clientCredentialsRequired

Token URL:

Query parameters

pageSizenumberOptional

The number of rows being retrieved. Must be a positive integer.

offsetnumberOptional

The offset (i.e. row start index). Must be a positive integer (or 0).

blockNumbernumber · max: 2147483647Optional

The block number where the action was recorded on the ledger.

Example: 350

transactionIdstring · max: 500Optional

The transaction id where the action was recorded on the ledger.

Example: 456789OIJHGFCVGHJKLKJHGF67JHPattern: ^[a-zA-Z0-9-]*$

channelNamestring · max: 20Optional

The name of the channel where the action was recorded on the ledger.

Example: OG123Pattern: ^[a-zA-Z0-9-]*$

transactionStatusFilterstringOptional

The comma delimited list of statuses to filter the transaction records. Up to 5 entries can be provided.Available values: in_progress, success, failed, timed_out, queued

Example: queued,success

transactionMethodFilterstringOptional

The comma delimited list of statuses to filter the transaction records. Up to 253 entries can be provided.Available values: lifecycle, initParams, updateParams, getIssuance, getIssuanceByProcessId, getIssuanceWithShareClassesByProcessId, getTotals, getTotalsByProcessId, getTotalsWithShareClassesByProcessId, getFacilitationAccount, getFacilitationAccountByProcessId, getFeesTemplate, getFeesTemplateByProcessId, getFeesTemplateBatch, getFeesTemplateBatchByProcessId, getAsset, getAssetByProcessId, getAssetsBatch, getAssetsBatchByProcessId, getNAV, getNAVBatch, getNAVBatchByProcessId, getTender, getTenderByProcessId, getAllTenders, getTrade, getTradeByProcessId, getTradesBatch, getTradesBatchByProcessId, getCapitalEvent, getCapitalEventByProcessId, getBreakdownCategory, getBreakdownCategoryByProcessId, getBreakdownCategoriesBatchByProcessId, getAssetCapitalEvent, getAssetCapitalEventByProcessId, getCapitalEventAssetsBatch, getCapitalEventAssetsBatchByProcessId, getTransfer, getTransferByProcessId, getClose, getCloseByProcessId, getInvestorOrg, getInvestorOrgByProcessId, getInvestorOrgWithShareClassesByProcessId, getServiceProvider, getServiceProviderByProcessId, getAllInvestorOrgs, getAllServiceProviders, getEntityOrgCorrelations, getEntityOrgCorrelationsByProcessId, getEntityOrgCorrelationsBatchByProcessId, getPosition, getPositionByProcessId, getPositionsBatchByProcessId, getPayment, getPaymentsBatch, getPaymentByProcessId, getPaymentsBatchByProcessId, getAssociatePaymentEntitiesBatchByProcessId, counter:increment, createBatch, restrict, recover, cancelStart, cancelBatch, cancelFinish, retire, bustCampaignStart, bustCampaignBatch, bustCampaignFinish, completeCampaign, confirmCampaign, refundCampaignStart, refundCampaignBatch, refundCampaignFinish, approveRevertCompletedCampaign, revertCompletedCampaign, extendEndDate, updateMaxTotalInvestmentAmount, updateAllowBelowMinimum, pause, unpause, addFacilitationAccount, removeFacilitationAccount, createInvestment, requestInvestmentRemediation, remediateInvestment, cancelInvestment, declineInvestment, rejectInvestment, disposeInvestment, transferInvestment, createOfflineInvestment, disposeIssuedInvestment, recallAsset, acceptRecallAsset, rejectRecallAsset, markWiredBatch, createInvestmentBatch, allocateInvestmentInputsBatch, settleInvestmentBatch, settleRebalanceInputsBatch, settleAllocationInvestmentBatch, confirmInvestmentBatch, confirmCommitmentBatch, setAssetReviewStatusBatch, updateAssetExternalStateBatch, submitTradeSellOrder, proposeTradeMatch, settleTrade, declineTrade, cancelTrade, restrictTrade, recoverTrade, acceptTrade, registerNewNAVBatch, updateNAVBatch, deleteNAVBatch, createTenderOffer, createAndStartTenderOffer, updateTenderOffer, cancelTenderOffer, approveTenderOffer, rejectTenderOffer, startCloseTenderOffer, closeTenderOfferTradesBatch, finishCloseTenderOffer, updateTenderPrice, updateTenderPriceShareClasses, approveTenderPrice, rejectTenderOfferPrice, completeTenderPrice, applyTenderPriceTradesBatch, submitTenderRequest, cancelTenderRequest, startSettleTenderPrice, settleTenderPriceTradesBatch, finishSettleTenderPrice, createCapitalEvent, updateCapitalEvent, approveCapitalEventStart, approveCapitalEventBatch, approveCapitalEventFinish, rejectCapitalEvent, closeCapitalEvent, cancelCapitalEventStart, cancelCapitalEventBatch, cancelCapitalEventFinish, applyCapitalEventBatch, settleCapitalEventBatch, failCapitalEventBatch, unrestrictCapitalEventBatch, fundCapitalEventBatch, upsertBreakdownCategories, addServiceProvider, removeServiceProvider, acceptServiceProvider, rejectServiceProvider, addInvestorOrg, removeInvestorOrg, updateIsRepLetterProvided, acceptInvestorOrg, rejectInvestorOrg, createTransfer, approveTransferByIssuer, requestTransferRemediation, remediateTransfer, allocateTransferAssets, requestTransferAssetsRemediation, remediateTransferAssets, cancelTransfer, completeTransfer, createClose, issueAssetsBatch, externalIssueAssetsBatch, createRedemption, cancelRedemptionOrder, acceptRedemptionBatch, addEntityOrgCorrelation, removeEntityOrgCorrelation, updateAsset, upsertFeesTemplates, updatePositionBatch, setAssetPositionBatch, updateModelPositionBatch, createPaymentBatch, associatePaymentEntitiesBatch, executePaymentBatch, settlePaymentBatch, setReferenceDataHash, publishCommentBatch, changeCommentReviewStatusBatch, getCommentBatch, getCommentBatchByProcessId, getOrgData, getOrgDataByProcessId, getAllOrgs, addEnterpriseOrg, removeEnterpriseOrg, addTenant, removeTenant, updateOrgData, parseAndValidate, validateOrderAndRegisterReview, createRebalanceEvent, matchRebalanceEventOrders, cancelRebalanceEvent, syncWhitelist, createChannelForOrg, joinChannelOrg, addFromCommonChannel, channelConfigUpdate, getModelPortfolio, getModelPortfolioByProcessId, getModelClass, getModelClassByProcessId, getModelClassBatchByProcessId, getModelAsset, getModelAssetByProcessId, getModelAssetsBatchByProcessId, getModelPortfolioInvestorOrg, getModelPortfolioInvestorOrgByProcessId, getModelPosition, getModelPositionByProcessId, getModelPositionsBatchByProcessId, getRebalanceRequestBatchByProcessId, createModelPortfolio, updateModelPortfolio, createModelAsset, createModelAssetBatch, rejectModelAsset, requestModelAssetRemediation, remediateModelAsset, confirmModelAssetsBatch, confirmCashSleeveAssetsBatch, markModelAssetWiredBatch, settleModelAssetBatch, recallModelAsset, acceptRecallModelAsset, rejectRecallModelAsset, declineModelAsset, cancelModelAsset, disposeModelAsset, addModelPortfolioInvestorOrg, removeModelPortfolioInvestorOrg, acceptModelPortfolioInvestorOrg, rejectModelPortfolioInvestorOrg, startAllocation, finishAllocation, confirmRebalanceBatch, markRebalanceWiredBatch, settleRebalanceBatch

Example: createInvestment,setReferenceDataHash

processIdsFilterstringOptional

The comma delimited list of transactions ids to filter the transaction records. Up to 50 records can be provided. Each record should be a UUID v4 value.

Example: bbb562cc-636a-48c0-9d77-ba1f1b15da07,

orgIdsFilterstringOptional

The comma delimited list of org ids to filter the transaction records. Up to 10 records can be provided. Each record should not exceed 5 characters.

Example: USCCW,IOICM

orchestrationIdsFilterstringOptional

The comma delimited list of orchestration ids to filter the transaction records. Up to 10 records can be provided. Each record should be a UUID v4 value.

Example: bbb562cc-636a-48c0-9d77-ba1f1b15da07,2159457f-0167-4e93-a969-9cf0db05e0bf

Responses

200

Successfully retrieved transaction details

application/json

processIdstringRequired

The unique identifier of the transaction

Example: 3f50c1e2-1c4b-4b8b-9a6e-2b5e4e5f6a7b

syncJobIdstringOptional

The id of the sync job that this transaction is part of

Example: 3f50c1e2-1c4b-4b8b-9a6e-2b5e4e5f6a7b

grantedByProcessIdstringOptional

The id of the transaction process that granted entitlement to the action details encompassed in this transaction

Example: 3f50c1e2-1c4b-4b8b-9a6e-2b5e4e5f6a7b

timestampone ofOptional

The timestamp of when the transaction was completed. This field will not be present until the transaction is finished. For blockchain transactions, this will match with the timestamp of when the transaction was submitted to the ordering system and it is recorded in the block.

Example: 2024-09-12T00:00:00.000Z

string · date-timeOptional

Date-time string

Example: 2024-09-12T00:00:00.000Z

or

string · dateOptional

Date string

Example: 1980-01-01

or

number · numberOptional

Epoch timestamp (milliseconds)

Example: 1185106460000

orchestrationIdstringOptional

The unique identifier of orchestration flow which this transaction was part of. This will not be made available for transaction records that were submitted by other organizations.

Example: 3f50c1e2-1c4b-4b8b-9a6e-2b5e4e5f6a7b

orchestrationStartDateone ofRequired

The timestamp of when the orchestration started.

Example: 2024-09-12T00:00:00.000Z

string · date-timeOptional

Date-time string

Example: 2024-09-12T00:00:00.000Z

or

string · dateOptional

Date string

Example: 1980-01-01

or

number · numberOptional

Epoch timestamp (milliseconds)

Example: 1185106460000

statusall ofRequired

The status of the transaction.

Example: success

string · enumOptional

The status of the transaction.

Possible values:

typeall ofRequired

The type of transaction. Each type/method combination represents a unique action on the system.

Example: issuance

string · enumOptional

The type of transaction. Each type/method combination represents a unique action on the system.

Possible values:

methodall ofRequired

The method that was invoked in this transaction. Each type/method combination represents a unique action on the system.

Example: createInvestment

string · enumOptional

The method that was invoked in this transaction. Each type/method combination represents a unique action on the system.

Possible values:

orgIdstringRequired

The unique identifier of the organization that "triggered" the execution of this transaction.

Example: OG123

consequentProcessIdsstring[]Optional

The IDs of the processes that are executing the transactions triggered by the original processId e.g. a reference data that on success triggers a create asset transaction. The list is ordered by the sequence of the transactions. This will only be available for the organization that triggered the transaction.

Example: ["74a391ab-3645-4807-9652-7b2a5ecdg55r"]

queuedTimenumberRequired

The amount of time (in milliseconds) that the transaction was queued before it was consumed and started to be processed.This will only be available for the organization that triggered the transaction.

Example: 2000

totalTimenumberRequired

The total amount of time (in milliseconds) that it took for the transaction to be executed (since being registered until its completion). To determine how long the transaction was actually in flight you can subtract the queuedTime from this value. This will only be available for the organization that triggered the transaction.

Example: 2000

createdDateone ofRequired

The timestamp of when the transaction request was created.This will only be available for the organization that triggered the transaction.

Example: 2024-09-12T00:00:00.000Z

string · date-timeOptional

Date-time string

Example: 2024-09-12T00:00:00.000Z

or

string · dateOptional

Date string

Example: 1980-01-01

or

number · numberOptional

Epoch timestamp (milliseconds)

Example: 1185106460000

blockNumbernumberOptional

The block number where the transaction was recorded on the ledger. Will only be available for blockchain transactions.

Example: 350

transactionIdstringOptional

The transaction id where the transaction was recorded on the ledger. Will only be available for blockchain transactions.

Example: 456789OIJHGFCVGHJKLKJHGF67JH

channelNamestringRequired

The name of the channel where the transaction was recorded on the ledger. Will only be available for blockchain transactions.

Example: OG123

errorIdsstring[]Optional

The list of unique identifiers of the errors that were generated by this transaction. Will only be available for failed transactions that generated errors.

Example: ["74a391ab-3645-4807-9652-7b2a5ecdg55r"]

400

The following error codes can be returned: - GN0002 - GN0004 - GN0005 Please refer to the error code dictionary for the details of each error code.

application/json

401

The following error codes can be returned: - AU0001 Please refer to the error code dictionary for the details of each error code.

application/json

403

The following error codes can be returned: - AU0002 Please refer to the error code dictionary for the details of each error code.

application/json

get

/external/v1/transactions

HTTPcURLJavaScriptPython

GET /external/v1/transactions HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "blockchainDetails": {
      "blockNumber": 350,
      "transactionId": "456789OIJHGFCVGHJKLKJHGF67JH",
      "channelName": "og123"
    },
    "details": {
      "securityIds": [
        "USCCWSF01I00"
      ],
      "assetIds": [
        "US9QIMAOAS1Q",
        "US9QIPOTAS1Q"
      ]
    },
    "processId": "3f50c1e2-1c4b-4b8b-9a6e-2b5e4e5f6a7b",
    "syncJobId": "3f50c1e2-1c4b-4b8b-9a6e-2b5e4e5f6a7b",
    "grantedByProcessId": "3f50c1e2-1c4b-4b8b-9a6e-2b5e4e5f6a7b",
    "timestamp": "2024-09-12T00:00:00.000Z",
    "orchestrationId": "3f50c1e2-1c4b-4b8b-9a6e-2b5e4e5f6a7b",
    "orchestrationStartDate": "2024-09-12T00:00:00.000Z",
    "status": "success",
    "type": "issuance",
    "method": "createInvestment",
    "orgId": "OG123",
    "consequentProcessIds": [
      "74a391ab-3645-4807-9652-7b2a5ecdg55r"
    ],
    "queuedTime": 2000,
    "totalTime": 2000,
    "createdDate": "2024-09-12T00:00:00.000Z",
    "blockNumber": 350,
    "transactionId": "456789OIJHGFCVGHJKLKJHGF67JH",
    "channelName": "OG123",
    "errorIds": [
      "74a391ab-3645-4807-9652-7b2a5ecdg55r"
    ]
  }
]