company

AM - Cancel Asset (Lot)

Throughout the API flows, an asset represents multiple shares, or a lot, of a given security. The asset manager can cancel the asset after receiving funds if the investor needs to back out.

Details

/external/v1/primary/asset/{assetId}/cancel

Synopsis

Cancel Digital Asset

put

This route is used to trigger the cancellation of a digital asset on the blockchain for a particular security.

This should be called when for some reason the investor needs to stop participating in the security, after the asset has been accepted and the payment is already processed. This means that the money will need to be refunded after this action using the "dispose" action endpoint.

This triggers an asynchronous process (the id of which is returned on the success response) to persist this information on the blockchain which can be monitored using the "Transactions API" endpoints.

Once processed, the asset will move to next stage of the lifecycle

This endpoint can be invoked if the security is in one of the following statuses: ["active","paused"].

This endpoint can be invoked if the asset is in one of the following statuses: ["confirmed","settled"].

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 "cancelSubscription".

Authorizations
Path parameters
assetIdanyRequired

The unique identifier of the asset on the blockchain.

This can be a 12 characters platform generated identifier or a correlation id provided by the client. If its length is different from 12 it will be treatead as a correlation id.

Particularly relevant for correlation ids, it is recommended that the ID is url encoded if it contains any special characters.

Example: US9QIMAOAS1Q
Query parameters
isAssetCorrelationIdanyOptional

This property is to be used if the value passed in the "assetId" path parameter is a correlation id instead of a platform generated id.

If set to "true" then the platform will try to obtain the asset data using the path parameter as a correlation id instead of a platform generated id.

Example: true
assetCorrelationOrgIdanyOptional

This is to be used if the value passed in the "assetId" path parameter is a correlation id instead of a platform generated id.

This is the organization identifier linked to that path param. If not provided the organization id will be inferred from the access token.

This will be ignored if the value in the path parameter is 12 characters long and the isAssetCorrelationId is either absent or not "true".

Example: US9QI
Body
transactionDataall ofRequired

This property contains the transactional data information, i.e. which is the security being bought and the investment details

Example: {"securityId":"USS3JKS01I00","signer":{"email":"[email protected]","name":"John Doe"}}
Responses
200
Successfully triggered the process to cancel the asset on the ledger. The "processId" and "orchestrationId" properties can be used on the "Transactions API" to monitor the status of this asynchronous process. The "assetId" property can be used on the "Assets API" to get the details of the digital asset.
application/json
put
PUT /external/v1/primary/asset/{assetId}/cancel HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 109

{
  "transactionData": {
    "securityId": "USS3JKS01I00",
    "signer": {
      "email": "[email protected]",
      "name": "John Doe"
    }
  }
}
{
  "processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
  "orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
  "assetId": "US9QIMAOAS1Q"
}

Important Notes

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

  • The dryRun option is included in the response, but is not yet used for this method.

PreviousAM/FA - Decline Asset (Lot)NextAM - Dispose Asset (Lot)

Last updated

Was this helpful?