company

AM/FA - Mark Assets Batch as Settled

Throughout the API flows, an asset represents multiple shares, or a lot, of a given security. Once the funds for multiple transactions have been transferred, you can mark the shares as settled.

Details

/external/v1/primary/batch-mark-settled

Synopsis

Mark Assets batch as Settled

put

This route is used to trigger the process to mark a list of assets of a given security as settled.

This should be called by the issuer or assigned service provider (e.g. fund admin) to aknowledge the receipt of the funds covering the investments that have been wired.

This can be called for all security types except non-unitized security types with capital calls enabled.

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 if the security is in one of the following statuses: ["active","paused"].

This endpoint can be invoked if the assets in the payload are in the following statuses: confirmed,settlement_confirmation_pending.

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

Authorizations
Body
transactionDataall ofRequired

This property contains the transactional data information, i.e. the security id to which all the asset ids in the list belong to

Example: {"securityId":"USS3JKS01I00","signer":{"email":"[email protected]","name":"John Doe"}}
assetIdsstring[] · min: 1 · max: 500Required

The list of the unique identifiers of the digital assets to apply action to.

The entries on this list need to be consistent with the security id in the transaction data

Example: ["USS3JKS01I00","US9QIMAOAS1Q"]
issueDateone ofOptional

The date in which the assets are to be issued.

If not provided, then the assets that will be issued as a result of this action (e.g. money market funds, static price offerings etc...) will have the "issuedDate" set to the current timestamp of this action

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 mark a list of assets as settled. The "processId" and "orchestrationId" properties can be used on the "Transactions API" to monitor the status of this asynchronous process.
application/json
put
PUT /external/v1/primary/batch-mark-settled HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 191

{
  "transactionData": {
    "securityId": "USS3JKS01I00",
    "signer": {
      "email": "[email protected]",
      "name": "John Doe"
    }
  },
  "assetIds": [
    "USS3JKS01I00",
    "US9QIMAOAS1Q"
  ],
  "issueDate": "2024-09-12T00:00:00.000Z"
}
{
  "processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
  "orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf"
}
PreviousAM/FA - Mark Assets Batch as AcceptedNextAM/FA - Decline Asset (Lot)

Last updated

Was this helpful?