Inv - Mark Assets Batch as Wired

Throughout the API flows, an asset represents multiple shares, or a lot, of a given security. The investing organization can mark a batch of securities to indicate funds have been wired.

Details

/external/v1/primary/batch-mark-wired

Synopsis

Mark Assets batch as wired

put

This route is used to trigger the process to mark a list of confirmed assets of a given security as wired. This should be called by the asset owner as the notification of the funds covering the investment being wired. If the security is a money market fund, this should be called by the asset account owner. 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 the following statuses: confirmed. This endpoint can be invoked by organizations that have at least one of the following roles on this security: ["issuer","investor"]. This endpoint can't be invoked if the security is restricted. This endpoint can be called by applications with access to scope "markSubscriptionWired".

Required scopes

This endpoint requires the following scopes:

• : markSubscriptionWired

Authorizations

oauth2

OAuth2clientCredentialsRequired

Token URL:

Body

application/json

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"}}

Responses

200

Successfully triggered the process to mark a list of assets as wired.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 - IS0008 - IS0106 - AS0018 - AS0013 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 - AS0023 - 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 - IS0117 - AS0004 - AS0024 Please refer to the error code dictionary for the details of each error code.

application/json

put

/external/v1/primary/batch-mark-wired

HTTPcURLJavaScriptPython

PUT /external/v1/primary/batch-mark-wired HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 471

{
  "transactionData": {
    "securityId": "USS3JKS01I00",
    "signer": {
      "email": "[email protected]",
      "name": "John Doe"
    }
  },
  "assetsActionData": [
    {
      "assetIdentifier": {
        "assetId": "USS3JKS01I00"
      },
      "correlationData": [
        {
          "broadcastToCounterparty": true,
          "correlationId": "123245573717",
          "origin": "Identifies asset on backoffice",
          "extraData": {
            "some": "Custom Property"
          }
        }
      ]
    },
    {
      "assetIdentifier": {
        "assetId": "USS3JKS01I10"
      }
    },
    {
      "assetIdentifier": {
        "correlationIdentifier": {
          "correlationId": "123456789987654"
        }
      }
    }
  ]
}

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