post https://api-sandboxdash.norcapsecurities.com/tapiv3/index.php/v3/cancelInvestment
This API will perform all of the functions necessary to fully cancel and/or refund an investment.
Request Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| clientID | yes | string | TransactAPI Client ID |
| developerAPIKey | yes | string | TransactAPI Developer Key |
| tradeId | yes | string | Trade ID generated by the API |
| requestedBy | yes | string | Name of the individual filling out the return request |
| reason | yes | string | Reason for the return |
| notes | yes | string | Any 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
| Parameter | Type | Description |
|---|---|---|
| statusCode | string | API Status Code |
| statusDesc | string | API Status Description |
| canceledInvestmentDetails | string | Array 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"
}]
}