AM/TA/Inv - Get Issuance Close Details

Details

/external/v1/issuance-close

Synopsis

Get Issuance Close Details

get

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

Required scopes

This endpoint requires the following scopes:

• : readIssuanceClose

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).

closeStatusFilterstringOptional

The comma delimited list of statuses to filter the close records. Up to 3 entries can be provided.Available values: preSync, deleted, created

Example: created,deleted

fromDatestring · date-timeOptional

The start date from which the closes are to be retrieved.

toDatestring · date-timeOptional

The end date until which the closes are to be retrieved.

securityIdsFilterstringOptional

The comma delimited list of security ids to filter the close records. Up to 10 records can be provided. Each record should not exceed 12 characters.

Example: USCCWSF01I00,USCCWSF01I01

securityCorrelationIdsFilterstringOptional

The comma delimited list of security correlation ids to filter the close records. Up to 10 records can be provided. Each record should not exceed 100 characters.

Example: 1234,5678,7890

closeIdsFilterstringOptional

The comma delimited list of security ids to filter the close records. Up to 500 records can be provided. Each record should not exceed 12 characters.

Example: USCCWSF01I00,USCCWSF01I01

closeCorrelationIdsFilterstringOptional

The comma delimited list of close correlation ids to filter the close records. Up to 50 records can be provided. Each record should not exceed 100 characters.

Example: 1234,5678,7890

securityCorrelationOrgIdstring · max: 12Optional

The organization identifier linked to the correlation ids provided in the "securityCorrelationIdsFilter" property. If not provided the organization id will be inferred from the access token.

closeCorrelationOrgIdstring · max: 12Optional

The organization identifier linked to the correlation ids provided in the "closeCorrelationIdsFilter" property. If not provided the organization id will be inferred from the access token.

Responses

200

Successfully retrieved the Issuance Close details

application/json

closeIdstring · max: 12Required

The unique identifier of the close on the ledger.

Example: US9QIMAOAS1Q

securityIdstring · max: 12Required

The unique identifier of the security for which the close is referent to on the ledger.

Example: US9QIMAOAS1Q

statusall ofRequired

The status of the close

Example: created

string · enumOptional

The status of the close

Possible values:

issueDatestring · date-timeOptional

The date in which the assets are to be issued.

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

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/issuance-close

HTTPcURLJavaScriptPython

GET /external/v1/issuance-close HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "closeId": "US9QIMAOAS1Q",
  "correlationData": [
    {
      "correlationId": "123245573717",
      "origin": "Identifies a \"close\" on backoffice",
      "organization": {
        "name": "Test Organization",
        "orgId": "TEST1234"
      },
      "extraData": {
        "some": "Custom Property"
      }
    }
  ],
  "securityId": "US9QIMAOAS1Q",
  "status": "created",
  "issueDate": "2024-09-12T00:00:00.000Z",
  "priceData": [
    {
      "price": 10.23,
      "asOfDate": "2024-09-12T00:00:00.000Z",
      "bypassNAVCheck": true
    }
  ],
  "organization": {
    "orgId": "TEST1234",
    "name": "Test Organization"
  }
}