This method is used to delete (status is changed to "Canceled") a particular Trade from Transact API. The delete is a virtual delete. You will need to specify the Trade ID as a request parameter to cancel the trade. If there is a pending ACH transfer relating to the trade, the trade will not be canceled.

Request Parameters

clientIDyesstringTransactAPI Client ID
developerAPIKeyyesstringTransactAPI Developer Key
accountIdyesstringAccount ID generated by the TAPI
tradeIdyesintegerTrade ID generated by the TAPI
errDescnostringIf any error caused

Sample Request

curl -k -X POST
-d developerAPIKey=somedeveloperkey
-d clientID=someclientid
-d accountId=A77654
-d tradeId=2354
-d errDesc=test

Response Parameters

statusCodestringAPI Status Code
statusDescstringAPI Status Description
tradeDetailsstringArray of trade details (partyId, offeringId, orderStatus)

Sample Response

    "statusCode": "101",
    "statusDesc": "Ok",
    "tradeDetails": [
            "partyId": "P00197",
            "offeringId": "32957",
            "orderStatus": "CANCELED"

Test it Yourself!

Click Try It! to start a request and see the response here!