/external/v1/transfer/{transferId}/cancel
See Blockchain Transaction Tracking for information on using orchestrationId and processId.
This route is used to trigger the cancellation of the transfer by any party involved in the current transfer flow.
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: ["issuer","service_provider","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: ["created","remediation_pending","remediated","approved_by_issuer","approved_by_sender","assets_remediation_pending","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".
The id that uniquely identifies the transfer on the ledger.
TEST0000This 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"}}This property contains the reason for the rejection.
{"reason":[{"message":"reject reason","category":"EC006","documentWithIssues":[{"document":{"fileId":"FILE3JUS03I04"},"pages":[{"pageNumber":1,"description":"The first page has an invalid signature"}]}]}],"extraData":{"externalId":"123456789","some":"Custom Property"}}PUT /external/v1/transfer/{transferId}/cancel HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 394
{
"transactionData": {
"securityId": "USS3JKS01I00",
"signer": {
"email": "[email protected]",
"name": "John Doe"
}
},
"rejectReason": {
"reason": [
{
"message": "reject reason",
"category": "EC006",
"documentWithIssues": [
{
"document": {
"fileId": "FILE3JUS03I04"
},
"pages": [
{
"pageNumber": 1,
"description": "The first page has an invalid signature"
}
]
}
]
}
],
"extraData": {
"externalId": "123456789",
"some": "Custom Property"
}
}
}{
"processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
"orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf"
}