Cancel Distribution File

This method is used to cancel a pending distribution file. If the file has already been submitted then it can no longer be canceled.

Request Method : POST

Request Parameters

Parameter Required Type Description
clientID yes string Transact API Client ID
developerAPIKey yes string Transact API Developer Key
distributionFileReferenceNumber yes string Reference Number that is generated by the API when the 'submitDistributionFile' method is used.
reason yes string Reason for the cancelation request

Sample Request

curl -k -X POST
-d clientID=someclientid
-d developerAPIKey=somedeveloperkey
-d distributionFileReferenceNumber=Reference Number generated from submitDistributionFile
-d reason=test

Response Parameters

Parameter Type Description
statusCode string API Status Code
statusDesc string API Status Description
distributionFileStatus string Updated status

Sample Response

    "statusCode": "101",
    "statusDesc": "Ok",
    "distributionFileStatus": "Status updated to "Cancelled""
Click on the "Test it yourself" button to see how it works
Click on the "Error Codes" button to see list of error codes

Custodial Account