fundReturnRequest

This method is used to request funds be returned to an investor. The Trade ID is required as a request parameter to process.

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
notesnostringAny additional information regarding the return
createdIpAddressnostringCreated 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

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

Sample Response

{
    "statusCode": "101",
    "statusDesc": "Ok",
    "tradeDetails": {
        "partyId": "P56836",
        "offeringId": "52675",
        "orderStatus": "FUNDED"
    }
}

Test it Yourself!

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