/external/v1/transfer/{transferId}/allocate-assets
See Blockchain Transaction Tracking for information on using orchestrationId and processId.
This route is used to trigger request by sender investor organization to allocate assets.
Investor that owns assets can execute this action, then once this call is completed the transfer will be marked as approved by sender on the ledger.
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: ["investor"].
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_issuer"].
This endpoint can't be invoked if the security is restricted.
This endpoint can be called by applications with access to scope "manageTransfer"
The id that uniquely identifies the transfer on the ledger.
TEST0000
This property contains the transactional data information, i.e. which is the security where the remediation request was created
{"securityId":"USS3JKS01I00","signer":{"email":"[email protected]","name":"John Doe"}}
PUT /external/v1/transfer/{transferId}/allocate-assets HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 214
{
"transactionData": {
"securityId": "USS3JKS01I00",
"signer": {
"email": "[email protected]",
"name": "John Doe"
}
},
"input": [
{
"assetId": "TEST1234",
"sharesNumber": 50.1234
},
{
"assetId": "TEST5678",
"sharesNumber": 200.987566
}
]
}
{
"processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
"orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
"transferId": "US9QIMAOAS1Q",
"fileIds": [
"US9QIFILE1",
"US9QIFILE2"
],
"referenceData": {
"account": {
"accountId": "US9QIMAOAS1Q",
"custodian": {
"custodianId": "US9ZIMAOAS1Q"
}
},
"investors": [
{
"investorId": "US9QIM123S1Q"
}
]
}
}