AM/FA/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".

Authorizations

oauth2

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

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

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

HTTPcURLJavaScriptPython

GET /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"
    ]
  }
]