All pages
Powered by GitBook
1 of 1

Loading...

AM/FA - Extend End Date

Details

/external/v1/security-admin/extend-end-date

Synopsis

Important Notes

  • See Blockchain Transaction Tracking for information on using orchestrationId and processId.

Extend End Date

put

This route is used to update the end date of an offering.

It triggers an asynchronous process that will persist this information on the blockchain, which can be monitored using the "Transactions API" endpoints.

This endpoint can be invoked by organizations that have at least one of the following roles on this security: ["issuer","service_provider"].

This endpoint can't be invoked if the security is restricted.

This endpoint can be called by applications with access to scope "extendOfferingEndDate".

Authorizations
Body
transactionDataall ofRequired

This property contains the transactional data information, i.e. which is the security where the end date is being extended

Example: {"securityId":"USS3JKS01I00","signer":{"email":"[email protected]","name":"John Doe"}}
endDateone ofRequired

The new date. Must be after end date.

Example: 2024-09-12T00:00:00.000Z
string · date-timeOptional

Date-time string

Example: 2024-09-12T00:00:00.000Z
or
string · dateOptional

Date string

Example: 1980-01-01
or
number · numberOptional

Epoch timestamp (milliseconds)

Example: 1185106460000
Responses
200
Successfully triggered the process to update the end date. The "processId" and "orchestrationId" properties can be used on the "Transactions API" to monitor the status of this asynchronous process.
application/json
400
The following error codes can be returned: - GN0002 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 - AU0003 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 - IS0099 Please refer to the error code dictionary for the details of each error code.
application/json
404
The following error codes can be returned: - IS0009 Please refer to the error code dictionary for the details of each error code.
application/json
409
The following error codes can be returned: - IS0013 - IS0012 - IS0002 - IS0010 - IS0032 - IS0065 - IS0066 Please refer to the error code dictionary for the details of each error code.
application/json
put
PUT /external/v1/security-admin/extend-end-date HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 146

{
  "transactionData": {
    "securityId": "USS3JKS01I00",
    "signer": {
      "email": "[email protected]",
      "name": "John Doe"
    }
  },
  "endDate": "2024-09-12T00:00:00.000Z"
}
{
  "processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
  "orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf"
}