This route is used to retrieve the details of tender requests, given a set of search filters.
This endpoint is paginated, up to 250 records can be retrieved per call.
This endpoint can be called by applications with access to scope "readTenderRequest".
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 statuses to filter the tender request records. Up to 9 entries can be provided. Available values: preSync, active, proposed, matched, pending_settlement, canceled, closed, declined, deleted
active,canceled
The comma delimited list of tender trade ids to filter the tender request records. Up to 250 records can be provided. Each record should not exceed 12 characters.
USCCWSF01I00,USCCWSF01I01
The comma delimited list of tender trade correlation ids to filter the tender request records. Up to 50 records can be provided. Each record should not exceed 100 characters.
1234,5678,7890
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.
The organization identifier linked to the correlation ids provided in the "tradeCorrelationIdsFilter" property. If not provided the organization id will be inferred from the access token.
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.
USCCWSF01I00,USCCWSF01I01
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.
1234,5678,7890
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.
The comma delimited list of tender offer ids to filter the tender requests records. Up to 50 records can be provided. Each record should not exceed 12 characters.
USCCWSF01I00,USCCWSF01I01
The comma delimited list of tender offer correlation ids to filter the tender requests records. Up to 50 records can be provided. Each record should not exceed 100 characters.
1234,5678,7890
GET /external/v1/tender-offers/requests HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"extraData": {
"externalId": "123456789",
"some": "Custom Property"
},
"tradeId": "TEST1234",
"correlationData": [
{
"correlationId": "123245573717",
"origin": "Identifies tender request on backoffice",
"organization": {
"name": "Test Organization",
"orgId": "TEST1234"
},
"extraData": {
"some": "Custom Property"
}
}
],
"securityId": "USS3JKS01I00",
"tenderOfferId": "USS3JKS01I00",
"type": "tender",
"status": "proposed",
"amount": 100000,
"tenderProposal": {
"sharesNumberSubmitted": 500,
"sharesNumberAccepted": 500
},
"price": 10,
"restricted": false,
"postedDate": "2024-09-12T00:00:00.000Z",
"effectiveDate": "2024-09-12T00:00:00.000Z",
"expirationDate": "2024-09-12T00:00:00.000Z",
"sellerAccountId": "US9QIMAOAS1Q",
"buyerAccountId": "US9QIMAOAS1Q",
"outputAssetId": "TEST1234",
"inputAssetIds": [
"TEST1234",
"TEST5678"
],
"organization": {
"orgId": "TEST1234",
"name": "Test Organization"
}
}
]