Fund Return Request

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

Request Method : POST

Request Parameters

Parameter Required Type Description
clientID yes string Transact API Client ID
developerAPIKey yes string Transact API Developer API 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 
-d clientID=someclientid
-d developerAPIKey=somedeveloperkey
-d tradeId=141103099
-d requestedBy=Test
-d reason=Testing  Reason
-d notes=Testing Notes
-d createdIpAddress=

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"
Click on the "Test it yourself" button to see how it works
Click on the "Error Codes" button to see list of error codes

ACH Distributions