All pages
Powered by GitBook
1 of 1

Loading...

AM/FA - Get Tender Offer Details

Details

/external/v1/tender-offers

Synopsis

Get Tender Offer Details

get

This route is used to retrieve the details of tender offers, 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 "readTenderOffer".

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

tenderOfferStatusFilterstringOptional

The comma delimited list of statuses to filter the tender offer records. Up to 14 entries can be provided. Available values: preSync, deleted, draft, pending, active, canceled, closing, closed, price_set, price_pending, price_approved, price_completed, settling, settled

Example: active
securityIdsFilterstringOptional

The comma delimited list of security ids to filter the tender offer 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 tender offer records. Up to 10 records can be provided. Each record should not exceed 100 characters.

Example: 1234,5678,7890
tenderOfferIdsFilterstringOptional

The comma delimited list of tender offer ids to filter the tender offer records. Up to 50 records can be provided. Each record should not exceed 12 characters.

Example: USCCWSF01I00,USCCWSF01I01
tenderOfferCorrelationIdsFilterstringOptional

The comma delimited list of tender offer correlation ids to filter the tender offer 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.

tenderOfferCorrelationOrgIdstring · max: 12Optional

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

Responses
200
Successfully retrieved the tender offer data
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
GET /external/v1/tender-offers HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
  {
    "extraData": {
      "externalId": "123456789",
      "some": "Custom Property"
    },
    "tenderOfferId": "TEST1234",
    "startDate": "2024-09-12T00:00:00.000Z",
    "cutOffDate": "2024-09-12T00:00:00.000Z",
    "closeDate": "2024-09-12T00:00:00.000Z",
    "settlementDate": "2024-09-12T00:00:00.000Z",
    "status": "draft",
    "totalSharesNumberAccepted": 100000,
    "totalSharesNumberSubmitted": 100000,
    "priceClosed": 10,
    "restricted": false,
    "ratio": 1,
    "shareClassesData": [
      {
        "securityId": "USS3JKS01I0A",
        "totalSharesNumberSubmitted": 10,
        "totalSharesNumberAccepted": 10,
        "priceClosed": 20
      }
    ],
    "accountId": "US9QIMAOAS1Q",
    "securityId": "USS3JKS01I00",
    "correlationData": [
      {
        "correlationId": "123245573717",
        "origin": "Identifies tender offer on backoffice",
        "organization": {
          "name": "Test Organization",
          "orgId": "TEST1234"
        },
        "extraData": {
          "some": "Custom Property"
        }
      }
    ],
    "organization": {
      "orgId": "TEST1234",
      "name": "Test Organization"
    }
  }
]