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

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 
-d clientID=someclientid
-d developerAPIKey=somedeveloperkey
-d tradeId=141103099
-d requestedBy=Test
-d reason=Testing  Reason
-d notes=Testing Notes
-d createdIpAddress=

Response Parameters

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!

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