AM/FA/Inv - Cancel Transfer

Details

/external/v1/transfer/{transferId}/cancel

Synopsis

Cancel Transfer

put

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

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

transactionDataall ofRequired

This property contains the transactional data information, i.e. which is the security where the remediation request was created

Example: {"securityId":"USS3JKS01I00","signer":{"email":"[email protected]","name":"John Doe"}}

rejectReasonall ofOptional

This property contains the reason for the rejection.

Example: {"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"}}

Responses

200

Successfully triggered the cancellation of the transfer

application/json

400

The following error codes can be returned: - GN0002 - IS0008 - IS0106 - TR0002 - TR0043 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 - AS0030 Please refer to the error code dictionary for the details of each error code.

application/json

put

/external/v1/transfer/{transferId}/cancel

HTTPcURLJavaScriptPython

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

Important Notes

• See Blockchain Transaction Tracking for information on using orchestrationId and processId.