post deprecatedhttps://api-sandboxdash.norcapsecurities.com/tapiv3/index.php/v3/fundReturnRequest
This method is used to request funds be returned to an investor. The Trade ID is required as a request parameter to process.
This is a legacy API method. If you are integrating with our API, please refer to cancelInvestment.
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 | no | string | Any additional information regarding the return |
| createdIpAddress | no | string | Created IP Address |
Sample Request
curl -X POST https://api-sandboxdash.norcapsecurities.com/tapiv3/index.php/v3/fundReturnRequest
-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 |
| tradeDetails | string | Array of trade details (partyId, offeringId, orderStatus) |
Sample Response
{
"statusCode": "101",
"statusDesc": "Ok",
"tradeDetails": {
"partyId": "P56836",
"offeringId": "52675",
"orderStatus": "FUNDED"
}
}