AM/TA - Complete Transfer

Details

/external/v1/transfer/{transferId}/complete

Synopsis

Complete Transfer

put

This is the last step of the transaction flow where the assets will be created for the recipient organization and the corresponding amount / shares number will be disposed on the sender organization. It is not reversible. 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","completed","approved_revert_to_active","closed"]. This endpoint can be invoked if the transfer is in one of the following statuses: ["approved_by_sender","assets_remediated"]. This endpoint can't be invoked if the security is restricted. This endpoint can be called by applications with access to scope "manageTransfer".

Required scopes

This endpoint requires the following scopes:

• : manageTransfer

Authorizations

oauth2

OAuth2clientCredentialsRequired

Token URL:

Path parameters

transferIdanyRequired

The id that uniquely identifies the transfer on the ledger.

Example: TEST0000

Body

application/json

Responses

200

Successfully triggered the completion of the transfer

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 - IS0008 - IS0106 - TR0002 - TR0033 - TR0034 - TR0025 - TR0024 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 - TR0001 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 - IS0063 - IS0013 - IS0002 - IS0012 - TR0003 - TR0004 - TR0026 - TR0027 - TR0028 - AS0030 Please refer to the error code dictionary for the details of each error code.

application/json

put

/external/v1/transfer/{transferId}/complete

HTTPcURLJavaScriptPython

PUT /external/v1/transfer/{transferId}/complete HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 358

{
  "transactionData": {
    "securityId": "USS3JKS01I00",
    "effectiveDate": "2024-09-12T00:00:00.000Z",
    "signer": {
      "email": "[email protected]",
      "name": "John Doe"
    }
  },
  "input": [
    {
      "assetId": "TEST1234",
      "stepUp": 20,
      "costBasis": 20000,
      "acquisitionDate": "2024-09-12T00:00:00.000Z"
    },
    {
      "assetId": "TEST5678",
      "stepUp": 20,
      "costBasis": 10000,
      "acquisitionDate": "2024-09-12T00:00:00.000Z"
    }
  ]
}

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