cancelInvestment

This API will perform all of the functions necessary to fully cancel and/or refund an investment.

Request Parameters

ParameterRequiredTypeDescription
clientIDyesstringTransactAPI Client ID
developerAPIKeyyesstringTransactAPI Developer Key
tradeIdyesstringTrade ID generated by the API
requestedByyesstringName of the individual filling out the return request
reasonyesstringReason for the return
notesyesstringAny additional information regarding the return

Sample Request

curl -X POST https://api-sandboxdash.norcapsecurities.com/tapiv3/index.php/v3/cancelInvestment
-d clientID=someclientid
-d developerAPIKey=somedeveloperkey
-d tradeId=141103099
-d requestedBy=Test
-d reason=Testing  Reason
-d notes=Testing Notes
-d createdIpAddress=10.0.0.1

Response Parameters

ParameterTypeDescription
statusCodestringAPI Status Code
statusDescstringAPI Status Description
canceledInvestmentDetailsstringArray of trade details

Sample Response

{
    "statusCode": "101",
    "statusDesc": "Ok",
    "Canceled investment details": [{
        "id": "787594",
        "developerAPIKey": "U4Msub8Kn7tkjUJ3Dv4F7kGOKyC8NAdRIjC",
        "offeringId": "52675",
        "accountId": "A11501",
        "partyId": "P56836",
        "party_type": "",
        "escrowId": null,
        "orderId": "141103099",
        "transactionType": "WIRE",
        "totalAmount": "12000.000000",
        "totalShares": "120.000000",
        "orderStatus": "FUNDED",
        "createdDate": "2017-05-17 06:25:38",
        "createdIpAddress": "",
        "errors": "",
        "documentKey": "",
        "esignStatus": "NOTSIGNED",
        "users": "",
        "archived_status": "0",
        "field1": "Account Field 1",
        "field2": "Account Field 2",
        "field3": "Account Field 3"
    }]
}

Test it Yourself!

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