AM/TA - Update Max Amount

Details

/external/v1/security-admin/update-max-amount

Synopsis

Update offering maximum amount to be raised

put

This route is used to update the maximum amount to be raised. 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 be invoked if the security is in one of the following statuses: ["active"]. This endpoint can only be invoked for non-contingent or continuous offerings. This endpoint can't be invoked if the security is restricted. This endpoint can be called by applications with access to scope "updateOfferingMaxAmount".

Required scopes

This endpoint requires the following scopes:

• : updateOfferingMaxAmount

Authorizations

oauth2

OAuth2clientCredentialsRequired

Token URL:

Body

application/json

maxAmountnumber · max: 999999999999999Required

Maximum amount to be sold. The unit is the issuance's currency. This parameter should not be lower than the total amount already raised. Up to 2 fractional digits may be provided.

Example: 2500000

Responses

200

Successfully triggered the process to update the maximum amount to be raised.The "processId" and "orchestrationId" properties can be used on the "Transactions API" to monitor the status of this asynchronous process.

application/json

processIdstringRequired

This is used to uniquely identity a transaction process on this system.

Example: 2159457f-0167-4e93-a969-9cf0db05e0bf

orchestrationIdstringRequired

The orchestration id. It is used to uniquely identity a group of transactions that are being orchestrated following an action request.If a processId was passed as an input to the action, it will be returned on this property.

Example: 2159457f-0167-4e93-a969-9cf0db05e0bf

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: - IS0119 - IS0013 - IS0012 - IS0002 - IS0010 - IS0066 - IS0069 - IS0070 - IS0117 Please refer to the error code dictionary for the details of each error code.

application/json

put

/external/v1/security-admin/update-max-amount

HTTPcURLJavaScriptPython

PUT /external/v1/security-admin/update-max-amount HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 129

{
  "transactionData": {
    "securityId": "USS3JKS01I00",
    "signer": {
      "email": "[email protected]",
      "name": "John Doe"
    }
  },
  "maxAmount": 2500000
}

{
  "processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
  "orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf"
}