When a method triggers an asynchronous set of transactions, the next transaction is triggered when the prior one finishes successfully. If one transaction that is being orchestrated fails, then all the subsequent ones that should be triggered afterwards are automatically marked as failed.
Any action that triggers transactions returns the orchestrationId, which identifies and tracks these sequential transactions. Individual transactions are identified by the processId. Use these IDs with the Transactions API to track the status of these transactions.
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".
The number of rows being retrieved. Must be a positive integer.
The offset (i.e. row start index). Must be a positive integer (or 0).
The block number where the action was recorded on the ledger.
350The transaction id where the action was recorded on the ledger.
456789OIJHGFCVGHJKLKJHGF67JHPattern: ^[a-zA-Z0-9-]*$The name of the channel where the action was recorded on the ledger.
OG123Pattern: ^[a-zA-Z0-9-]*$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
queued,successThe 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.
bbb562cc-636a-48c0-9d77-ba1f1b15da07,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.
USCCW,IOICMThe 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.
bbb562cc-636a-48c0-9d77-ba1f1b15da07,2159457f-0167-4e93-a969-9cf0db05e0bfGET /external/v1/transactions HTTP/1.1
Host:
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",
"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"
]
}
]This route is used to retrieve the details of orchestrations, 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".
The number of rows being retrieved. Must be a positive integer.
The offset (i.e. row start index). Must be a positive integer (or 0).
The comma delimited list of orchestration ids to filter the orchestration records. Up to 50 records can be provided. Each record should be a UUID v4 value.
bbb562cc-636a-48c0-9d77-ba1f1b15da07,2159457f-0167-4e93-a969-9cf0db05e0bfThe comma delimited list of statuses to filter the orchestration records. Up to 5 entries can be provided. Available values: queued, in_progress, success, failed, dlq
queued,successThe comma delimited list of source db transaction ids to filter the orchestration records. Up to 50 records can be provided. Each record should be a UUID v4 value.
bbb562cc-636a-48c0-9d77-ba1f1b15da07,2159457f-0167-4e93-a969-9cf0db05e0bfGET /external/v1/transactions/orchestrations HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"orchestrationId": "3f50c1e2-1c4b-4b8b-9a6e-2b5e4e5f6a7b",
"startDate": "2024-09-12T00:00:00.000Z",
"status": "success",
"timestamp": "2024-09-12T00:00:00.000Z",
"processIds": [
"12340c1e2-1c4b-4b8b-9a6e-2b5e4e5f5678",
"abcdc1e2-1c4b-4b8b-9a6e-2b5e4e5fmnbv"
],
"sourceTransactionId": "12340c1e2-1c4b-4b8b-9a6e-2b5e4e5f5678",
"currentStep": 1,
"createdDate": "2024-09-12T00:00:00.000Z"
}
]